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

Interface RecordSerializer<T extends IOReadableWritable>

All Known Implementing Classes:

SpanningRecordSerializer

public interface RecordSerializer<T extends 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

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() Resets the target buffer to null and resets internal state set up for the record to serialize.
void	clearCurrentBuffer() Resets the target buffer to null.
Buffer	getCurrentBuffer() Retrieves the current target buffer and sets its size to the actual number of written bytes.
boolean	hasData() Determines whether data is left, either in the current target buffer or in any internal state set up for the record to serialize.
void	instantiateMetrics(TaskIOMetricGroup metrics) Instantiates all metrics.
RecordSerializer.SerializationResult	setNextBuffer(Buffer buffer) Sets a (next) target buffer to use and continues writing remaining data to it until it is full.

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

setNextBuffer

RecordSerializer.SerializationResult setNextBuffer(Buffer buffer)
                                            throws IOException

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

Parameters:

buffer - the new target buffer to use

Returns:

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

Throws:

IOException

getCurrentBuffer

Buffer getCurrentBuffer()

Retrieves the current target buffer and sets its size to the actual number of written bytes. After calling this method, a new target buffer is required to continue writing (see setNextBuffer(Buffer)).

Returns:

the target buffer that was used

clearCurrentBuffer

void clearCurrentBuffer()

Resets the target buffer to null.

NOTE: After calling this method, a new target buffer is required to continue writing (see setNextBuffer(Buffer)).

clear

void clear()

Resets the target buffer to null and resets internal state set up for the record to serialize.

NOTE: After calling this method, a new record and a new target buffer is required to start writing again (see setNextBuffer(Buffer)). If you want to continue with the current record, use clearCurrentBuffer() instead.

hasData

boolean hasData()

Determines whether data is left, either in the current target buffer or in any internal state set up for the record to serialize.

Returns:

true if some data is present

instantiateMetrics

void instantiateMetrics(TaskIOMetricGroup metrics)

Instantiates all metrics.

Parameters:

metrics - metric group