org.apache.flink.streaming.runtime.io

Interface BufferOrEventSequence

All Known Implementing Classes:

BufferSpiller.SpilledBufferOrEventSequence, CachedBufferBlocker.CachedBufferOrEventSequence

@Internal
public interface BufferOrEventSequence

This class represents a sequence of buffers and events which are blocked by CheckpointBarrierHandler. The sequence of buffers and events can be read back using the method getNext().

Method Summary

Modifier and Type	Method and Description
void	cleanup() Cleans up all the resources held by the sequence.
BufferOrEvent	getNext() Gets the next BufferOrEvent from the sequence, or null, if the sequence is exhausted.
void	open() Initializes the sequence for reading.
long	size() Gets the size of the sequence.

Method Detail

open

void open()

Initializes the sequence for reading.

getNext

@Nullable
BufferOrEvent getNext()
                         throws IOException

Gets the next BufferOrEvent from the sequence, or null, if the sequence is exhausted.

Returns:

The next BufferOrEvent from the buffered sequence, or null (end of sequence).

Throws:

IOException

cleanup

void cleanup()
      throws IOException

Cleans up all the resources held by the sequence.

Throws:

IOException

size

long size()

Gets the size of the sequence.