PooledByteBufAllocator (Netty 4.1.109.Final API文档

java.lang.Object
- io.netty.buffer.AbstractByteBufAllocator
- - io.netty.buffer.PooledByteBufAllocator

所有已实现的接口:: ByteBufAllocator, ByteBufAllocatorMetricProvider

public class PooledByteBufAllocator
extends AbstractByteBufAllocator
implements ByteBufAllocatorMetricProvider

字段概要

字段
限定符和类型字段和说明

static PooledByteBufAllocator DEFAULT

字段
限定符和类型	字段和说明
`static PooledByteBufAllocator`	`DEFAULT`

构造器概要

构造器
构造器和说明
`PooledByteBufAllocator()`
`PooledByteBufAllocator(boolean preferDirect)`
`PooledByteBufAllocator(boolean preferDirect, int nHeapArena, int nDirectArena, int pageSize, int maxOrder)` 已过时。 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)` 已过时。 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)` 已过时。 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)` 已过时。 use `PooledByteBufAllocator(boolean, int, int, int, int, int, int, boolean, int)`
`PooledByteBufAllocator(int nHeapArena, int nDirectArena, int pageSize, int maxOrder)`

方法概要

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
限定符和类型	方法和说明
`int`	`chunkSize()` 已过时。 use `PooledByteBufAllocatorMetric.chunkSize()`.
`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()` 已过时。 Tiny caches have been merged into small caches.
`static boolean`	`defaultUseCacheForAllThreads()` Default thread caching behavior - System Property: io.netty.allocator.useCacheForAllThreads - default false
`java.util.List<PoolArenaMetric>`	`directArenas()` 已过时。 use `PooledByteBufAllocatorMetric.directArenas()`.
`java.lang.String`	`dumpStats()` Returns the status of the allocator (which contains all metrics) as string.
`void`	`freeThreadLocalCache()` 已过时。 will be removed Free all cached buffers for the calling `Thread`.
`boolean`	`hasThreadLocalCache()` 已过时。 will be removed Returns `true` if the calling `Thread` has a `ThreadLocal` cache for the allocated buffers.
`java.util.List<PoolArenaMetric>`	`heapArenas()` 已过时。 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()` 已过时。 use `PooledByteBufAllocatorMetric.normalCacheSize()`.
`int`	`numDirectArenas()` 已过时。 use `PooledByteBufAllocatorMetric.numDirectArenas()`.
`int`	`numHeapArenas()` 已过时。 use `PooledByteBufAllocatorMetric.numHeapArenas()`.
`int`	`numThreadLocalCaches()` 已过时。 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()` 已过时。 use `PooledByteBufAllocatorMetric.smallCacheSize()`.
`int`	`tinyCacheSize()` 已过时。 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.

从类继承的方法 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

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - DEFAULT
```
public static final PooledByteBufAllocator DEFAULT
```
- 构造器详细资料
  - 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)
```
    已过时。 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)
```
    已过时。 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)
```
    已过时。 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)
```
    已过时。 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)
```
- 方法详细资料
  - newHeapBuffer
```
protected ByteBuf newHeapBuffer(int initialCapacity,
                                int maxCapacity)
```
    从类复制的说明: AbstractByteBufAllocator
    
    Create a heap ByteBuf with the given initialCapacity and maxCapacity.
    
    指定者:
    
    newHeapBuffer 在类中 AbstractByteBufAllocator
  - newDirectBuffer
```
protected ByteBuf newDirectBuffer(int initialCapacity,
                                  int maxCapacity)
```
    从类复制的说明: AbstractByteBufAllocator
    
    Create a direct ByteBuf with the given initialCapacity and maxCapacity.
    
    指定者:
    
    newDirectBuffer 在类中 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
  - 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()
```
    已过时。 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()
```
    从接口复制的说明: ByteBufAllocator
    
    Returns true if direct ByteBuf's are pooled
    
    指定者:
    
    isDirectBufferPooled 在接口中 ByteBufAllocator
  - hasThreadLocalCache
