org.apache.flink.runtime.io.network.buffer

Interface BufferPool

All Superinterfaces:

BufferProvider, BufferRecycler

public interface BufferPool
extends BufferProvider, BufferRecycler

A dynamically sized buffer pool.

Method Summary

Modifier and Type	Method and Description
int	getNumberOfAvailableMemorySegments() Returns the number memory segments, which are currently held by this buffer pool.
int	getNumberOfRequiredMemorySegments() Returns the number of guaranteed (minimum number of) memory segments of this buffer pool.
int	getNumBuffers() Returns the current size of this buffer pool.
boolean	isDestroyed() Checks whether this buffer pool has been destroyed.
void	lazyDestroy() Destroys this buffer pool.
void	setBufferPoolOwner(BufferPoolOwner owner) The owner of this buffer pool to be called when memory needs to be released to avoid back pressure.
void	setNumBuffers(int numBuffers) Sets the current size of this buffer pool.

Methods inherited from interface org.apache.flink.runtime.io.network.buffer.BufferProvider

addListener, getMemorySegmentSize, requestBuffer, requestBufferBlocking

Methods inherited from interface org.apache.flink.runtime.io.network.buffer.BufferRecycler

recycle

Method Detail

setBufferPoolOwner

void setBufferPoolOwner(BufferPoolOwner owner)

The owner of this buffer pool to be called when memory needs to be released to avoid back pressure.

lazyDestroy

void lazyDestroy()

Destroys this buffer pool.

If not all buffers are available, they are recycled lazily as soon as they are recycled.

isDestroyed

boolean isDestroyed()

Checks whether this buffer pool has been destroyed.

Specified by:

isDestroyed in interface BufferProvider

getNumberOfRequiredMemorySegments

int getNumberOfRequiredMemorySegments()

Returns the number of guaranteed (minimum number of) memory segments of this buffer pool.

getNumBuffers

int getNumBuffers()

Returns the current size of this buffer pool.

The size of the buffer pool can change dynamically at runtime.

setNumBuffers

void setNumBuffers(int numBuffers)
            throws IOException

Sets the current size of this buffer pool.

The size needs to be greater or equals to the guaranteed number of memory segments.

Throws:

IOException

getNumberOfAvailableMemorySegments

int getNumberOfAvailableMemorySegments()

Returns the number memory segments, which are currently held by this buffer pool.