org.apache.flink.runtime.io.network.api.serialization

Interface RecordSerializer<T extends org.apache.flink.core.io.IOReadableWritable>

All Known Implementing Classes:

SpanningRecordSerializer

public interface RecordSerializer<T extends org.apache.flink.core.io.IOReadableWritable>

Interface for turning records into sequences of memory segments.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	RecordSerializer.SerializationResult Status of the serialization result.

Method Summary

Modifier and Type	Method and Description
RecordSerializer.SerializationResult	copyToBufferBuilder(BufferBuilder bufferBuilder) Copies the intermediate data serialization buffer to the given target buffer.
boolean	hasSerializedData()
void	prune() Clears the buffer and checks to decrease the size of intermediate data serialization buffer after finishing the whole serialization process including serializeRecord(IOReadableWritable) and copyToBufferBuilder(BufferBuilder).
void	reset() Supports copying an intermediate data serialization buffer to multiple target buffers by resetting its initial position before each copying.
void	serializeRecord(T record) Starts serializing the given record to an intermediate data buffer.

Method Detail

serializeRecord

void serializeRecord(T record)
              throws IOException

Starts serializing the given record to an intermediate data buffer.

Parameters:

record - the record to serialize

Throws:

IOException

copyToBufferBuilder

RecordSerializer.SerializationResult copyToBufferBuilder(BufferBuilder bufferBuilder)

Copies the intermediate data serialization buffer to the given target buffer.

Parameters:

bufferBuilder - the new target buffer to use

Returns:

how much information was written to the target buffer and whether this buffer is full

prune

void prune()

Clears the buffer and checks to decrease the size of intermediate data serialization buffer after finishing the whole serialization process including serializeRecord(IOReadableWritable) and copyToBufferBuilder(BufferBuilder).

reset

void reset()

Supports copying an intermediate data serialization buffer to multiple target buffers by resetting its initial position before each copying.

hasSerializedData

boolean hasSerializedData()

Returns:

true if has some serialized data pending copying to the result BufferBuilder.