edu.iu.dsc.tws.comms.dfw.io

Class KeyedDataSerializer

java.lang.Object

edu.iu.dsc.tws.comms.dfw.io.BaseSerializer

edu.iu.dsc.tws.comms.dfw.io.KeyedDataSerializer

All Implemented Interfaces:

MessageSerializer

Direct Known Subclasses:

FixedSchemaKeyedDataSerializer

public class KeyedDataSerializer
extends BaseSerializer

This serializer will be used to serialize messages with keys

Field Summary

Fields inherited from class edu.iu.dsc.tws.comms.dfw.io.BaseSerializer

MAX_SUB_MESSAGE_HEADER_SPACE, NORMAL_SUB_MESSAGE_HEADER_SIZE, sendBuffers, serializer

Constructor Summary

Constructors

Constructor and Description
KeyedDataSerializer()

Method Summary

Modifier and Type	Method and Description
void	init(Config cfg, java.util.Queue<DataBuffer> buffers) Initialize the serializer, it should use the sendBuffs queue to pick a network buffer
protected boolean	serializeKeyedData(java.lang.Object payload, java.lang.Object key, DataPacker dataPacker, DataPacker keyPacker, SerializeState state, DataBuffer targetBuffer) Helper method that builds the body of the message for keyed messages.
boolean	serializeSingleMessage(java.lang.Object payload, OutMessage sendMessage, DataBuffer targetBuffer) Builds the body of the message.

Methods inherited from class edu.iu.dsc.tws.comms.dfw.io.BaseSerializer

build

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeyedDataSerializer

public KeyedDataSerializer()

Method Detail

init

public void init(Config cfg,
                 java.util.Queue<DataBuffer> buffers)

Description copied from interface: MessageSerializer

Initialize the serializer, it should use the sendBuffs queue to pick a network buffer

Specified by:

init in interface MessageSerializer

Overrides:

init in class BaseSerializer

Parameters:

cfg - configuration

buffers - the send buffer qeue

serializeSingleMessage

public boolean serializeSingleMessage(java.lang.Object payload,
                                      OutMessage sendMessage,
                                      DataBuffer targetBuffer)

Builds the body of the message. Based on the message type different build methods are called

Specified by:

serializeSingleMessage in class BaseSerializer

Parameters:

payload - the message that needs to be built

sendMessage - the send message object that contains all the metadata

targetBuffer - the data targetBuffer to which the built message needs to be copied

Returns:

true if the body was built and copied to the targetBuffer successfully,false otherwise.

serializeKeyedData

protected boolean serializeKeyedData(java.lang.Object payload,
                                     java.lang.Object key,
                                     DataPacker dataPacker,
                                     DataPacker keyPacker,
                                     SerializeState state,
                                     DataBuffer targetBuffer)

Helper method that builds the body of the message for keyed messages.

Parameters:

payload - the message that needs to be built

key - the key associated with the message

state - the state object of the message

targetBuffer - the data targetBuffer to which the built message needs to be copied

Returns:

true if the body was built and copied to the targetBuffer successfully,false otherwise.