io.netty.buffer

Class PooledByteBufAllocator

java.lang.Object

io.netty.buffer.AbstractByteBufAllocator

io.netty.buffer.PooledByteBufAllocator

All Implemented Interfaces:

ByteBufAllocator, ByteBufAllocatorMetricProvider

public class PooledByteBufAllocator
extends AbstractByteBufAllocator
implements ByteBufAllocatorMetricProvider

Field Summary

Fields

Modifier and Type	Field and Description
static PooledByteBufAllocator	DEFAULT

Constructor Summary

Constructors

Constructor and Description
PooledByteBufAllocator()
PooledByteBufAllocator(boolean preferDirect)
PooledByteBufAllocator(boolean preferDirect, int nHeapArena, int nDirectArena, int pageSize, int maxOrder) Deprecated. use PooledByteBufAllocator(boolean, int, int, int, int, int, int, boolean)
PooledByteBufAllocator(boolean preferDirect, int nHeapArena, int nDirectArena, int pageSize, int maxOrder, int smallCacheSize, int normalCacheSize, boolean useCacheForAllThreads)
PooledByteBufAllocator(boolean preferDirect, int nHeapArena, int nDirectArena, int pageSize, int maxOrder, int smallCacheSize, int normalCacheSize, boolean useCacheForAllThreads, int directMemoryCacheAlignment)
PooledByteBufAllocator(boolean preferDirect, int nHeapArena, int nDirectArena, int pageSize, int maxOrder, int tinyCacheSize, int smallCacheSize, int normalCacheSize) Deprecated. use PooledByteBufAllocator(boolean, int, int, int, int, int, int, boolean)
PooledByteBufAllocator(boolean preferDirect, int nHeapArena, int nDirectArena, int pageSize, int maxOrder, int tinyCacheSize, int smallCacheSize, int normalCacheSize, boolean useCacheForAllThreads) Deprecated. use PooledByteBufAllocator(boolean, int, int, int, int, int, int, boolean)
PooledByteBufAllocator(boolean preferDirect, int nHeapArena, int nDirectArena, int pageSize, int maxOrder, int tinyCacheSize, int smallCacheSize, int normalCacheSize, boolean useCacheForAllThreads, int directMemoryCacheAlignment) Deprecated. use PooledByteBufAllocator(boolean, int, int, int, int, int, int, boolean, int)
PooledByteBufAllocator(int nHeapArena, int nDirectArena, int pageSize, int maxOrder)

Method Summary

Modifier and Type	Method and Description
int	chunkSize() Deprecated. use PooledByteBufAllocatorMetric.chunkSize().
static boolean	defaultDisableCacheFinalizersForFastThreadLocalThreads() Default control creation of PoolThreadCache finalizers for FastThreadLocalThreads - System Property: io.netty.allocator.disableCacheFinalizersForFastThreadLocalThreads - default false
static int	defaultMaxOrder() Default maximum order - System Property: io.netty.allocator.maxOrder - default 9
static int	defaultNormalCacheSize() Default normal cache size - System Property: io.netty.allocator.normalCacheSize - default 64
static int	defaultNumDirectArena() Default number of direct arenas - System Property: io.netty.allocator.numDirectArenas - default 2 * cores
static int	defaultNumHeapArena() Default number of heap arenas - System Property: io.netty.allocator.numHeapArenas - default 2 * cores
static int	defaultPageSize() Default buffer page size - System Property: io.netty.allocator.pageSize - default 8192
static boolean	defaultPreferDirect() Default prefer direct - System Property: io.netty.noPreferDirect - default false
static int	defaultSmallCacheSize() Default small cache size - System Property: io.netty.allocator.smallCacheSize - default 256
static int	defaultTinyCacheSize() Deprecated. Tiny caches have been merged into small caches.
static boolean	defaultUseCacheForAllThreads() Default thread caching behavior - System Property: io.netty.allocator.useCacheForAllThreads - default false
List<PoolArenaMetric>	directArenas() Deprecated. use PooledByteBufAllocatorMetric.directArenas().
String	dumpStats() Returns the status of the allocator (which contains all metrics) as string.
void	freeThreadLocalCache() Deprecated. will be removed Free all cached buffers for the calling Thread.
boolean	hasThreadLocalCache() Deprecated. will be removed Returns true if the calling Thread has a ThreadLocal cache for the allocated buffers.
List<PoolArenaMetric>	heapArenas() Deprecated. use PooledByteBufAllocatorMetric.heapArenas().
boolean	isDirectBufferPooled() Returns true if direct ByteBuf's are pooled
static boolean	isDirectMemoryCacheAlignmentSupported() Return true if direct memory cache alignment is supported, false otherwise.
PooledByteBufAllocatorMetric	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.
int	normalCacheSize() Deprecated. use PooledByteBufAllocatorMetric.normalCacheSize().
int	numDirectArenas() Deprecated. use PooledByteBufAllocatorMetric.numDirectArenas().
int	numHeapArenas() Deprecated. use PooledByteBufAllocatorMetric.numHeapArenas().
int	numThreadLocalCaches() Deprecated. use PooledByteBufAllocatorMetric.numThreadLocalCaches().
long	pinnedDirectMemory() Returns the number of bytes of direct memory that is currently pinned to direct buffers allocated by a ByteBufAllocator, or -1 if unknown.
long	pinnedHeapMemory() Returns the number of bytes of heap memory that is currently pinned to heap buffers allocated by a ByteBufAllocator, or -1 if unknown.
int	smallCacheSize() Deprecated. use PooledByteBufAllocatorMetric.smallCacheSize().
int	tinyCacheSize() Deprecated. use PooledByteBufAllocatorMetric.tinyCacheSize().
boolean	trimCurrentThreadCache() Trim thread local cache for the current Thread, which will give back any cached memory that was not allocated frequently since the last trim operation.

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