```
@Deprecated
public boolean hasThreadLocalCache()
```
    已过时。 will be removed Returns true if the calling Thread has a ThreadLocal cache for the allocated buffers.
  - freeThreadLocalCache
```
@Deprecated
public void freeThreadLocalCache()
```
    已过时。 will be removed Free all cached buffers for the calling Thread.
  - metric
```
public PooledByteBufAllocatorMetric metric()
```
    从接口复制的说明: ByteBufAllocatorMetricProvider
    
    Returns a ByteBufAllocatorMetric for a ByteBufAllocator.
    
    指定者:
    
    metric 在接口中 ByteBufAllocatorMetricProvider
  - numHeapArenas
```
@Deprecated
public int numHeapArenas()
```
    已过时。 use PooledByteBufAllocatorMetric.numHeapArenas().
    
    Return the number of heap arenas.
  - numDirectArenas
```
@Deprecated
public int numDirectArenas()
```
    已过时。 use PooledByteBufAllocatorMetric.numDirectArenas().
    
    Return the number of direct arenas.
  - heapArenas
```
@Deprecated
public java.util.List<PoolArenaMetric> heapArenas()
```
    已过时。 use PooledByteBufAllocatorMetric.heapArenas().
    
    Return a List of all heap PoolArenaMetrics that are provided by this pool.
  - directArenas
```
@Deprecated
public java.util.List<PoolArenaMetric> directArenas()
```
    已过时。 use PooledByteBufAllocatorMetric.directArenas().
    
    Return a List of all direct PoolArenaMetrics that are provided by this pool.
  - numThreadLocalCaches
```
@Deprecated
public int numThreadLocalCaches()
```
    已过时。 use PooledByteBufAllocatorMetric.numThreadLocalCaches().
    
    Return the number of thread local caches used by this PooledByteBufAllocator.
  - tinyCacheSize
```
@Deprecated
public int tinyCacheSize()
```
    已过时。 use PooledByteBufAllocatorMetric.tinyCacheSize().
    
    Return the size of the tiny cache.
  - smallCacheSize
```
@Deprecated
public int smallCacheSize()
```
    已过时。 use PooledByteBufAllocatorMetric.smallCacheSize().
    
    Return the size of the small cache.
  - normalCacheSize
```
@Deprecated
public int normalCacheSize()
```
    已过时。 use PooledByteBufAllocatorMetric.normalCacheSize().
    
    Return the size of the normal cache.
  - chunkSize
```
@Deprecated
public final int chunkSize()
```
    已过时。 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 java.lang.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.

类 PooledByteBufAllocator

字段概要

构造器概要

方法概要

从类继承的方法 io.netty.buffer.AbstractByteBufAllocator

从类继承的方法 java.lang.Object

字段详细资料

DEFAULT

构造器详细资料

PooledByteBufAllocator

PooledByteBufAllocator

PooledByteBufAllocator

PooledByteBufAllocator

PooledByteBufAllocator

PooledByteBufAllocator

PooledByteBufAllocator

PooledByteBufAllocator

PooledByteBufAllocator

方法详细资料

newHeapBuffer

newDirectBuffer

defaultNumHeapArena

defaultNumDirectArena

defaultPageSize

defaultMaxOrder

defaultUseCacheForAllThreads

defaultPreferDirect

defaultTinyCacheSize

defaultSmallCacheSize

defaultNormalCacheSize

isDirectMemoryCacheAlignmentSupported

isDirectBufferPooled

hasThreadLocalCache

freeThreadLocalCache

metric

numHeapArenas

numDirectArenas

heapArenas

directArenas

numThreadLocalCaches

tinyCacheSize

smallCacheSize

normalCacheSize

chunkSize

pinnedHeapMemory

pinnedDirectMemory

trimCurrentThreadCache

dumpStats