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

Class BaseSerializer

java.lang.Object

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

All Implemented Interfaces:

MessageSerializer

Direct Known Subclasses:

DataSerializer, KeyedDataSerializer

public abstract class BaseSerializer
extends java.lang.Object
implements MessageSerializer

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	MAX_SUB_MESSAGE_HEADER_SPACE
protected static int	NORMAL_SUB_MESSAGE_HEADER_SIZE
protected java.util.Queue<DataBuffer>	sendBuffers The DataBuffers available
protected KryoSerializer	serializer The kryo serializer to be used for objects

Constructor Summary

Constructors

Constructor and Description
BaseSerializer()

Method Summary

Modifier and Type	Method and Description
ChannelMessage	build(java.lang.Object data, java.lang.Object partialBuildObject) This method will be called repeatedly until the message is fully built
void	init(Config cfg, java.util.Queue<DataBuffer> buffers) Initialize the serializer, it should use the sendBuffs queue to pick a network buffer
abstract boolean	serializeSingleMessage(java.lang.Object payload, OutMessage sendMessage, DataBuffer targetBuffer) Builds the body of the message.

Methods inherited from class java.lang.Object

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

Field Detail

MAX_SUB_MESSAGE_HEADER_SPACE

protected static final int MAX_SUB_MESSAGE_HEADER_SPACE

See Also:

Constant Field Values

NORMAL_SUB_MESSAGE_HEADER_SIZE

protected static final int NORMAL_SUB_MESSAGE_HEADER_SIZE

See Also:

Constant Field Values

sendBuffers

protected java.util.Queue<DataBuffer> sendBuffers

The DataBuffers available

serializer

protected KryoSerializer serializer

The kryo serializer to be used for objects

Constructor Detail

BaseSerializer

public BaseSerializer()

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

Parameters:

cfg - configuration

buffers - the send buffer qeue

build

public ChannelMessage build(java.lang.Object data,
                            java.lang.Object partialBuildObject)

Description copied from interface: MessageSerializer

This method will be called repeatedly until the message is fully built

Specified by:

build in interface MessageSerializer

Parameters:

data - message to serialize

partialBuildObject - the out message to serialize

Returns:

a channel message

serializeSingleMessage

public abstract 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

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.