Module io.netty5.transport

Package io.netty5.channel

Class DefaultMaxBytesRecvBufferAllocator

java.lang.Object

io.netty5.channel.DefaultMaxBytesRecvBufferAllocator

All Implemented Interfaces:

MaxBytesRecvBufferAllocator, RecvBufferAllocator

public class DefaultMaxBytesRecvBufferAllocator
extends Object
implements MaxBytesRecvBufferAllocator

The RecvBufferAllocator 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.netty5.channel.RecvBufferAllocator

RecvBufferAllocator.Handle

Constructor Summary

Constructors

Constructor	Description
DefaultMaxBytesRecvBufferAllocator()
DefaultMaxBytesRecvBufferAllocator(int maxBytesPerRead, int maxBytesPerIndividualRead)

Method Summary

Modifier and Type	Method	Description
int	maxBytesPerIndividualRead()	Returns the maximum number of bytes to read per individual read operation.
DefaultMaxBytesRecvBufferAllocator	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.
DefaultMaxBytesRecvBufferAllocator	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.
DefaultMaxBytesRecvBufferAllocator	maxBytesPerReadPair(int maxBytesPerRead, int maxBytesPerIndividualRead)	Sets the maximum number of bytes to read for a read loop and per individual read operation.
RecvBufferAllocator.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

DefaultMaxBytesRecvBufferAllocator

public DefaultMaxBytesRecvBufferAllocator()

DefaultMaxBytesRecvBufferAllocator

public DefaultMaxBytesRecvBufferAllocator(int maxBytesPerRead,
                                          int maxBytesPerIndividualRead)

Method Detail

newHandle

public RecvBufferAllocator.Handle newHandle()

Description copied from interface: RecvBufferAllocator

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 RecvBufferAllocator

maxBytesPerRead

public int maxBytesPerRead()

Description copied from interface: MaxBytesRecvBufferAllocator

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 MaxBytesRecvBufferAllocator

maxBytesPerRead

public DefaultMaxBytesRecvBufferAllocator maxBytesPerRead(int maxBytesPerRead)

Description copied from interface: MaxBytesRecvBufferAllocator

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 MaxBytesRecvBufferAllocator

maxBytesPerIndividualRead

public int maxBytesPerIndividualRead()

Description copied from interface: MaxBytesRecvBufferAllocator

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 MaxBytesRecvBufferAllocator

maxBytesPerIndividualRead

public DefaultMaxBytesRecvBufferAllocator maxBytesPerIndividualRead(int maxBytesPerIndividualRead)

Description copied from interface: MaxBytesRecvBufferAllocator

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 MaxBytesRecvBufferAllocator

maxBytesPerReadPair

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

Description copied from interface: MaxBytesRecvBufferAllocator

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 MaxBytesRecvBufferAllocator

Returns:

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

maxBytesPerReadPair

public DefaultMaxBytesRecvBufferAllocator maxBytesPerReadPair(int maxBytesPerRead,
                                                              int maxBytesPerIndividualRead)

Description copied from interface: MaxBytesRecvBufferAllocator

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 MaxBytesRecvBufferAllocator

Parameters:

maxBytesPerRead - see MaxBytesRecvBufferAllocator.maxBytesPerRead(int)

maxBytesPerIndividualRead - see MaxBytesRecvBufferAllocator.maxBytesPerIndividualRead(int)