DEFAULT

public static final PooledByteBufAllocator DEFAULT

Constructor Detail

PooledByteBufAllocator

public PooledByteBufAllocator()

PooledByteBufAllocator

public PooledByteBufAllocator(boolean preferDirect)

PooledByteBufAllocator

public PooledByteBufAllocator(int nHeapArena,
                              int nDirectArena,
                              int pageSize,
                              int maxOrder)

PooledByteBufAllocator

@Deprecated
public PooledByteBufAllocator(boolean preferDirect,
                                          int nHeapArena,
                                          int nDirectArena,
                                          int pageSize,
                                          int maxOrder)

Deprecated. use PooledByteBufAllocator(boolean, int, int, int, int, int, int, boolean)

PooledByteBufAllocator

@Deprecated
public PooledByteBufAllocator(boolean preferDirect,
                                          int nHeapArena,
                                          int nDirectArena,
                                          int pageSize,
                                          int maxOrder,
                                          int tinyCacheSize,
                                          int smallCacheSize,
                                          int normalCacheSize)

Deprecated. use PooledByteBufAllocator(boolean, int, int, int, int, int, int, boolean)

PooledByteBufAllocator

@Deprecated
public PooledByteBufAllocator(boolean preferDirect,
                                          int nHeapArena,
                                          int nDirectArena,
                                          int pageSize,
                                          int maxOrder,
                                          int tinyCacheSize,
                                          int smallCacheSize,
                                          int normalCacheSize,
                                          boolean useCacheForAllThreads)

Deprecated. use PooledByteBufAllocator(boolean, int, int, int, int, int, int, boolean)

PooledByteBufAllocator

public PooledByteBufAllocator(boolean preferDirect,
                              int nHeapArena,
                              int nDirectArena,
                              int pageSize,
                              int maxOrder,
                              int smallCacheSize,
                              int normalCacheSize,
                              boolean useCacheForAllThreads)

PooledByteBufAllocator

@Deprecated
public PooledByteBufAllocator(boolean preferDirect,
                                          int nHeapArena,
                                          int nDirectArena,
                                          int pageSize,
                                          int maxOrder,
                                          int tinyCacheSize,
                                          int smallCacheSize,
                                          int normalCacheSize,
                                          boolean useCacheForAllThreads,
                                          int directMemoryCacheAlignment)

Deprecated. use PooledByteBufAllocator(boolean, int, int, int, int, int, int, boolean, int)

PooledByteBufAllocator

public PooledByteBufAllocator(boolean preferDirect,
                              int nHeapArena,
                              int nDirectArena,
                              int pageSize,
                              int maxOrder,
                              int smallCacheSize,
                              int normalCacheSize,
                              boolean useCacheForAllThreads,
                              int directMemoryCacheAlignment)

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

defaultNumHeapArena

public static int defaultNumHeapArena()

Default number of heap arenas - System Property: io.netty.allocator.numHeapArenas - default 2 * cores

defaultNumDirectArena

public static int defaultNumDirectArena()

Default number of direct arenas - System Property: io.netty.allocator.numDirectArenas - default 2 * cores

defaultPageSize

public static int defaultPageSize()

Default buffer page size - System Property: io.netty.allocator.pageSize - default 8192

defaultMaxOrder

public static int defaultMaxOrder()

Default maximum order - System Property: io.netty.allocator.maxOrder - default 9

defaultDisableCacheFinalizersForFastThreadLocalThreads

public static boolean defaultDisableCacheFinalizersForFastThreadLocalThreads()

