Modifier and Type	Class and Description
private class	PooledByteBufAllocator.PoolThreadLocalCache

Modifier and Type	Field and Description
private static final int	CACHE_NOT_USED
private final int	chunkSize
public static final PooledByteBufAllocator	DEFAULT Hides io.netty.buffer.ByteBufAllocator.DEFAULT.
private static final int	DEFAULT_CACHE_TRIM_INTERVAL
private static final long	DEFAULT_CACHE_TRIM_INTERVAL_MILLIS
private static final int	DEFAULT_DIRECT_MEMORY_CACHE_ALIGNMENT
pack-priv static final int	DEFAULT_MAX_CACHED_BUFFER_CAPACITY
pack-priv static final int	DEFAULT_MAX_CACHED_BYTEBUFFERS_PER_CHUNK
private static final int	DEFAULT_MAX_ORDER
private static final int	DEFAULT_NORMAL_CACHE_SIZE
private static final int	DEFAULT_NUM_DIRECT_ARENA
private static final int	DEFAULT_NUM_HEAP_ARENA
private static final int	DEFAULT_PAGE_SIZE
private static final int	DEFAULT_SMALL_CACHE_SIZE
private static final boolean	DEFAULT_USE_CACHE_FOR_ALL_THREADS
private final List<PoolArenaMetric>	directArenaMetrics
private final PoolArena<ByteBuffer>[]	directArenas
private final List<PoolArenaMetric>	heapArenaMetrics
private final PoolArena<byte[]>[]	heapArenas
private static final InternalLogger	logger
private static final int	MAX_CHUNK_SIZE
private final PooledByteBufAllocatorMetric	metric
private static final int	MIN_PAGE_SIZE
private final int	normalCacheSize
private final int	smallCacheSize
private final PooledByteBufAllocator.PoolThreadLocalCache	threadCache
private final Runnable	trimTask

Access	Constructor and Description
public	PooledByteBufAllocator()
public	PooledByteBufAllocator(boolean preferDirect)
public	PooledByteBufAllocator(int nHeapArena, int nDirectArena, int pageSize, int maxOrder)
public	PooledByteBufAllocator(boolean preferDirect, int nHeapArena, int nDirectArena, int pageSize, int maxOrder) Deprecated use `PooledByteBufAllocator#PooledByteBufAllocator(boolean, int, int, int, int, int, int, boolean)`
public	PooledByteBufAllocator(boolean preferDirect, int nHeapArena, int nDirectArena, int pageSize, int maxOrder, int tinyCacheSize, int smallCacheSize, int normalCacheSize) Deprecated use `PooledByteBufAllocator#PooledByteBufAllocator(boolean, int, int, int, int, int, int, boolean)`
public	PooledByteBufAllocator(boolean preferDirect, int nHeapArena, int nDirectArena, int pageSize, int maxOrder, int tinyCacheSize, int smallCacheSize, int normalCacheSize, boolean useCacheForAllThreads) Deprecated use `PooledByteBufAllocator#PooledByteBufAllocator(boolean, int, int, int, int, int, int, boolean)`
public	PooledByteBufAllocator(boolean preferDirect, int nHeapArena, int nDirectArena, int pageSize, int maxOrder, int smallCacheSize, int normalCacheSize, boolean useCacheForAllThreads)
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#PooledByteBufAllocator(boolean, int, int, int, int, int, int, boolean, int)`
public	PooledByteBufAllocator(boolean preferDirect, int nHeapArena, int nDirectArena, int pageSize, int maxOrder, int smallCacheSize, int normalCacheSize, boolean useCacheForAllThreads, int directMemoryCacheAlignment)

Method Summary

