org.apache.flink.streaming.runtime.io

Interface BufferStorage

All Superinterfaces:

AutoCloseable

All Known Implementing Classes:

AbstractBufferStorage, BufferSpiller, CachedBufferStorage, EmptyBufferStorage, LinkedBufferStorage

@Internal
public interface BufferStorage
extends AutoCloseable

The BufferStorage takes the buffers and events from a data stream and adds them in a sequence. After a number of elements have been added, the BufferStorage can "roll over". After rolling over, previously stored buffers are available for reading via pollNext().

Method Summary

Modifier and Type	Method and Description
void	add(BufferOrEvent boe) Adds a buffer or event to the BufferStorage.
void	close() Cleans up all the resources in the current sequence.
long	getMaxBufferedBytes()
long	getPendingBytes()
long	getRolledBytes()
boolean	isEmpty()
boolean	isFull()
Optional<BufferOrEvent>	pollNext()
void	rollOver() Start returning next sequence of stored BufferOrEvents.

Method Detail

add

void add(BufferOrEvent boe)
  throws IOException

Adds a buffer or event to the BufferStorage.

Parameters:

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

Throws:

IOException

isFull

boolean isFull()

Returns:

true if size limit was exceeded.

rollOver

void rollOver()
       throws IOException

Start returning next sequence of stored BufferOrEvents.

Throws:

IOException

getPendingBytes

long getPendingBytes()

Returns:

the number of pending bytes blocked in the current sequence - bytes that are have not been yet rolled, but are already blocked.

getRolledBytes

long getRolledBytes()

Returns:

the number of already rolled bytes in in blocked sequences.

isEmpty

boolean isEmpty()

Returns:

true if this BufferStorage doesn't store and data.

pollNext

Optional<BufferOrEvent> pollNext()
                          throws IOException

Throws:

IOException

getMaxBufferedBytes

long getMaxBufferedBytes()

close

void close()
    throws IOException

Cleans up all the resources in the current sequence.

Specified by:

close in interface AutoCloseable

Throws:

IOException