Package io.netty.buffer

Class AdaptiveByteBufAllocator

java.lang.Object

io.netty.buffer.AbstractByteBufAllocator

io.netty.buffer.AdaptiveByteBufAllocator

All Implemented Interfaces:

ByteBufAllocator, ByteBufAllocatorMetric, ByteBufAllocatorMetricProvider

@UnstableApi
public final class AdaptiveByteBufAllocator
extends AbstractByteBufAllocator
implements ByteBufAllocatorMetricProvider, ByteBufAllocatorMetric

An auto-tuning pooling ByteBufAllocator, that follows an anti-generational hypothesis.

Note: this allocator is experimental. It is recommended to roll out usage slowly, and to carefully monitor application performance in the process.

See the AdaptivePoolingAllocator class documentation for implementation details.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static interface	AdaptiveByteBufAllocator.AdaptiveAllocatorApi
private static class	AdaptiveByteBufAllocator.DirectChunkAllocator
private static class	AdaptiveByteBufAllocator.HeapChunkAllocator

Field Summary

Fields

Modifier and Type	Field	Description
private static boolean	DEFAULT_USE_CACHED_MAGAZINES_FOR_NON_EVENT_LOOP_THREADS
private AdaptiveByteBufAllocator.AdaptiveAllocatorApi	direct
private AdaptiveByteBufAllocator.AdaptiveAllocatorApi	heap
private static InternalLogger	logger

Fields inherited from class io.netty.buffer.AbstractByteBufAllocator

CALCULATE_THRESHOLD, DEFAULT_INITIAL_CAPACITY, DEFAULT_MAX_CAPACITY, DEFAULT_MAX_COMPONENTS

Fields inherited from interface io.netty.buffer.ByteBufAllocator

DEFAULT

Constructor Summary

Constructors

Constructor	Description
AdaptiveByteBufAllocator()
AdaptiveByteBufAllocator(boolean preferDirect)
AdaptiveByteBufAllocator(boolean preferDirect, boolean useCacheForNonEventLoopThreads)

Method Summary

Modifier and Type	Method	Description
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.
long	usedDirectMemory()	Returns the number of bytes of direct memory used by a ByteBufAllocator or -1 if unknown.
long	usedHeapMemory()	Returns the number of bytes of heap memory used by a ByteBufAllocator or -1 if unknown.

Methods inherited from class io.netty.buffer.AbstractByteBufAllocator

buffer, buffer, buffer, calculateNewCapacity, compositeBuffer, compositeBuffer, compositeDirectBuffer, compositeDirectBuffer, compositeHeapBuffer, 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

logger

private static final InternalLogger logger

DEFAULT_USE_CACHED_MAGAZINES_FOR_NON_EVENT_LOOP_THREADS

private static final boolean DEFAULT_USE_CACHED_MAGAZINES_FOR_NON_EVENT_LOOP_THREADS

direct

private final AdaptiveByteBufAllocator.AdaptiveAllocatorApi direct

heap

private final AdaptiveByteBufAllocator.AdaptiveAllocatorApi heap

Constructor Detail

AdaptiveByteBufAllocator

public AdaptiveByteBufAllocator()

AdaptiveByteBufAllocator

public AdaptiveByteBufAllocator(boolean preferDirect)

AdaptiveByteBufAllocator

public AdaptiveByteBufAllocator(boolean preferDirect,
                                boolean useCacheForNonEventLoopThreads)

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

isDirectBufferPooled

public boolean isDirectBufferPooled()

Description copied from interface: ByteBufAllocator

Returns true if direct ByteBuf's are pooled

Specified by:

isDirectBufferPooled in interface ByteBufAllocator

usedHeapMemory

public long usedHeapMemory()

Description copied from interface: ByteBufAllocatorMetric

Returns the number of bytes of heap memory used by a ByteBufAllocator or -1 if unknown.

Specified by:

usedHeapMemory in interface ByteBufAllocatorMetric

usedDirectMemory

public long usedDirectMemory()

Description copied from interface: ByteBufAllocatorMetric

Returns the number of bytes of direct memory used by a ByteBufAllocator or -1 if unknown.

Specified by:

usedDirectMemory in interface ByteBufAllocatorMetric

metric

public ByteBufAllocatorMetric metric()

Description copied from interface: ByteBufAllocatorMetricProvider

Returns a ByteBufAllocatorMetric for a ByteBufAllocator.

Specified by:

metric in interface ByteBufAllocatorMetricProvider