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	addRecord(T record) Starts serializing and copying the given record to the target buffer (if available).
void	clear() Clear and release internal state.
RecordSerializer.SerializationResult	continueWritingWithNextBufferBuilder(BufferBuilder bufferBuilder) Sets a (next) target buffer to use and continues writing remaining data to it until it is full.
boolean	hasSerializedData()

Method Detail

addRecord

RecordSerializer.SerializationResult addRecord(T record)
                                        throws IOException

Starts serializing and copying the given record to the target buffer (if available).

Parameters:

record - the record to serialize

Returns:

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

Throws:

IOException

continueWritingWithNextBufferBuilder

RecordSerializer.SerializationResult continueWritingWithNextBufferBuilder(BufferBuilder bufferBuilder)
                                                                   throws IOException

Sets a (next) target buffer to use and continues writing remaining data to it until it is full.

Parameters:

bufferBuilder - the new target buffer to use

Returns:

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

Throws:

IOException

clear

void clear()

Clear and release internal state.

hasSerializedData

boolean hasSerializedData()

Returns:

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