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

Interface BufferProvider

All Known Implementing Classes:

DiscardBufferPool, InputChannel, InputGate, LocalBufferPool, RuntimeEnvironment

public interface BufferProvider

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BufferProvider.BufferAvailabilityRegistration

Method Summary

Methods

Modifier and Type	Method and Description
int	getBufferSize() Returns the size of buffers (in bytes) available at this buffer provider.
BufferProvider.BufferAvailabilityRegistration	registerBufferAvailabilityListener(BufferAvailabilityListener listener) Registers the given BufferAvailabilityListener with an empty buffer pool.
void	reportAsynchronousEvent() Reports an asynchronous event and interrupts each blocking method of this buffer provider in order to allow the blocked thread to respond to the event.
Buffer	requestBuffer(int minBufferSize) Requests a buffer with a minimum size of minBufferSize.
Buffer	requestBufferBlocking(int minBufferSize) Requests a buffer with a minimum size of minBufferSize.

Method Detail

requestBuffer

Buffer requestBuffer(int minBufferSize)
                     throws IOException

Requests a buffer with a minimum size of minBufferSize. The method returns immediately, even if the request could not be fulfilled.

Parameters:

minBufferSize - minimum size of the requested buffer (in bytes)

Returns:

buffer with at least the requested size or null if no such buffer is currently available

Throws:

IOException

requestBufferBlocking

Buffer requestBufferBlocking(int minBufferSize)
                             throws IOException,
                                    InterruptedException

Requests a buffer with a minimum size of minBufferSize. The method blocks until the request has been fulfilled or reportAsynchronousEvent() has been called.

Parameters:

minBufferSize - minimum size of the requested buffer (in bytes)

Returns:

buffer with at least the requested size

Throws:

IOException

InterruptedException

getBufferSize

int getBufferSize()

Returns the size of buffers (in bytes) available at this buffer provider.

Returns:

size of buffers (in bytes) available at this buffer provider

reportAsynchronousEvent

void reportAsynchronousEvent()

Reports an asynchronous event and interrupts each blocking method of this buffer provider in order to allow the blocked thread to respond to the event.

registerBufferAvailabilityListener

BufferProvider.BufferAvailabilityRegistration registerBufferAvailabilityListener(BufferAvailabilityListener listener)

Registers the given BufferAvailabilityListener with an empty buffer pool.

The registration only succeeds, if the buffer pool is empty and has not been destroyed yet.

The registered listener will receive a notification when at least one buffer has become available again. After the notification, the listener will be unregistered.

Parameters:

listener - the listener to be registered

Returns:

true if the registration has been successful; false if the registration failed, because the buffer pool was not empty or has already been destroyed