org.apache.flink.streaming.runtime.io

Interface BufferBlocker

All Known Implementing Classes:

BufferSpiller, CachedBufferBlocker

@Internal
public interface BufferBlocker

The buffer blocker takes the buffers and events from a data stream and adds them in a sequence. After a number of elements have been added, the blocker can "roll over": It presents the added elements as a readable sequence, and creates a new sequence.

Method Summary

Modifier and Type	Method and Description
void	add(org.apache.flink.runtime.io.network.partition.consumer.BufferOrEvent boe) Adds a buffer or event to the blocker.
void	close() Cleans up all the resources in the current sequence.
long	getBytesBlocked() Gets the number of bytes blocked in the current sequence.
BufferOrEventSequence	rollOverReusingResources() Starts a new sequence of buffers and event reusing the same resources and returns the current sequence of buffers for reading.
BufferOrEventSequence	rollOverWithoutReusingResources() Starts a new sequence of buffers and event without reusing the same resources and returns the current sequence of buffers for reading.

Method Detail

add

void add(org.apache.flink.runtime.io.network.partition.consumer.BufferOrEvent boe)
  throws IOException

Adds a buffer or event to the blocker.

Parameters:

boe - The buffer or event to be added into the blocker.

Throws:

IOException

rollOverWithoutReusingResources

BufferOrEventSequence rollOverWithoutReusingResources()
                                               throws IOException

Starts a new sequence of buffers and event without reusing the same resources and returns the current sequence of buffers for reading.

Returns:

The readable sequence of buffers and events, or 'null', if nothing was added.

Throws:

IOException

rollOverReusingResources

BufferOrEventSequence rollOverReusingResources()
                                        throws IOException

Starts a new sequence of buffers and event reusing the same resources and returns the current sequence of buffers for reading.

Returns:

The readable sequence of buffers and events, or 'null', if nothing was added.

Throws:

IOException

close

void close()
    throws IOException

Cleans up all the resources in the current sequence.

Throws:

IOException

getBytesBlocked

long getBytesBlocked()

Gets the number of bytes blocked in the current sequence.

Returns:

the number of bytes blocked in the current sequence.