Modifier and Type	Method and Description
public final int	chunkSize() Deprecated use `PooledByteBufAllocatorMetric#chunkSize()`. Return the chunk size for an arena.
public static int	defaultMaxOrder() Default maximum order - System Property: io.netty.allocator.maxOrder - default 9
public static int	defaultNormalCacheSize() Default normal cache size - System Property: io.netty.allocator.normalCacheSize - default 64
public static int	defaultNumDirectArena() Default number of direct arenas - System Property: io.netty.allocator.numDirectArenas - default 2 * cores
public static int	defaultNumHeapArena() Default number of heap arenas - System Property: io.netty.allocator.numHeapArenas - default 2 * cores
public static int	defaultPageSize() Default buffer page size - System Property: io.netty.allocator.pageSize - default 8192
public static boolean	defaultPreferDirect() Default prefer direct - System Property: io.netty.noPreferDirect - default false
public static int	defaultSmallCacheSize() Default small cache size - System Property: io.netty.allocator.smallCacheSize - default 256
public static int	defaultTinyCacheSize() Deprecated Tiny caches have been merged into small caches. Default tiny cache size - default 0
public static boolean	defaultUseCacheForAllThreads() Default thread caching behavior - System Property: io.netty.allocator.useCacheForAllThreads - default false
public List<PoolArenaMetric>	directArenas() Deprecated use `PooledByteBufAllocatorMetric#directArenas()`. Return a `List` of all direct `PoolArenaMetric`s that are provided by this pool.
public String	dumpStats() Returns the status of the allocator (which contains all metrics) as string.
public void	freeThreadLocalCache() Deprecated will be removed Free all cached buffers for the calling `Thread`.
public boolean	hasThreadLocalCache() Deprecated will be removed Returns `true` if the calling `Thread` has a `ThreadLocal` cache for the allocated buffers.
public List<PoolArenaMetric>	heapArenas() Deprecated use `PooledByteBufAllocatorMetric#heapArenas()`. Return a `List` of all heap `PoolArenaMetric`s that are provided by this pool.
public boolean	isDirectBufferPooled() Implements io.netty.buffer.ByteBufAllocator.isDirectBufferPooled. Returns `true` if direct `ByteBuf`'s are pooled
public static boolean	isDirectMemoryCacheAlignmentSupported() Return `true` if direct memory cache alignment is supported, `false` otherwise.
public PooledByteBufAllocatorMetric	metric() Implements io.netty.buffer.ByteBufAllocatorMetricProvider.metric. Returns a `ByteBufAllocatorMetric` for a `ByteBufAllocator`.
private static <T> PoolArena<T>[]	newArenaArray(int size)
protected ByteBuf	newDirectBuffer(int initialCapacity, int maxCapacity) Implements abstract io.netty.buffer.AbstractByteBufAllocator.newDirectBuffer. Create a direct `ByteBuf` with the given initialCapacity and maxCapacity.
protected ByteBuf	newHeapBuffer(int initialCapacity, int maxCapacity) Implements abstract io.netty.buffer.AbstractByteBufAllocator.newHeapBuffer. Create a heap `ByteBuf` with the given initialCapacity and maxCapacity.
public int	normalCacheSize() Deprecated use `PooledByteBufAllocatorMetric#normalCacheSize()`. Return the size of the normal cache.
public int	numDirectArenas() Deprecated use `PooledByteBufAllocatorMetric#numDirectArenas()`. Return the number of direct arenas.
public int	numHeapArenas() Deprecated use `PooledByteBufAllocatorMetric#numHeapArenas()`. Return the number of heap arenas.
public int	numThreadLocalCaches() Deprecated use `PooledByteBufAllocatorMetric#numThreadLocalCaches()`. Return the number of thread local caches used by this `PooledByteBufAllocator`.
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.
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.
private static long	pinnedMemory(PoolArena<?>[] arenas)
public int	smallCacheSize() Deprecated use `PooledByteBufAllocatorMetric#smallCacheSize()`. Return the size of the small cache.
pack-priv final PoolThreadCache	threadCache()
public int	tinyCacheSize() Deprecated use `PooledByteBufAllocatorMetric#tinyCacheSize()`. Return the size of the tiny cache.
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.
pack-priv final long	usedDirectMemory()
pack-priv final long	usedHeapMemory()
private static long	usedMemory(PoolArena<?>[] arenas)
private static int	validateAndCalculateChunkSize(int pageSize, int maxOrder)
private static int	validateAndCalculatePageShifts(int pageSize, int alignment)

Field Detail

CACHE_NOT_USED	back to summary
private static final int CACHE_NOT_USED

chunkSize	back to summary
private final int chunkSize

DEFAULT	back to summary
public static final PooledByteBufAllocator DEFAULT Hides io.netty.buffer.ByteBufAllocator.DEFAULT.

DEFAULT_CACHE_TRIM_INTERVAL	back to summary
private static final int DEFAULT_CACHE_TRIM_INTERVAL

DEFAULT_CACHE_TRIM_INTERVAL_MILLIS	back to summary
private static final long DEFAULT_CACHE_TRIM_INTERVAL_MILLIS

