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

Interface BufferProvider

All Known Subinterfaces:

BufferPool

public interface BufferProvider

A buffer provider to request buffers from in a synchronous or asynchronous fashion.

The data producing side (result partition writers) request buffers in a synchronous fashion, whereas the input side requests asynchronously.

Method Summary

Modifier and Type	Method and Description
boolean	addListener(EventListener<Buffer> listener) Adds a buffer availability listener to the buffer provider.
int	getMemorySegmentSize() Returns the size of the underlying memory segments.
boolean	isDestroyed() Returns whether the buffer provider has been destroyed.
Buffer	requestBuffer() Returns a Buffer instance from the buffer provider, if one is available.
Buffer	requestBufferBlocking() Returns a Buffer instance from the buffer provider.

Method Detail

requestBuffer

Buffer requestBuffer()
              throws IOException

Returns a Buffer instance from the buffer provider, if one is available.

Returns null if no buffer is available or the buffer provider has been destroyed.

Throws:

IOException

requestBufferBlocking

Buffer requestBufferBlocking()
                      throws IOException,
                             InterruptedException

Returns a Buffer instance from the buffer provider.

If there is no buffer available, the call will block until one becomes available again or the buffer provider has been destroyed.

Throws:

IOException

InterruptedException

addListener

boolean addListener(EventListener<Buffer> listener)

Adds a buffer availability listener to the buffer provider.

The operation fails with return value false, when there is a buffer available or the buffer provider has been destroyed.

If the buffer provider gets destroyed while the listener is registered the listener will be notified with a null value.

isDestroyed

boolean isDestroyed()

Returns whether the buffer provider has been destroyed.

getMemorySegmentSize

int getMemorySegmentSize()

Returns the size of the underlying memory segments. This is the maximum size a Buffer instance can have.