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

Class SpanningRecordSerializer<T extends IOReadableWritable>

java.lang.Object

org.apache.flink.runtime.io.network.api.serialization.SpanningRecordSerializer<T>

Type Parameters:

T -

All Implemented Interfaces:

RecordSerializer<T>

public class SpanningRecordSerializer<T extends IOReadableWritable>
extends Object
implements RecordSerializer<T>

Record serializer which serializes the complete record to an intermediate data serialization buffer and copies this buffer to target buffers one-by-one using setNextBuffer(Buffer).

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.runtime.io.network.api.serialization.RecordSerializer

RecordSerializer.SerializationResult

Constructor Summary

Constructors

Constructor and Description
SpanningRecordSerializer()

Method Summary

Methods

Modifier and Type	Method and Description
RecordSerializer.SerializationResult	addRecord(T record) Serializes the complete record to an intermediate data serialization buffer and starts copying it 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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpanningRecordSerializer

public SpanningRecordSerializer()

Method Detail

addRecord

public RecordSerializer.SerializationResult addRecord(T record)
                                               throws IOException

Serializes the complete record to an intermediate data serialization buffer and starts copying it to the target buffer (if available).

Specified by:

addRecord in interface RecordSerializer<T extends IOReadableWritable>

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

public RecordSerializer.SerializationResult setNextBuffer(Buffer buffer)
                                                   throws IOException

Description copied from interface: RecordSerializer

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

Specified by:

setNextBuffer in interface RecordSerializer<T extends IOReadableWritable>

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

public Buffer getCurrentBuffer()

Description copied from interface: RecordSerializer

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 RecordSerializer.setNextBuffer(Buffer)).

Specified by:

getCurrentBuffer in interface RecordSerializer<T extends IOReadableWritable>

Returns:

the target buffer that was used

clearCurrentBuffer

public void clearCurrentBuffer()

Description copied from interface: RecordSerializer

Resets the target buffer to null.

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

Specified by:

clearCurrentBuffer in interface RecordSerializer<T extends IOReadableWritable>

clear

public void clear()

Description copied from interface: RecordSerializer

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 RecordSerializer.setNextBuffer(Buffer)). If you want to continue with the current record, use RecordSerializer.clearCurrentBuffer() instead.

Specified by:

clear in interface RecordSerializer<T extends IOReadableWritable>

hasData

public boolean hasData()

Description copied from interface: RecordSerializer

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

Specified by:

hasData in interface RecordSerializer<T extends IOReadableWritable>

Returns:

true if some data is present

instantiateMetrics

public void instantiateMetrics(TaskIOMetricGroup metrics)

Description copied from interface: RecordSerializer

Instantiates all metrics.

Specified by:

instantiateMetrics in interface RecordSerializer<T extends IOReadableWritable>

Parameters:

metrics - metric group