DEFAULT_DIRECT_MEMORY_CACHE_ALIGNMENT	back to summary
private static final int DEFAULT_DIRECT_MEMORY_CACHE_ALIGNMENT

DEFAULT_MAX_CACHED_BUFFER_CAPACITY	back to summary
pack-priv static final int DEFAULT_MAX_CACHED_BUFFER_CAPACITY

DEFAULT_MAX_CACHED_BYTEBUFFERS_PER_CHUNK	back to summary
pack-priv static final int DEFAULT_MAX_CACHED_BYTEBUFFERS_PER_CHUNK

DEFAULT_MAX_ORDER	back to summary
private static final int DEFAULT_MAX_ORDER

DEFAULT_NORMAL_CACHE_SIZE	back to summary
private static final int DEFAULT_NORMAL_CACHE_SIZE

DEFAULT_NUM_DIRECT_ARENA	back to summary
private static final int DEFAULT_NUM_DIRECT_ARENA

DEFAULT_NUM_HEAP_ARENA	back to summary
private static final int DEFAULT_NUM_HEAP_ARENA

DEFAULT_PAGE_SIZE	back to summary
private static final int DEFAULT_PAGE_SIZE

DEFAULT_SMALL_CACHE_SIZE	back to summary
private static final int DEFAULT_SMALL_CACHE_SIZE

DEFAULT_USE_CACHE_FOR_ALL_THREADS	back to summary
private static final boolean DEFAULT_USE_CACHE_FOR_ALL_THREADS

directArenaMetrics	back to summary
private final List<PoolArenaMetric> directArenaMetrics

directArenas	back to summary
private final PoolArena<ByteBuffer>[] directArenas

heapArenaMetrics	back to summary
private final List<PoolArenaMetric> heapArenaMetrics

heapArenas	back to summary
private final PoolArena<byte[]>[] heapArenas

logger	back to summary
private static final InternalLogger logger

MAX_CHUNK_SIZE	back to summary
private static final int MAX_CHUNK_SIZE

metric	back to summary
private final PooledByteBufAllocatorMetric metric

MIN_PAGE_SIZE	back to summary
private static final int MIN_PAGE_SIZE

normalCacheSize	back to summary
private final int normalCacheSize

smallCacheSize	back to summary
private final int smallCacheSize

threadCache	back to summary
private final PooledByteBufAllocator.PoolThreadLocalCache threadCache

trimTask	back to summary
private final Runnable trimTask

Constructor Detail

PooledByteBufAllocator	back to summary
public PooledByteBufAllocator()

PooledByteBufAllocator	back to summary
public PooledByteBufAllocator(boolean preferDirect) Annotations @SuppressWarnings:deprecation

PooledByteBufAllocator	back to summary
public PooledByteBufAllocator(int nHeapArena, int nDirectArena, int pageSize, int maxOrder) Annotations @SuppressWarnings:deprecation

PooledByteBufAllocator	back to summary
public PooledByteBufAllocator(boolean preferDirect, int nHeapArena, int nDirectArena, int pageSize, int maxOrder) Deprecated use `PooledByteBufAllocator#PooledByteBufAllocator(boolean, int, int, int, int, int, int, boolean)` Annotations @Deprecated

PooledByteBufAllocator	back to summary
public PooledByteBufAllocator(boolean preferDirect, int nHeapArena, int nDirectArena, int pageSize, int maxOrder, int tinyCacheSize, int smallCacheSize, int normalCacheSize) Deprecated use `PooledByteBufAllocator#PooledByteBufAllocator(boolean, int, int, int, int, int, int, boolean)` Annotations @Deprecated

PooledByteBufAllocator	back to summary
public PooledByteBufAllocator(boolean preferDirect, int nHeapArena, int nDirectArena, int pageSize, int maxOrder, int tinyCacheSize, int smallCacheSize, int normalCacheSize, boolean useCacheForAllThreads) Deprecated use `PooledByteBufAllocator#PooledByteBufAllocator(boolean, int, int, int, int, int, int, boolean)` Annotations @Deprecated

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

PooledByteBufAllocator	back to summary
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#PooledByteBufAllocator(boolean, int, int, int, int, int, int, boolean, int)` Annotations @Deprecated

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

Method Detail

chunkSize back to summary

chunkSize	back to summary
public final int chunkSize() Deprecated use `PooledByteBufAllocatorMetric#chunkSize()`. Return the chunk size for an arena. Annotations @Deprecated

public final int chunkSize()

Deprecated

