io.netty.channel

Class DefaultMaxBytesRecvByteBufAllocator

java.lang.Object

io.netty.channel.DefaultMaxBytesRecvByteBufAllocator

All Implemented Interfaces:

MaxBytesRecvByteBufAllocator, RecvByteBufAllocator

public class DefaultMaxBytesRecvByteBufAllocator
extends Object
implements MaxBytesRecvByteBufAllocator

The RecvByteBufAllocator that yields a buffer size prediction based upon decrementing the value from the max bytes per read.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.RecvByteBufAllocator

RecvByteBufAllocator.DelegatingHandle, RecvByteBufAllocator.ExtendedHandle, RecvByteBufAllocator.Handle

Constructor Summary

Constructors

Constructor and Description
DefaultMaxBytesRecvByteBufAllocator()
DefaultMaxBytesRecvByteBufAllocator(int maxBytesPerRead, int maxBytesPerIndividualRead)

Method Summary

Modifier and Type	Method and Description
int	maxBytesPerIndividualRead() Returns the maximum number of bytes to read per individual read operation.
DefaultMaxBytesRecvByteBufAllocator	maxBytesPerIndividualRead(int maxBytesPerIndividualRead) Sets the maximum number of bytes to read per individual read operation.
int	maxBytesPerRead() Returns the maximum number of bytes to read per read loop.
DefaultMaxBytesRecvByteBufAllocator	maxBytesPerRead(int maxBytesPerRead) Sets the maximum number of bytes to read per read loop.
Map.Entry<Integer,Integer>	maxBytesPerReadPair() Atomic way to get the maximum number of bytes to read for a read loop and per individual read operation.
DefaultMaxBytesRecvByteBufAllocator	maxBytesPerReadPair(int maxBytesPerRead, int maxBytesPerIndividualRead) Sets the maximum number of bytes to read for a read loop and per individual read operation.
RecvByteBufAllocator.Handle	newHandle() Creates a new handle.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultMaxBytesRecvByteBufAllocator

public DefaultMaxBytesRecvByteBufAllocator()

DefaultMaxBytesRecvByteBufAllocator

public DefaultMaxBytesRecvByteBufAllocator(int maxBytesPerRead,
                                           int maxBytesPerIndividualRead)

Method Detail

newHandle

public RecvByteBufAllocator.Handle newHandle()

Description copied from interface: RecvByteBufAllocator

Creates a new handle. The handle provides the actual operations and keeps the internal information which is required for predicting an optimal buffer capacity.

Specified by:

newHandle in interface RecvByteBufAllocator

maxBytesPerRead

public int maxBytesPerRead()

Description copied from interface: MaxBytesRecvByteBufAllocator

Returns the maximum number of bytes to read per read loop. a channelRead() event. If this value is greater than 1, an event loop might attempt to read multiple times to procure bytes.

Specified by:

maxBytesPerRead in interface MaxBytesRecvByteBufAllocator

maxBytesPerRead

public DefaultMaxBytesRecvByteBufAllocator maxBytesPerRead(int maxBytesPerRead)

Description copied from interface: MaxBytesRecvByteBufAllocator

Sets the maximum number of bytes to read per read loop. If this value is greater than 1, an event loop might attempt to read multiple times to procure bytes.

Specified by:

maxBytesPerRead in interface MaxBytesRecvByteBufAllocator

maxBytesPerIndividualRead

public int maxBytesPerIndividualRead()

Description copied from interface: MaxBytesRecvByteBufAllocator

Returns the maximum number of bytes to read per individual read operation. a channelRead() event. If this value is greater than 1, an event loop might attempt to read multiple times to procure bytes.

Specified by:

maxBytesPerIndividualRead in interface MaxBytesRecvByteBufAllocator

maxBytesPerIndividualRead

public DefaultMaxBytesRecvByteBufAllocator maxBytesPerIndividualRead(int maxBytesPerIndividualRead)

Description copied from interface: MaxBytesRecvByteBufAllocator

Sets the maximum number of bytes to read per individual read operation. If this value is greater than 1, an event loop might attempt to read multiple times to procure bytes.

Specified by:

maxBytesPerIndividualRead in interface MaxBytesRecvByteBufAllocator

maxBytesPerReadPair

public Map.Entry<Integer,Integer> maxBytesPerReadPair()

Description copied from interface: MaxBytesRecvByteBufAllocator

Atomic way to get the maximum number of bytes to read for a read loop and per individual read operation. If this value is greater than 1, an event loop might attempt to read multiple times to procure bytes.

Specified by:

maxBytesPerReadPair in interface MaxBytesRecvByteBufAllocator

Returns:

The Key is from MaxBytesRecvByteBufAllocator.maxBytesPerRead(). The Value is from MaxBytesRecvByteBufAllocator.maxBytesPerIndividualRead()

maxBytesPerReadPair

public DefaultMaxBytesRecvByteBufAllocator maxBytesPerReadPair(int maxBytesPerRead,
                                                               int maxBytesPerIndividualRead)

Description copied from interface: MaxBytesRecvByteBufAllocator

Sets the maximum number of bytes to read for a read loop and per individual read operation. If this value is greater than 1, an event loop might attempt to read multiple times to procure bytes.

Specified by:

maxBytesPerReadPair in interface MaxBytesRecvByteBufAllocator

Parameters:

maxBytesPerRead - see MaxBytesRecvByteBufAllocator.maxBytesPerRead(int)

maxBytesPerIndividualRead - see MaxBytesRecvByteBufAllocator.maxBytesPerIndividualRead(int)