Package io.netty.buffer

Class AbstractByteBufAllocator

java.lang.Object

io.netty.buffer.AbstractByteBufAllocator

All Implemented Interfaces:

ByteBufAllocator

Direct Known Subclasses:

PooledByteBufAllocator, UnpooledByteBufAllocator

public abstract class AbstractByteBufAllocator
extends Object
implements ByteBufAllocator

Skeletal ByteBufAllocator implementation to extend.

Field Summary

Fields inherited from interface io.netty.buffer.ByteBufAllocator

DEFAULT

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractByteBufAllocator()	Instance use heap buffers by default
protected	AbstractByteBufAllocator(boolean preferDirect)	Create new instance

Method Summary

Modifier and Type	Method	Description
ByteBuf	buffer()	Allocate a ByteBuf.
ByteBuf	buffer(int initialCapacity)	Allocate a ByteBuf with the given initial capacity.
ByteBuf	buffer(int initialCapacity, int maxCapacity)	Allocate a ByteBuf with the given initial capacity and the given maximal capacity.
int	calculateNewCapacity(int minNewCapacity, int maxCapacity)	Calculate the new capacity of a ByteBuf that is used when a ByteBuf needs to expand by the minNewCapacity with maxCapacity as upper-bound.
CompositeByteBuf	compositeBuffer()	Allocate a CompositeByteBuf.
CompositeByteBuf	compositeBuffer(int maxNumComponents)	Allocate a CompositeByteBuf with the given maximum number of components that can be stored in it.
CompositeByteBuf	compositeDirectBuffer()	Allocate a direct CompositeByteBuf.
CompositeByteBuf	compositeDirectBuffer(int maxNumComponents)	Allocate a direct CompositeByteBuf with the given maximum number of components that can be stored in it.
CompositeByteBuf	compositeHeapBuffer()	Allocate a heap CompositeByteBuf.
CompositeByteBuf	compositeHeapBuffer(int maxNumComponents)	Allocate a heap CompositeByteBuf with the given maximum number of components that can be stored in it.
ByteBuf	directBuffer()	Allocate a direct ByteBuf.
ByteBuf	directBuffer(int initialCapacity)	Allocate a direct ByteBuf with the given initial capacity.
ByteBuf	directBuffer(int initialCapacity, int maxCapacity)	Allocate a direct ByteBuf with the given initial capacity and the given maximal capacity.
ByteBuf	heapBuffer()	Allocate a heap ByteBuf.
ByteBuf	heapBuffer(int initialCapacity)	Allocate a heap ByteBuf with the given initial capacity.
ByteBuf	heapBuffer(int initialCapacity, int maxCapacity)	Allocate a heap ByteBuf with the given initial capacity and the given maximal capacity.
ByteBuf	ioBuffer()	Allocate a ByteBuf, preferably a direct buffer which is suitable for I/O.
ByteBuf	ioBuffer(int initialCapacity)	Allocate a ByteBuf, preferably a direct buffer which is suitable for I/O.
ByteBuf	ioBuffer(int initialCapacity, int maxCapacity)	Allocate a ByteBuf, preferably a direct buffer which is suitable for I/O.
protected abstract ByteBuf	newDirectBuffer(int initialCapacity, int maxCapacity)	Create a direct ByteBuf with the given initialCapacity and maxCapacity.
protected abstract ByteBuf	newHeapBuffer(int initialCapacity, int maxCapacity)	Create a heap ByteBuf with the given initialCapacity and maxCapacity.
protected static ByteBuf	toLeakAwareBuffer(ByteBuf buf)
protected static CompositeByteBuf	toLeakAwareBuffer(CompositeByteBuf buf)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.buffer.ByteBufAllocator

isDirectBufferPooled

Constructor Details

AbstractByteBufAllocator

protected AbstractByteBufAllocator()

Instance use heap buffers by default

AbstractByteBufAllocator

protected AbstractByteBufAllocator(boolean preferDirect)

Create new instance

Parameters:

preferDirect - true if buffer(int) should try to allocate a direct buffer rather than a heap buffer

Method Details

toLeakAwareBuffer

protected static ByteBuf toLeakAwareBuffer(ByteBuf buf)

toLeakAwareBuffer

protected static CompositeByteBuf toLeakAwareBuffer(CompositeByteBuf buf)

buffer

public ByteBuf buffer()

Description copied from interface: ByteBufAllocator

Allocate a ByteBuf. If it is a direct or heap buffer depends on the actual implementation.

Specified by:

buffer in interface ByteBufAllocator

buffer

public ByteBuf buffer(int initialCapacity)

Description copied from interface: ByteBufAllocator

Allocate a ByteBuf with the given initial capacity. If it is a direct or heap buffer depends on the actual implementation.

Specified by:

buffer in interface ByteBufAllocator

buffer

public ByteBuf buffer(int initialCapacity,
 int maxCapacity)

Description copied from interface: ByteBufAllocator

