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

Interface LocalBufferPoolOwner

All Known Implementing Classes:

InputGate, RuntimeEnvironment

public interface LocalBufferPoolOwner

A local buffer pool owner is an object which initially retrieves its buffers from the GlobalBufferPool and manages its fraction of the overall buffer pool locally by means of a LocalBufferPool.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearLocalBufferPool() Clears the local buffer pool and returns all buffers to the global buffer pool.
int	getNumberOfChannels() Returns the number of byte-buffered channels that will retrieve their buffers from the local buffer pool.
void	logBufferUtilization() Logs the current status of the local buffer pool.
void	registerGlobalBufferPool(GlobalBufferPool globalBufferPool)
void	reportAsynchronousEvent() Reports an asynchronous event.
void	setDesignatedNumberOfBuffers(int numBuffers) Sets the designated number of buffers the local buffer pool owner is allowed to fetch from the global buffer pool and manage locally by means of the LocalBufferPool.

Method Detail

getNumberOfChannels

int getNumberOfChannels()

Returns the number of byte-buffered channels that will retrieve their buffers from the local buffer pool.

Returns:

the number of byte-buffered channels that will retrieve their buffers from the local buffer pool

setDesignatedNumberOfBuffers

void setDesignatedNumberOfBuffers(int numBuffers)

Sets the designated number of buffers the local buffer pool owner is allowed to fetch from the global buffer pool and manage locally by means of the LocalBufferPool.

Parameters:

numBuffers - the numBuffers the local buffer pool owner is allowed to fetch from the global buffer pool

clearLocalBufferPool

void clearLocalBufferPool()

Clears the local buffer pool and returns all buffers to the global buffer pool.

registerGlobalBufferPool

void registerGlobalBufferPool(GlobalBufferPool globalBufferPool)

logBufferUtilization

void logBufferUtilization()

Logs the current status of the local buffer pool. This method is intended mainly for debugging purposes.

reportAsynchronousEvent

void reportAsynchronousEvent()

Reports an asynchronous event. Calling this method interrupts each blocking method of the buffer pool owner and allows the blocked thread to respond to the event.