Module io.netty5.transport

Package io.netty5.channel

Interface MaxBytesRecvBufferAllocator

All Superinterfaces:

RecvBufferAllocator

All Known Implementing Classes:

DefaultMaxBytesRecvBufferAllocator

public interface MaxBytesRecvBufferAllocator
extends RecvBufferAllocator

RecvBufferAllocator that limits a read operation based upon a maximum value per individual read and a maximum amount when a read operation is attempted by the event loop.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty5.channel.RecvBufferAllocator

RecvBufferAllocator.Handle

Method Summary

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

Methods inherited from interface io.netty5.channel.RecvBufferAllocator

newHandle

Method Detail

maxBytesPerRead

int maxBytesPerRead()

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.

maxBytesPerRead

MaxBytesRecvBufferAllocator maxBytesPerRead(int maxBytesPerRead)

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.

maxBytesPerIndividualRead

int maxBytesPerIndividualRead()

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.

maxBytesPerIndividualRead

MaxBytesRecvBufferAllocator maxBytesPerIndividualRead(int maxBytesPerIndividualRead)

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.

maxBytesPerReadPair

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. If this value is greater than 1, an event loop might attempt to read multiple times to procure bytes.

Returns:

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

maxBytesPerReadPair

MaxBytesRecvBufferAllocator maxBytesPerReadPair(int maxBytesPerRead,
                                                int maxBytesPerIndividualRead)

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.

Parameters:

maxBytesPerRead - see maxBytesPerRead(int)

maxBytesPerIndividualRead - see maxBytesPerIndividualRead(int)