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

Interface BufferProvider

All Superinterfaces:

AvailabilityProvider

All Known Subinterfaces:

BufferPool

public interface BufferProvider
extends AvailabilityProvider

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.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.runtime.io.AvailabilityProvider

AvailabilityProvider.AvailabilityHelper

Field Summary

Fields inherited from interface org.apache.flink.runtime.io.AvailabilityProvider

AVAILABLE

Method Summary

Modifier and Type	Method and Description
boolean	addBufferListener(BufferListener listener) Adds a buffer availability listener to the buffer provider.
boolean	isDestroyed() Returns whether the buffer provider has been destroyed.
Buffer	requestBuffer() Returns a Buffer instance from the buffer provider, if one is available.
BufferBuilder	requestBufferBuilderBlocking() Returns a BufferBuilder instance from the buffer provider.

Methods inherited from interface org.apache.flink.runtime.io.AvailabilityProvider

getAvailableFuture, isApproximatelyAvailable, isAvailable

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

requestBufferBuilderBlocking

BufferBuilder requestBufferBuilderBlocking()
                                    throws IOException,
                                           InterruptedException

Returns a BufferBuilder 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

addBufferListener

boolean addBufferListener(BufferListener 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.

isDestroyed

boolean isDestroyed()

Returns whether the buffer provider has been destroyed.