org.apache.flink.streaming.runtime.io

Class LinkedBufferStorage

java.lang.Object

org.apache.flink.streaming.runtime.io.LinkedBufferStorage

All Implemented Interfaces:

AutoCloseable, BufferStorage

public class LinkedBufferStorage
extends Object
implements BufferStorage

Implementation of BufferStorage that links two BufferStorage together. Each of the linked BufferStorage will store buffers independently, but they will be linked together for rollOver() - if one is rolled over, other will do that as well.

Note that only mainStorage is closed when LinkedBufferStorage instance is closed.

Constructor Summary

Constructors

Constructor and Description
LinkedBufferStorage(BufferStorage mainStorage, BufferStorage linkedStorage, long maxBufferedBytes)

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 BufferStorage.
void	close() Cleans up all the resources in the current sequence.
long	getMaxBufferedBytes()
long	getPendingBytes()
long	getRolledBytes()
boolean	isEmpty()
boolean	isFull()
Optional<org.apache.flink.runtime.io.network.partition.consumer.BufferOrEvent>	pollNext()
void	rollOver() Start returning next sequence of stored BufferOrEvents.

Methods inherited from class java.lang.Object

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

Constructor Detail

LinkedBufferStorage

public LinkedBufferStorage(BufferStorage mainStorage,
                           BufferStorage linkedStorage,
                           long maxBufferedBytes)

Method Detail

add

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

Description copied from interface: BufferStorage

Adds a buffer or event to the BufferStorage.

Specified by:

add in interface BufferStorage

Parameters:

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

isFull

public boolean isFull()

Specified by:

isFull in interface BufferStorage

Returns:

true if size limit was exceeded.

rollOver

public void rollOver()

Description copied from interface: BufferStorage

Start returning next sequence of stored BufferOrEvents.

Specified by:

rollOver in interface BufferStorage

getPendingBytes

public long getPendingBytes()

Specified by:

getPendingBytes in interface BufferStorage

Returns:

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

getRolledBytes

public long getRolledBytes()

Specified by:

getRolledBytes in interface BufferStorage

Returns:

the number of already rolled bytes in in blocked sequences.

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface BufferStorage

Returns:

true if this BufferStorage doesn't store and data.

pollNext

public Optional<org.apache.flink.runtime.io.network.partition.consumer.BufferOrEvent> pollNext()

Specified by:

pollNext in interface BufferStorage

getMaxBufferedBytes

public long getMaxBufferedBytes()

Specified by:

getMaxBufferedBytes in interface BufferStorage

close

public void close()

Description copied from interface: BufferStorage

Cleans up all the resources in the current sequence.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface BufferStorage