Class DefaultMaxMessagesRecvByteBufAllocator.MaxMessageHandle

java.lang.Object

io.netty.channel.DefaultMaxMessagesRecvByteBufAllocator.MaxMessageHandle

All Implemented Interfaces:

RecvByteBufAllocator.ExtendedHandle, RecvByteBufAllocator.Handle

Enclosing class:

DefaultMaxMessagesRecvByteBufAllocator

public abstract class DefaultMaxMessagesRecvByteBufAllocator.MaxMessageHandle
extends Object
implements RecvByteBufAllocator.ExtendedHandle

Focuses on enforcing the maximum messages per read condition for continueReading().

Constructor Summary

Constructors

Constructor	Description
MaxMessageHandle()

Method Summary

Modifier and Type	Method	Description
ByteBuf	allocate(ByteBufAllocator alloc)	Creates a new receive buffer whose capacity is probably large enough to read all inbound data and small enough not to waste its space.
int	attemptedBytesRead()	Get how many bytes the read operation will (or did) attempt to read.
void	attemptedBytesRead(int bytes)	Set how many bytes the read operation will (or did) attempt to read.
boolean	continueReading()	Determine if the current read loop should continue.
boolean	continueReading(UncheckedBooleanSupplier maybeMoreDataSupplier)	Same as RecvByteBufAllocator.Handle.continueReading() except "more data" is determined by the supplier parameter.
final void	incMessagesRead(int amt)	Increment the number of messages that have been read for the current read loop.
final int	lastBytesRead()	Get the amount of bytes for the previous read operation.
void	lastBytesRead(int bytes)	Set the bytes that have been read for the last read operation.
void	readComplete()	The read has completed.
void	reset(ChannelConfig config)	Only ChannelConfig.getMaxMessagesPerRead() is used.
protected final int	totalBytesRead()

Methods inherited from class Object

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

Methods inherited from interface RecvByteBufAllocator.Handle

guess

Constructor Details

MaxMessageHandle

public MaxMessageHandle()

Method Details

reset

public void reset(ChannelConfig config)

Only ChannelConfig.getMaxMessagesPerRead() is used.

Specified by:

reset in interface RecvByteBufAllocator.Handle

Parameters:

config - The channel configuration which may impact this object's behavior.

allocate

public ByteBuf allocate(ByteBufAllocator alloc)

Description copied from interface: RecvByteBufAllocator.Handle

Creates a new receive buffer whose capacity is probably large enough to read all inbound data and small enough not to waste its space.

Specified by:

allocate in interface RecvByteBufAllocator.Handle

incMessagesRead

public final void incMessagesRead(int amt)

Description copied from interface: RecvByteBufAllocator.Handle

Increment the number of messages that have been read for the current read loop.

Specified by:

incMessagesRead in interface RecvByteBufAllocator.Handle

Parameters:

amt - The amount to increment by.

lastBytesRead

public void lastBytesRead(int bytes)

Description copied from interface: RecvByteBufAllocator.Handle

Set the bytes that have been read for the last read operation. This may be used to increment the number of bytes that have been read.

Specified by:

lastBytesRead in interface RecvByteBufAllocator.Handle

Parameters:

bytes - The number of bytes from the previous read operation. This may be negative if an read error occurs. If a negative value is seen it is expected to be return on the next call to RecvByteBufAllocator.Handle.lastBytesRead(). A negative value will signal a termination condition enforced externally to this class and is not required to be enforced in RecvByteBufAllocator.Handle.continueReading().

lastBytesRead

public final int lastBytesRead()

Description copied from interface: RecvByteBufAllocator.Handle

Get the amount of bytes for the previous read operation.

Specified by:

lastBytesRead in interface RecvByteBufAllocator.Handle

Returns:

The amount of bytes for the previous read operation.

continueReading

public boolean continueReading()

Description copied from interface: RecvByteBufAllocator.Handle

Determine if the current read loop should continue.

Specified by:

continueReading in interface RecvByteBufAllocator.Handle

Returns:

true if the read loop should continue reading. false if the read loop is complete.

continueReading

public boolean continueReading(UncheckedBooleanSupplier maybeMoreDataSupplier)

Description copied from interface: RecvByteBufAllocator.ExtendedHandle

Same as RecvByteBufAllocator.Handle.continueReading() except "more data" is determined by the supplier parameter.

Specified by:

continueReading in interface RecvByteBufAllocator.ExtendedHandle

Parameters:

maybeMoreDataSupplier - A supplier that determines if there maybe more data to read.

readComplete

public void readComplete()

Description copied from interface: RecvByteBufAllocator.Handle

The read has completed.

Specified by:

readComplete in interface RecvByteBufAllocator.Handle

attemptedBytesRead

public int attemptedBytesRead()

Description copied from interface: RecvByteBufAllocator.Handle

Get how many bytes the read operation will (or did) attempt to read.

Specified by:

attemptedBytesRead in interface RecvByteBufAllocator.Handle

Returns:

How many bytes the read operation will (or did) attempt to read.

attemptedBytesRead

public void attemptedBytesRead(int bytes)

Description copied from interface: RecvByteBufAllocator.Handle

Set how many bytes the read operation will (or did) attempt to read.

Specified by:

attemptedBytesRead in interface RecvByteBufAllocator.Handle

Parameters:

bytes - How many bytes the read operation will (or did) attempt to read.

totalBytesRead

protected final int totalBytesRead()