Package io.netty.util

Class Recycler<T>

java.lang.Object

io.netty.util.Recycler<T>

Type Parameters:

T - the type of the pooled object

Direct Known Subclasses:

AdaptivePoolingAllocator.Magazine.AdaptiveRecycler

public abstract class Recycler<T>
extends Object

Light-weight object pool based on a thread-local stack.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	Recycler.BlockingMessageQueue<T>	This is an implementation of MessagePassingQueue, similar to what might be returned from PlatformDependent.newMpscQueue(int), but intended to be used for debugging purpose.
private static final class	Recycler.DefaultHandle<T>
static class	Recycler.EnhancedHandle<T>
static interface	Recycler.Handle<T>
private static final class	Recycler.LocalPool<T>

Field Summary

Fields

Modifier and Type	Field	Description
private static final boolean	BATCH_FAST_TL_ONLY
private static final boolean	BLOCKING_POOL
private final int	chunkSize
private static final int	DEFAULT_INITIAL_MAX_CAPACITY_PER_THREAD
private static final int	DEFAULT_MAX_CAPACITY_PER_THREAD
private static final int	DEFAULT_QUEUE_CHUNK_SIZE_PER_THREAD
private final int	interval
private static final InternalLogger	logger
private final int	maxCapacityPerThread
private static final Recycler.EnhancedHandle<?>	NOOP_HANDLE
private static final int	RATIO
private final FastThreadLocal<Recycler.LocalPool<T>>	threadLocal

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Recycler()
protected	Recycler(int maxCapacityPerThread)
protected	Recycler(int maxCapacityPerThread, int maxSharedCapacityFactor)	Deprecated. Use one of the following instead: Recycler(), Recycler(int), Recycler(int, int, int).
protected	Recycler(int maxCapacityPerThread, int ratio, int chunkSize)
protected	Recycler(int maxCapacityPerThread, int maxSharedCapacityFactor, int ratio, int maxDelayedQueuesPerThread)	Deprecated. Use one of the following instead: Recycler(), Recycler(int), Recycler(int, int, int).
protected	Recycler(int maxCapacityPerThread, int maxSharedCapacityFactor, int ratio, int maxDelayedQueuesPerThread, int delayedQueueRatio)	Deprecated. Use one of the following instead: Recycler(), Recycler(int), Recycler(int, int, int).

Method Summary

Modifier and Type	Method	Description
final T	get()
protected abstract T	newObject(Recycler.Handle<T> handle)
final boolean	recycle(T o, Recycler.Handle<T> handle)	Deprecated. use ObjectPool.Handle.recycle(Object).
(package private) final int	threadLocalSize()

Methods inherited from class java.lang.Object

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

Field Details

logger

private static final InternalLogger logger

NOOP_HANDLE

private static final Recycler.EnhancedHandle<?> NOOP_HANDLE

DEFAULT_INITIAL_MAX_CAPACITY_PER_THREAD

private static final int DEFAULT_INITIAL_MAX_CAPACITY_PER_THREAD

See Also:

• Constant Field Values

DEFAULT_MAX_CAPACITY_PER_THREAD

private static final int DEFAULT_MAX_CAPACITY_PER_THREAD

RATIO

private static final int RATIO

DEFAULT_QUEUE_CHUNK_SIZE_PER_THREAD

private static final int DEFAULT_QUEUE_CHUNK_SIZE_PER_THREAD

BLOCKING_POOL

private static final boolean BLOCKING_POOL

BATCH_FAST_TL_ONLY

private static final boolean BATCH_FAST_TL_ONLY

maxCapacityPerThread

private final int maxCapacityPerThread

interval

private final int interval

chunkSize

private final int chunkSize

threadLocal

private final FastThreadLocal<Recycler.LocalPool<T>> threadLocal

Constructor Details

Recycler

protected Recycler()

Recycler

protected Recycler(int maxCapacityPerThread)

Recycler

@Deprecated
protected Recycler(int maxCapacityPerThread,
 int maxSharedCapacityFactor)

Deprecated.

Use one of the following instead: Recycler(), Recycler(int), Recycler(int, int, int).

Recycler

@Deprecated
protected Recycler(int maxCapacityPerThread,
 int maxSharedCapacityFactor,
 int ratio,
 int maxDelayedQueuesPerThread)

Deprecated.

Use one of the following instead: Recycler(), Recycler(int), Recycler(int, int, int).

Recycler

@Deprecated
protected Recycler(int maxCapacityPerThread,
 int maxSharedCapacityFactor,
 int ratio,
 int maxDelayedQueuesPerThread,
 int delayedQueueRatio)

Deprecated.

Use one of the following instead: Recycler(), Recycler(int), Recycler(int, int, int).

Recycler

protected Recycler(int maxCapacityPerThread,
 int ratio,
 int chunkSize)

Method Details

get

public final T get()

recycle

@Deprecated
public final boolean recycle(T o,
 Recycler.Handle<T> handle)

Deprecated.

use ObjectPool.Handle.recycle(Object).

threadLocalSize

final int threadLocalSize()

newObject

protected abstract T newObject(Recycler.Handle<T> handle)

Parameters:

handle - can NOT be null.