use PooledByteBufAllocatorMetric#chunkSize().

Return the chunk size for an arena.

Annotations

@Deprecated

defaultMaxOrder	back to summary
public static int defaultMaxOrder() Default maximum order - System Property: io.netty.allocator.maxOrder - default 9

defaultNormalCacheSize	back to summary
public static int defaultNormalCacheSize() Default normal cache size - System Property: io.netty.allocator.normalCacheSize - default 64

defaultNumDirectArena	back to summary
public static int defaultNumDirectArena() Default number of direct arenas - System Property: io.netty.allocator.numDirectArenas - default 2 * cores

defaultNumHeapArena	back to summary
public static int defaultNumHeapArena() Default number of heap arenas - System Property: io.netty.allocator.numHeapArenas - default 2 * cores

defaultPageSize	back to summary
public static int defaultPageSize() Default buffer page size - System Property: io.netty.allocator.pageSize - default 8192

defaultPreferDirect	back to summary
public static boolean defaultPreferDirect() Default prefer direct - System Property: io.netty.noPreferDirect - default false

defaultSmallCacheSize	back to summary
public static int defaultSmallCacheSize() Default small cache size - System Property: io.netty.allocator.smallCacheSize - default 256

defaultTinyCacheSize	back to summary
public static int defaultTinyCacheSize() Deprecated Tiny caches have been merged into small caches. Default tiny cache size - default 0 Annotations @Deprecated

defaultTinyCacheSize

back to summary

public static int defaultTinyCacheSize()

Deprecated

Tiny caches have been merged into small caches.

Default tiny cache size - default 0

Annotations

@Deprecated

defaultUseCacheForAllThreads	back to summary
public static boolean defaultUseCacheForAllThreads() Default thread caching behavior - System Property: io.netty.allocator.useCacheForAllThreads - default false

directArenas back to summary

public List<PoolArenaMetric> directArenas()

Deprecated

use PooledByteBufAllocatorMetric#directArenas().

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

Annotations

@Deprecated

dumpStats	back to summary
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.

freeThreadLocalCache	back to summary
public void freeThreadLocalCache() Deprecated will be removed Free all cached buffers for the calling `Thread`. Annotations @Deprecated

hasThreadLocalCache	back to summary
public boolean hasThreadLocalCache() Deprecated will be removed Returns `true` if the calling `Thread` has a `ThreadLocal` cache for the allocated buffers. Annotations @Deprecated

heapArenas back to summary

public List<PoolArenaMetric> heapArenas()

Deprecated

use PooledByteBufAllocatorMetric#heapArenas().

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

Annotations

@Deprecated

isDirectBufferPooled back to summary

public boolean isDirectBufferPooled()

Implements io.netty.buffer.ByteBufAllocator.isDirectBufferPooled.

Doc from io.netty.buffer.ByteBufAllocator.isDirectBufferPooled.

Returns true if direct ByteBuf's are pooled

Annotations

@Override

isDirectMemoryCacheAlignmentSupported	back to summary
public static boolean isDirectMemoryCacheAlignmentSupported() Return `true` if direct memory cache alignment is supported, `false` otherwise.

metric back to summary

public PooledByteBufAllocatorMetric metric()

Implements io.netty.buffer.ByteBufAllocatorMetricProvider.metric.

Doc from io.netty.buffer.ByteBufAllocatorMetricProvider.metric.

Returns a ByteBufAllocatorMetric for a ByteBufAllocator.

Annotations

@Override

newArenaArray	back to summary
private static <T> PoolArena<T>[] newArenaArray(int size) Annotations @SuppressWarnings:unchecked

newDirectBuffer back to summary

protected ByteBuf newDirectBuffer(int initialCapacity, int maxCapacity)

Implements abstract io.netty.buffer.AbstractByteBufAllocator.newDirectBuffer.

Doc from io.netty.buffer.AbstractByteBufAllocator.newDirectBuffer.

Create a direct ByteBuf with the given initialCapacity and maxCapacity.

Annotations

@Override

newHeapBuffer back to summary

protected ByteBuf newHeapBuffer(int initialCapacity, int maxCapacity)

Implements abstract io.netty.buffer.AbstractByteBufAllocator.newHeapBuffer.

Doc from io.netty.buffer.AbstractByteBufAllocator.newHeapBuffer.

Create a heap ByteBuf with the given initialCapacity and maxCapacity.

Annotations

@Override

normalCacheSize back to summary

