org.apache.flink.runtime.io.network.bufferprovider

Class GlobalBufferPool

java.lang.Object

org.apache.flink.runtime.io.network.bufferprovider.GlobalBufferPool

public final class GlobalBufferPool
extends Object

A global buffer pool for the network stack.

All buffers used by the network stack come from this pool. Requests to this pool are mediated by instances of LocalBufferPool.

The size and number of buffers can be configured via the global system config.

Constructor Summary

Constructors

Constructor and Description
GlobalBufferPool(int numBuffers, int bufferSize)

Method Summary

Methods

Modifier and Type	Method and Description
void	destroy()
int	getBufferSize() Returns the size of buffers (in bytes).
int	numAvailableBuffers() Returns the number of currently available buffers.
int	numBuffers() Returns the total number of managed buffers.
MemorySegment	requestBuffer() Requests a buffer from the pool.
void	returnBuffer(MemorySegment buffer) Returns a buffer to the pool.

Methods inherited from class java.lang.Object

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

Constructor Detail

GlobalBufferPool

public GlobalBufferPool(int numBuffers,
                int bufferSize)

Method Detail

requestBuffer

public MemorySegment requestBuffer()

Requests a buffer from the pool.

Returns:

buffer from pool or null, if no buffer available

returnBuffer

public void returnBuffer(MemorySegment buffer)

Returns a buffer to the pool.

Parameters:

buffer - the buffer to be returned

getBufferSize

public int getBufferSize()

Returns the size of buffers (in bytes).

Returns:

size of buffers (in bytes)

numBuffers

public int numBuffers()

Returns the total number of managed buffers.

Returns:

total number of managed buffers

numAvailableBuffers

public int numAvailableBuffers()

Returns the number of currently available buffers.

Returns:

currently available number of buffers

destroy

public void destroy()