Package io.netty.buffer

Class UnpooledByteBufAllocator

java.lang.Object

io.netty.buffer.AbstractByteBufAllocator

io.netty.buffer.UnpooledByteBufAllocator

All Implemented Interfaces:

ByteBufAllocator, ByteBufAllocatorMetricProvider

public final class UnpooledByteBufAllocator
extends AbstractByteBufAllocator
implements ByteBufAllocatorMetricProvider

Simplistic ByteBufAllocator implementation that does not pool anything.

Field Summary

Fields

Modifier and Type	Field	Description
static UnpooledByteBufAllocator	DEFAULT	Default instance which uses leak-detection for direct buffers.

Constructor Summary

Constructors

Constructor	Description
UnpooledByteBufAllocator(boolean preferDirect)	Create a new instance which uses leak-detection for direct buffers.
UnpooledByteBufAllocator(boolean preferDirect, boolean disableLeakDetector)	Create a new instance
UnpooledByteBufAllocator(boolean preferDirect, boolean disableLeakDetector, boolean tryNoCleaner)	Create a new instance

Method Summary

Modifier and Type	Method	Description
CompositeByteBuf	compositeDirectBuffer(int maxNumComponents)	Allocate a direct CompositeByteBuf with the given maximum number of components that can be stored in it.
CompositeByteBuf	compositeHeapBuffer(int maxNumComponents)	Allocate a heap CompositeByteBuf with the given maximum number of components that can be stored in it.
boolean	isDirectBufferPooled()	Returns true if direct ByteBuf's are pooled
ByteBufAllocatorMetric	metric()	Returns a ByteBufAllocatorMetric for a ByteBufAllocator.
protected ByteBuf	newDirectBuffer(int initialCapacity, int maxCapacity)	Create a direct ByteBuf with the given initialCapacity and maxCapacity.
protected ByteBuf	newHeapBuffer(int initialCapacity, int maxCapacity)	Create a heap ByteBuf with the given initialCapacity and maxCapacity.

Methods inherited from class io.netty.buffer.AbstractByteBufAllocator

buffer, buffer, buffer, calculateNewCapacity, compositeBuffer, compositeBuffer, compositeDirectBuffer, compositeHeapBuffer, directBuffer, directBuffer, directBuffer, heapBuffer, heapBuffer, heapBuffer, ioBuffer, ioBuffer, ioBuffer, toLeakAwareBuffer, toLeakAwareBuffer, toString

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final UnpooledByteBufAllocator DEFAULT

Default instance which uses leak-detection for direct buffers.

Constructor Detail

UnpooledByteBufAllocator

public UnpooledByteBufAllocator(boolean preferDirect)

Create a new instance which uses leak-detection for direct buffers.

Parameters:

preferDirect - true if AbstractByteBufAllocator.buffer(int) should try to allocate a direct buffer rather than a heap buffer

UnpooledByteBufAllocator

public UnpooledByteBufAllocator(boolean preferDirect,
                                boolean disableLeakDetector)

Create a new instance

Parameters:

preferDirect - true if AbstractByteBufAllocator.buffer(int) should try to allocate a direct buffer rather than a heap buffer

disableLeakDetector - true if the leak-detection should be disabled completely for this allocator. This can be useful if the user just want to depend on the GC to handle direct buffers when not explicit released.

UnpooledByteBufAllocator

public UnpooledByteBufAllocator(boolean preferDirect,
                                boolean disableLeakDetector,
                                boolean tryNoCleaner)

Create a new instance

Parameters:

preferDirect - true if AbstractByteBufAllocator.buffer(int) should try to allocate a direct buffer rather than a heap buffer

disableLeakDetector - true if the leak-detection should be disabled completely for this allocator. This can be useful if the user just want to depend on the GC to handle direct buffers when not explicit released.

tryNoCleaner - true if we should try to use PlatformDependent.allocateDirectNoCleaner(int) to allocate direct memory.

Method Detail

newHeapBuffer

protected ByteBuf newHeapBuffer(int initialCapacity,
                                int maxCapacity)

Description copied from class: AbstractByteBufAllocator

Create a heap ByteBuf with the given initialCapacity and maxCapacity.

Specified by:

newHeapBuffer in class AbstractByteBufAllocator

newDirectBuffer

protected ByteBuf newDirectBuffer(int initialCapacity,
                                  int maxCapacity)

Description copied from class: AbstractByteBufAllocator

Create a direct ByteBuf with the given initialCapacity and maxCapacity.

Specified by:

newDirectBuffer in class AbstractByteBufAllocator

compositeHeapBuffer

public CompositeByteBuf compositeHeapBuffer(int maxNumComponents)

Description copied from interface: ByteBufAllocator

Allocate a heap CompositeByteBuf with the given maximum number of components that can be stored in it.

Specified by:

compositeHeapBuffer in interface ByteBufAllocator

Overrides:

compositeHeapBuffer in class AbstractByteBufAllocator

compositeDirectBuffer

public CompositeByteBuf compositeDirectBuffer(int maxNumComponents)

Description copied from interface: ByteBufAllocator

Allocate a direct CompositeByteBuf with the given maximum number of components that can be stored in it.

Specified by:

compositeDirectBuffer in interface ByteBufAllocator

Overrides:

compositeDirectBuffer in class AbstractByteBufAllocator

isDirectBufferPooled

public boolean isDirectBufferPooled()

Description copied from interface: ByteBufAllocator

Returns true if direct ByteBuf's are pooled

Specified by:

isDirectBufferPooled in interface ByteBufAllocator

metric

public ByteBufAllocatorMetric metric()

Description copied from interface: ByteBufAllocatorMetricProvider

Returns a ByteBufAllocatorMetric for a ByteBufAllocator.

Specified by:

metric in interface ByteBufAllocatorMetricProvider