Default control creation of PoolThreadCache finalizers for FastThreadLocalThreads - System Property: io.netty.allocator.disableCacheFinalizersForFastThreadLocalThreads - default false

defaultUseCacheForAllThreads

public static boolean defaultUseCacheForAllThreads()

Default thread caching behavior - System Property: io.netty.allocator.useCacheForAllThreads - default false

defaultPreferDirect

public static boolean defaultPreferDirect()

Default prefer direct - System Property: io.netty.noPreferDirect - default false

defaultTinyCacheSize

@Deprecated
public static int defaultTinyCacheSize()

Deprecated. Tiny caches have been merged into small caches.

Default tiny cache size - default 0

defaultSmallCacheSize

public static int defaultSmallCacheSize()

Default small cache size - System Property: io.netty.allocator.smallCacheSize - default 256

defaultNormalCacheSize

public static int defaultNormalCacheSize()

Default normal cache size - System Property: io.netty.allocator.normalCacheSize - default 64

isDirectMemoryCacheAlignmentSupported

public static boolean isDirectMemoryCacheAlignmentSupported()

Return true if direct memory cache alignment is supported, false otherwise.

isDirectBufferPooled

public boolean isDirectBufferPooled()

Description copied from interface: ByteBufAllocator

Returns true if direct ByteBuf's are pooled

Specified by:

isDirectBufferPooled in interface ByteBufAllocator

hasThreadLocalCache

@Deprecated
public boolean hasThreadLocalCache()

Deprecated. will be removed Returns true if the calling Thread has a ThreadLocal cache for the allocated buffers.

freeThreadLocalCache

@Deprecated
public void freeThreadLocalCache()

Deprecated. will be removed Free all cached buffers for the calling Thread.

metric

public PooledByteBufAllocatorMetric metric()

Description copied from interface: ByteBufAllocatorMetricProvider

Returns a ByteBufAllocatorMetric for a ByteBufAllocator.

Specified by:

metric in interface ByteBufAllocatorMetricProvider

numHeapArenas

@Deprecated
public int numHeapArenas()

Deprecated. use PooledByteBufAllocatorMetric.numHeapArenas().

Return the number of heap arenas.

numDirectArenas

@Deprecated
public int numDirectArenas()

Deprecated. use PooledByteBufAllocatorMetric.numDirectArenas().

Return the number of direct arenas.

heapArenas

@Deprecated
public List<PoolArenaMetric> heapArenas()

Deprecated. use PooledByteBufAllocatorMetric.heapArenas().

Return a List of all heap PoolArenaMetrics that are provided by this pool.

directArenas

@Deprecated
public List<PoolArenaMetric> directArenas()

Deprecated. use PooledByteBufAllocatorMetric.directArenas().

Return a List of all direct PoolArenaMetrics that are provided by this pool.

numThreadLocalCaches

@Deprecated
public int numThreadLocalCaches()

Deprecated. use PooledByteBufAllocatorMetric.numThreadLocalCaches().

Return the number of thread local caches used by this PooledByteBufAllocator.

tinyCacheSize

@Deprecated
public int tinyCacheSize()

Deprecated. use PooledByteBufAllocatorMetric.tinyCacheSize().

Return the size of the tiny cache.

smallCacheSize

@Deprecated
public int smallCacheSize()

Deprecated. use PooledByteBufAllocatorMetric.smallCacheSize().

Return the size of the small cache.

normalCacheSize

@Deprecated
public int normalCacheSize()

Deprecated. use PooledByteBufAllocatorMetric.normalCacheSize().

Return the size of the normal cache.

chunkSize

@Deprecated
public final int chunkSize()

Deprecated. use PooledByteBufAllocatorMetric.chunkSize().

Return the chunk size for an arena.

pinnedHeapMemory

public final long pinnedHeapMemory()

Returns the number of bytes of heap memory that is currently pinned to heap buffers allocated by a ByteBufAllocator, or -1 if unknown. A buffer can pin more memory than its capacity might indicate, due to implementation details of the allocator.

pinnedDirectMemory

public final long pinnedDirectMemory()

Returns the number of bytes of direct memory that is currently pinned to direct buffers allocated by a ByteBufAllocator, or -1 if unknown. A buffer can pin more memory than its capacity might indicate, due to implementation details of the allocator.

trimCurrentThreadCache

public boolean trimCurrentThreadCache()

Trim thread local cache for the current Thread, which will give back any cached memory that was not allocated frequently since the last trim operation. Returns true if a cache for the current Thread exists and so was trimmed, false otherwise.

dumpStats

public String dumpStats()

Returns the status of the allocator (which contains all metrics) as string. Be aware this may be expensive and so should not called too frequently.