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

Interface BufferPoolFactory

All Known Implementing Classes:

NetworkBufferPool

public interface BufferPoolFactory

A factory for buffer pools.

Method Summary

Modifier and Type	Method and Description
BufferPool	createBufferPool(int numRequiredBuffers, int maxUsedBuffers) Tries to create a buffer pool, which is guaranteed to provide at least the number of required buffers.
BufferPool	createBufferPool(int numRequiredBuffers, int maxUsedBuffers, BufferPoolOwner bufferPoolOwner) Tries to create a buffer pool with an owner, which is guaranteed to provide at least the number of required buffers.
void	destroyBufferPool(BufferPool bufferPool) Destroy callback for updating factory book keeping.

Method Detail

createBufferPool

BufferPool createBufferPool(int numRequiredBuffers,
                            int maxUsedBuffers)
                     throws IOException

Tries to create a buffer pool, which is guaranteed to provide at least the number of required buffers.

The buffer pool is of dynamic size with at least numRequiredBuffers buffers.

Parameters:

numRequiredBuffers - minimum number of network buffers in this pool

maxUsedBuffers - maximum number of network buffers this pool offers

Throws:

IOException

createBufferPool

BufferPool createBufferPool(int numRequiredBuffers,
                            int maxUsedBuffers,
                            BufferPoolOwner bufferPoolOwner)
                     throws IOException

Tries to create a buffer pool with an owner, which is guaranteed to provide at least the number of required buffers.

The buffer pool is of dynamic size with at least numRequiredBuffers buffers.

Parameters:

numRequiredBuffers - minimum number of network buffers in this pool

maxUsedBuffers - maximum number of network buffers this pool offers

bufferPoolOwner - the owner of this buffer pool to release memory when needed

Throws:

IOException

destroyBufferPool

void destroyBufferPool(BufferPool bufferPool)
                throws IOException

Destroy callback for updating factory book keeping.

Throws:

IOException