public int normalCacheSize()

Deprecated

use PooledByteBufAllocatorMetric#normalCacheSize().

Return the size of the normal cache.

Annotations

@Deprecated

numDirectArenas back to summary

public int numDirectArenas()

Deprecated

use PooledByteBufAllocatorMetric#numDirectArenas().

Return the number of direct arenas.

Annotations

@Deprecated

numHeapArenas back to summary

public int numHeapArenas()

Deprecated

use PooledByteBufAllocatorMetric#numHeapArenas().

Return the number of heap arenas.

Annotations

@Deprecated

numThreadLocalCaches back to summary

public int numThreadLocalCaches()

Deprecated

use PooledByteBufAllocatorMetric#numThreadLocalCaches().

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

Annotations

@Deprecated

pinnedDirectMemory	back to summary
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.

pinnedHeapMemory	back to summary
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.

pinnedMemory	back to summary
private static long pinnedMemory(PoolArena<?>[] arenas)

smallCacheSize back to summary

public int smallCacheSize()

Deprecated

use PooledByteBufAllocatorMetric#smallCacheSize().

Return the size of the small cache.

Annotations

@Deprecated

threadCache	back to summary
pack-priv final PoolThreadCache threadCache()

tinyCacheSize back to summary

public int tinyCacheSize()

Deprecated

use PooledByteBufAllocatorMetric#tinyCacheSize().

Return the size of the tiny cache.

Annotations

@Deprecated

trimCurrentThreadCache	back to summary
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.

usedDirectMemory	back to summary
pack-priv final long usedDirectMemory()

usedHeapMemory	back to summary
pack-priv final long usedHeapMemory()

usedMemory	back to summary
private static long usedMemory(PoolArena<?>[] arenas)

validateAndCalculateChunkSize	back to summary
private static int validateAndCalculateChunkSize(int pageSize, int maxOrder)

validateAndCalculatePageShifts	back to summary
private static int validateAndCalculatePageShifts(int pageSize, int alignment)

io.netty.buffer back to summary

private final Class PooledByteBufAllocator.PoolThreadLocalCache

Class Inheritance

extends FastThreadLocal<PoolThreadCache>

java.lang.Object
io.netty.util.concurrent.FastThreadLocal
io.netty.buffer.PooledByteBufAllocator.PoolThreadLocalCache

Field Summary

Modifier and Type	Field and Description
private final boolean	useCacheForAllThreads

Constructor Summary

Access	Constructor and Description
pack-priv	PoolThreadLocalCache(boolean useCacheForAllThreads)

Method Summary

Modifier and Type	Method and Description
protected synchronized PoolThreadCache	initialValue() Overrides io.netty.util.concurrent.FastThreadLocal.initialValue. Returns the initial value for this thread-local variable.
private <T> PoolArena<T>	leastUsedArena(PoolArena<T>[] arenas)
protected void	onRemoval(PoolThreadCache threadCache) Overrides io.netty.util.concurrent.FastThreadLocal.onRemoval. Invoked when this thread local variable is removed by `remove()`.

Inherited from io.netty.util.concurrent.FastThreadLocal:: destroy get get getIfExists isSet isSet remove remove removeAll set set size

Field Detail

useCacheForAllThreads	back to summary
private final boolean useCacheForAllThreads

Constructor Detail

PoolThreadLocalCache	back to summary
pack-priv PoolThreadLocalCache(boolean useCacheForAllThreads)

Method Detail

initialValue

back to summary

protected synchronized PoolThreadCache initialValue()

Overrides io.netty.util.concurrent.FastThreadLocal.initialValue.

Doc from io.netty.util.concurrent.FastThreadLocal.initialValue.

Returns the initial value for this thread-local variable.

Annotations

@Override

leastUsedArena	back to summary
private <T> PoolArena<T> leastUsedArena(PoolArena<T>[] arenas)

onRemoval back to summary

protected void onRemoval(PoolThreadCache threadCache)

Overrides io.netty.util.concurrent.FastThreadLocal.onRemoval.

Doc from io.netty.util.concurrent.FastThreadLocal.onRemoval.

Invoked when this thread local variable is removed by remove(). Be aware that remove() is not guaranteed to be called when the `Thread` completes which means you can not depend on this for cleanup of the resources in the case of `Thread` completion.

Annotations

@Override

public Class PooledByteBufAllocator

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Class PooledByteBufAllocator.PoolThreadLocalCache

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail