org.apache.flink.runtime.io.network.netty

Class NettyBufferPool

java.lang.Object

org.apache.flink.runtime.io.network.netty.NettyBufferPool

All Implemented Interfaces:

io.netty.buffer.ByteBufAllocator

public class NettyBufferPool
extends Object
implements io.netty.buffer.ByteBufAllocator

Wrapper around Netty's PooledByteBufAllocator with strict control over the number of created arenas.

Field Summary

Fields inherited from interface io.netty.buffer.ByteBufAllocator

DEFAULT

Constructor Summary

Constructors

Constructor and Description
NettyBufferPool(int numberOfArenas) Creates Netty's buffer pool with the specified number of direct arenas.

Method Summary

Methods

Modifier and Type	Method and Description
io.netty.buffer.ByteBuf	buffer()
io.netty.buffer.ByteBuf	buffer(int initialCapacity)
io.netty.buffer.ByteBuf	buffer(int initialCapacity, int maxCapacity)
io.netty.buffer.CompositeByteBuf	compositeBuffer()
io.netty.buffer.CompositeByteBuf	compositeBuffer(int maxNumComponents)
io.netty.buffer.CompositeByteBuf	compositeDirectBuffer()
io.netty.buffer.CompositeByteBuf	compositeDirectBuffer(int maxNumComponents)
io.netty.buffer.CompositeByteBuf	compositeHeapBuffer()
io.netty.buffer.CompositeByteBuf	compositeHeapBuffer(int maxNumComponents)
io.netty.buffer.ByteBuf	directBuffer()
io.netty.buffer.ByteBuf	directBuffer(int initialCapacity)
io.netty.buffer.ByteBuf	directBuffer(int initialCapacity, int maxCapacity)
scala.Option<Long>	getNumberOfAllocatedBytes() Returns the number of currently allocated bytes.
io.netty.buffer.ByteBuf	heapBuffer()
io.netty.buffer.ByteBuf	heapBuffer(int initialCapacity)
io.netty.buffer.ByteBuf	heapBuffer(int initialCapacity, int maxCapacity)
io.netty.buffer.ByteBuf	ioBuffer()
io.netty.buffer.ByteBuf	ioBuffer(int initialCapacity)
io.netty.buffer.ByteBuf	ioBuffer(int initialCapacity, int maxCapacity)
boolean	isDirectBufferPooled()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NettyBufferPool

public NettyBufferPool(int numberOfArenas)

Creates Netty's buffer pool with the specified number of direct arenas.

Parameters:

numberOfArenas - Number of arenas (recommended: 2 * number of task slots)

Method Detail

getNumberOfAllocatedBytes

public scala.Option<Long> getNumberOfAllocatedBytes()
                                             throws NoSuchFieldException,
                                                    IllegalAccessException

Returns the number of currently allocated bytes.

The stats are gathered via Reflection and are mostly relevant for debugging purposes.

Returns:

Number of currently allocated bytes.

Throws:

NoSuchFieldException - Error getting the statistics (should not happen when the Netty version stays the same).

IllegalAccessException - Error getting the statistics (should not happen when the Netty version stays the same).

buffer

public io.netty.buffer.ByteBuf buffer()

Specified by:

buffer in interface io.netty.buffer.ByteBufAllocator

buffer

public io.netty.buffer.ByteBuf buffer(int initialCapacity)

Specified by:

buffer in interface io.netty.buffer.ByteBufAllocator

buffer

public io.netty.buffer.ByteBuf buffer(int initialCapacity,
                             int maxCapacity)

Specified by:

buffer in interface io.netty.buffer.ByteBufAllocator

ioBuffer

public io.netty.buffer.ByteBuf ioBuffer()

Specified by:

ioBuffer in interface io.netty.buffer.ByteBufAllocator

ioBuffer

public io.netty.buffer.ByteBuf ioBuffer(int initialCapacity)

Specified by:

ioBuffer in interface io.netty.buffer.ByteBufAllocator

ioBuffer

public io.netty.buffer.ByteBuf ioBuffer(int initialCapacity,
                               int maxCapacity)

Specified by:

ioBuffer in interface io.netty.buffer.ByteBufAllocator

heapBuffer

public io.netty.buffer.ByteBuf heapBuffer()

Specified by:

heapBuffer in interface io.netty.buffer.ByteBufAllocator

heapBuffer

public io.netty.buffer.ByteBuf heapBuffer(int initialCapacity)

Specified by:

heapBuffer in interface io.netty.buffer.ByteBufAllocator

heapBuffer

public io.netty.buffer.ByteBuf heapBuffer(int initialCapacity,
                                 int maxCapacity)

Specified by:

heapBuffer in interface io.netty.buffer.ByteBufAllocator

directBuffer

public io.netty.buffer.ByteBuf directBuffer()

Specified by:

directBuffer in interface io.netty.buffer.ByteBufAllocator

directBuffer

public io.netty.buffer.ByteBuf directBuffer(int initialCapacity)

Specified by:

directBuffer in interface io.netty.buffer.ByteBufAllocator

directBuffer

public io.netty.buffer.ByteBuf directBuffer(int initialCapacity,
                                   int maxCapacity)

Specified by:

directBuffer in interface io.netty.buffer.ByteBufAllocator

compositeBuffer

public io.netty.buffer.CompositeByteBuf compositeBuffer()

Specified by:

compositeBuffer in interface io.netty.buffer.ByteBufAllocator

compositeBuffer

public io.netty.buffer.CompositeByteBuf compositeBuffer(int maxNumComponents)

Specified by:

compositeBuffer in interface io.netty.buffer.ByteBufAllocator

compositeHeapBuffer

public io.netty.buffer.CompositeByteBuf compositeHeapBuffer()

Specified by:

compositeHeapBuffer in interface io.netty.buffer.ByteBufAllocator

compositeHeapBuffer

public io.netty.buffer.CompositeByteBuf compositeHeapBuffer(int maxNumComponents)

Specified by:

compositeHeapBuffer in interface io.netty.buffer.ByteBufAllocator

compositeDirectBuffer

public io.netty.buffer.CompositeByteBuf compositeDirectBuffer()

Specified by:

compositeDirectBuffer in interface io.netty.buffer.ByteBufAllocator

compositeDirectBuffer

public io.netty.buffer.CompositeByteBuf compositeDirectBuffer(int maxNumComponents)

Specified by:

compositeDirectBuffer in interface io.netty.buffer.ByteBufAllocator

isDirectBufferPooled

public boolean isDirectBufferPooled()

Specified by:

isDirectBufferPooled in interface io.netty.buffer.ByteBufAllocator