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

Class DataSerializer

java.lang.Object

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

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

All Implemented Interfaces:

MessageSerializer

Direct Known Subclasses:

FixedSchemaDataSerializer

public class DataSerializer
extends BaseSerializer

Builds the message and copies it into data buffers.The structure of the message depends on the type of message that is sent, for example if it is a keyed message or not.

The main structure of the built message is |Header|Body|.

The header has the following structure |source|flags|destinationID|numberOfMessages|, source - source of the message flags - message flags destinationId - where the message is sent numberOfMessages - number of messages

Header can be followed by 0 or more messages, each message will have the following structure |length(integer)|message body|

For a keyed message the message body consists of two parts |key|body|

For some keys we need to send the length of the key, i.e. byte arrays and objects. In that case key consists of two parts |key length(integer)|actual key|

For other cases such as integer or double keys, we know the length of the key, so we only send the key.

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
DataSerializer()

Method Summary

Modifier and Type	Method and Description
protected boolean	serializeData(java.lang.Object payload, SerializeState state, DataBuffer targetBuffer, DataPacker dataPacker) Helper method that builds the body of the message for regular 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, init

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSerializer

public DataSerializer()

Method Detail

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.

serializeData

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

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

Parameters:

payload - the message that needs to be built

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.