Allocate a ByteBuf with the given initial capacity and the given maximal capacity. If it is a direct or heap buffer depends on the actual implementation.

Specified by:

buffer in interface ByteBufAllocator

ioBuffer

public ByteBuf ioBuffer()

Description copied from interface: ByteBufAllocator

Allocate a ByteBuf, preferably a direct buffer which is suitable for I/O.

Specified by:

ioBuffer in interface ByteBufAllocator

ioBuffer

public ByteBuf ioBuffer(int initialCapacity)

Description copied from interface: ByteBufAllocator

Allocate a ByteBuf, preferably a direct buffer which is suitable for I/O.

Specified by:

ioBuffer in interface ByteBufAllocator

ioBuffer

public ByteBuf ioBuffer(int initialCapacity,
 int maxCapacity)

Description copied from interface: ByteBufAllocator

Allocate a ByteBuf, preferably a direct buffer which is suitable for I/O.

Specified by:

ioBuffer in interface ByteBufAllocator

heapBuffer

public ByteBuf heapBuffer()

Description copied from interface: ByteBufAllocator

Allocate a heap ByteBuf.

Specified by:

heapBuffer in interface ByteBufAllocator

heapBuffer

public ByteBuf heapBuffer(int initialCapacity)

Description copied from interface: ByteBufAllocator

Allocate a heap ByteBuf with the given initial capacity.

Specified by:

heapBuffer in interface ByteBufAllocator

heapBuffer

public ByteBuf heapBuffer(int initialCapacity,
 int maxCapacity)

Description copied from interface: ByteBufAllocator

Allocate a heap ByteBuf with the given initial capacity and the given maximal capacity.

Specified by:

heapBuffer in interface ByteBufAllocator

directBuffer

public ByteBuf directBuffer()

Description copied from interface: ByteBufAllocator

Allocate a direct ByteBuf.

Specified by:

directBuffer in interface ByteBufAllocator

directBuffer

public ByteBuf directBuffer(int initialCapacity)

Description copied from interface: ByteBufAllocator

Allocate a direct ByteBuf with the given initial capacity.

Specified by:

directBuffer in interface ByteBufAllocator

directBuffer

public ByteBuf directBuffer(int initialCapacity,
 int maxCapacity)

Description copied from interface: ByteBufAllocator

Allocate a direct ByteBuf with the given initial capacity and the given maximal capacity.

Specified by:

directBuffer in interface ByteBufAllocator

compositeBuffer

public CompositeByteBuf compositeBuffer()

Description copied from interface: ByteBufAllocator

Allocate a CompositeByteBuf. If it is a direct or heap buffer depends on the actual implementation.

Specified by:

compositeBuffer in interface ByteBufAllocator

compositeBuffer

public CompositeByteBuf compositeBuffer(int maxNumComponents)

Description copied from interface: ByteBufAllocator

Allocate a CompositeByteBuf with the given maximum number of components that can be stored in it. If it is a direct or heap buffer depends on the actual implementation.

Specified by:

compositeBuffer in interface ByteBufAllocator

compositeHeapBuffer

public CompositeByteBuf compositeHeapBuffer()

Description copied from interface: ByteBufAllocator

Allocate a heap CompositeByteBuf.

Specified by:

compositeHeapBuffer in interface ByteBufAllocator

compositeHeapBuffer

public CompositeByteBuf compositeHeapBuffer(int maxNumComponents)

Description copied from interface: ByteBufAllocator

Allocate a heap CompositeByteBuf with the given maximum number of components that can be stored in it.

Specified by:

compositeHeapBuffer in interface ByteBufAllocator

compositeDirectBuffer

public CompositeByteBuf compositeDirectBuffer()

Description copied from interface: ByteBufAllocator

Allocate a direct CompositeByteBuf.

Specified by:

compositeDirectBuffer in interface ByteBufAllocator

compositeDirectBuffer

public CompositeByteBuf compositeDirectBuffer(int maxNumComponents)

Description copied from interface: ByteBufAllocator

Allocate a direct CompositeByteBuf with the given maximum number of components that can be stored in it.

Specified by:

compositeDirectBuffer in interface ByteBufAllocator

newHeapBuffer

protected abstract ByteBuf newHeapBuffer(int initialCapacity,
 int maxCapacity)

Create a heap ByteBuf with the given initialCapacity and maxCapacity.

newDirectBuffer

protected abstract ByteBuf newDirectBuffer(int initialCapacity,
 int maxCapacity)

Create a direct ByteBuf with the given initialCapacity and maxCapacity.

toString

public String toString()

Overrides:

toString in class Object

calculateNewCapacity

public int calculateNewCapacity(int minNewCapacity,
 int maxCapacity)

Description copied from interface: ByteBufAllocator

Calculate the new capacity of a ByteBuf that is used when a ByteBuf needs to expand by the minNewCapacity with maxCapacity as upper-bound.

Specified by:

calculateNewCapacity in interface ByteBufAllocator