Modifier and Type	Class and Description
public abstract class	DefaultMaxMessagesRecvByteBufAllocator.MaxMessageHandle Deprecated as a consequence of `RecvByteBufAllocator.ExtendedHandle` being deprecated. Focuses on enforcing the maximum messages per read condition for `continueReading()`.

Modifier and Type	Field and Description
private final boolean	ignoreBytesRead
private volatile int	maxMessagesPerRead
private volatile boolean	respectMaybeMoreData

Access	Constructor and Description
public	DefaultMaxMessagesRecvByteBufAllocator()
public	DefaultMaxMessagesRecvByteBufAllocator(int maxMessagesPerRead)
pack-priv	DefaultMaxMessagesRecvByteBufAllocator(int maxMessagesPerRead, boolean ignoreBytesRead)

Method Summary

Modifier and Type	Method and Description
public int	maxMessagesPerRead() Implements io.netty.channel.MaxMessagesRecvByteBufAllocator.maxMessagesPerRead. Returns the maximum number of messages to read per read loop.
public MaxMessagesRecvByteBufAllocator	maxMessagesPerRead(int maxMessagesPerRead) Implements io.netty.channel.MaxMessagesRecvByteBufAllocator.maxMessagesPerRead. Sets the maximum number of messages to read per read loop.
public DefaultMaxMessagesRecvByteBufAllocator	Returns: `this`. respectMaybeMoreData(boolean `true` to stop reading if we think there is no more data. This may save a system call to read from the socket, but if data has arrived in a racy fashion we may give up our `maxMessagesPerRead()` quantum and have to wait for the selector to notify us of more data. `false` to keep reading (up to `maxMessagesPerRead()`) or until there is no data when we attempt to read. respectMaybeMoreData) Determine if future instances of `newHandle()` will stop reading if we think there is no more data.
public final boolean	Returns: `true` to stop reading if we think there is no more data. This may save a system call to read from the socket, but if data has arrived in a racy fashion we may give up our `maxMessagesPerRead()` quantum and have to wait for the selector to notify us of more data. `false` to keep reading (up to `maxMessagesPerRead()`) or until there is no data when we attempt to read. respectMaybeMoreData() Get if future instances of `newHandle()` will stop reading if we think there is no more data.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

ignoreBytesRead	back to summary
private final boolean ignoreBytesRead

maxMessagesPerRead	back to summary
private volatile int maxMessagesPerRead

respectMaybeMoreData	back to summary
private volatile boolean respectMaybeMoreData

Constructor Detail

DefaultMaxMessagesRecvByteBufAllocator	back to summary
public DefaultMaxMessagesRecvByteBufAllocator()

DefaultMaxMessagesRecvByteBufAllocator	back to summary
public DefaultMaxMessagesRecvByteBufAllocator(int maxMessagesPerRead)

DefaultMaxMessagesRecvByteBufAllocator	back to summary
pack-priv DefaultMaxMessagesRecvByteBufAllocator(int maxMessagesPerRead, boolean ignoreBytesRead)

Method Detail

maxMessagesPerRead back to summary

maxMessagesPerRead	back to summary
public int maxMessagesPerRead() Implements io.netty.channel.MaxMessagesRecvByteBufAllocator.maxMessagesPerRead. Doc from io.netty.channel.MaxMessagesRecvByteBufAllocator.maxMessagesPerRead. Returns the maximum number of messages 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 multiple messages. Annotations @Override

public int maxMessagesPerRead()

Implements io.netty.channel.MaxMessagesRecvByteBufAllocator.maxMessagesPerRead.

Doc from io.netty.channel.MaxMessagesRecvByteBufAllocator.maxMessagesPerRead.

Returns the maximum number of messages 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 multiple messages.

Annotations

@Override

maxMessagesPerRead	back to summary
public MaxMessagesRecvByteBufAllocator maxMessagesPerRead(int maxMessagesPerRead) Implements io.netty.channel.MaxMessagesRecvByteBufAllocator.maxMessagesPerRead. Doc from io.netty.channel.MaxMessagesRecvByteBufAllocator.maxMessagesPerRead. Sets the maximum number of messages to read per read loop. If this value is greater than 1, an event loop might attempt to read multiple times to procure multiple messages. Annotations @Override

maxMessagesPerRead

back to summary

public MaxMessagesRecvByteBufAllocator maxMessagesPerRead(int maxMessagesPerRead)

Implements io.netty.channel.MaxMessagesRecvByteBufAllocator.maxMessagesPerRead.

Doc from io.netty.channel.MaxMessagesRecvByteBufAllocator.maxMessagesPerRead.

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

Annotations

@Override

respectMaybeMoreData back to summary

respectMaybeMoreData	back to summary
public DefaultMaxMessagesRecvByteBufAllocator respectMaybeMoreData(boolean respectMaybeMoreData) Determine if future instances of `newHandle()` will stop reading if we think there is no more data. Parameters respectMaybeMoreData:boolean `true` to stop reading if we think there is no more data. This may save a system call to read from the socket, but if data has arrived in a racy fashion we may give up our `maxMessagesPerRead()` quantum and have to wait for the selector to notify us of more data. `false` to keep reading (up to `maxMessagesPerRead()`) or until there is no data when we attempt to read. Returns:DefaultMaxMessagesRecvByteBufAllocator `this`.

public DefaultMaxMessagesRecvByteBufAllocator respectMaybeMoreData(boolean respectMaybeMoreData)

Determine if future instances of newHandle() will stop reading if we think there is no more data.

Parameters

respectMaybeMoreData:boolean

true to stop reading if we think there is no more data. This may save a system call to read from the socket, but if data has arrived in a racy fashion we may give up our maxMessagesPerRead() quantum and have to wait for the selector to notify us of more data.
false to keep reading (up to maxMessagesPerRead()) or until there is no data when we attempt to read.

Returns:DefaultMaxMessagesRecvByteBufAllocator

this.

respectMaybeMoreData back to summary

respectMaybeMoreData	back to summary
public final boolean respectMaybeMoreData() Get if future instances of `newHandle()` will stop reading if we think there is no more data. Returns:boolean `true` to stop reading if we think there is no more data. This may save a system call to read from the socket, but if data has arrived in a racy fashion we may give up our `maxMessagesPerRead()` quantum and have to wait for the selector to notify us of more data. `false` to keep reading (up to `maxMessagesPerRead()`) or until there is no data when we attempt to read.

public final boolean respectMaybeMoreData()

Get if future instances of newHandle() will stop reading if we think there is no more data.

Returns:boolean

true to stop reading if we think there is no more data. This may save a system call to read from the socket, but if data has arrived in a racy fashion we may give up our maxMessagesPerRead() quantum and have to wait for the selector to notify us of more data.
false to keep reading (up to maxMessagesPerRead()) or until there is no data when we attempt to read.

io.netty.channel back to summary

public abstract Class DefaultMaxMessagesRecvByteBufAllocator.MaxMessageHandle

Class Inheritance

extends Object
implements ExtendedHandle

java.lang.Object
io.netty.channel.DefaultMaxMessagesRecvByteBufAllocator.MaxMessageHandle

All Implemented Interfaces

io.netty.channel.RecvByteBufAllocator.ExtendedHandle, io.netty.channel.RecvByteBufAllocator.Handle

Known Direct Subclasses

io.netty.channel.AdaptiveRecvByteBufAllocator.HandleImpl, io.netty.channel.FixedRecvByteBufAllocator.HandleImpl

Deprecated

as a consequence of RecvByteBufAllocator.ExtendedHandle being deprecated. See corresponding docs for further information.

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

Field Summary

Modifier and Type	Field and Description
private int	attemptedBytesRead
private ChannelConfig	config
private final UncheckedBooleanSupplier	defaultMaybeMoreSupplier
private int	lastBytesRead
private int	maxMessagePerRead
private final boolean	respectMaybeMoreData
private int	totalBytesRead
private int	totalMessages

Constructor Summary

Access	Constructor and Description
public	MaxMessageHandle()

Method Summary

Modifier and Type	Method and Description
public ByteBuf	allocate(ByteBufAllocator alloc) Implements io.netty.channel.RecvByteBufAllocator.Handle.allocate. Creates a new receive buffer whose capacity is probably large enough to read all inbound data and small enough not to waste its space.
public int	attemptedBytesRead() Implements io.netty.channel.RecvByteBufAllocator.Handle.attemptedBytesRead. Get how many bytes the read operation will (or did) attempt to read.
public void	attemptedBytesRead(int How many bytes the read operation will (or did) attempt to read. bytes) Implements io.netty.channel.RecvByteBufAllocator.Handle.attemptedBytesRead. Set how many bytes the read operation will (or did) attempt to read.
public boolean	continueReading() Implements io.netty.channel.RecvByteBufAllocator.Handle.continueReading. Determine if the current read loop should continue.
public boolean	continueReading(UncheckedBooleanSupplier A supplier that determines if there maybe more data to read. maybeMoreDataSupplier) Implements io.netty.channel.RecvByteBufAllocator.ExtendedHandle.continueReading. Same as `Handle#continueReading()` except "more data" is determined by the supplier parameter.
public final void	incMessagesRead(int The amount to increment by. amt) Implements io.netty.channel.RecvByteBufAllocator.Handle.incMessagesRead. Increment the number of messages that have been read for the current read loop.
public void	lastBytesRead(int 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 `lastBytesRead()`. A negative value will signal a termination condition enforced externally to this class and is not required to be enforced in `continueReading()`. bytes) Implements io.netty.channel.RecvByteBufAllocator.Handle.lastBytesRead. Set the bytes that have been read for the last read operation.
public final int	lastBytesRead() Implements io.netty.channel.RecvByteBufAllocator.Handle.lastBytesRead. Get the amount of bytes for the previous read operation.
public void	readComplete() Implements io.netty.channel.RecvByteBufAllocator.Handle.readComplete. The read has completed.
public void	reset(ChannelConfig The channel configuration which may impact this object's behavior. config) Implements io.netty.channel.RecvByteBufAllocator.Handle.reset. Only `ChannelConfig#getMaxMessagesPerRead()` is used.
protected final int	totalBytesRead()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

attemptedBytesRead	back to summary
private int attemptedBytesRead

config	back to summary
private ChannelConfig config

defaultMaybeMoreSupplier	back to summary
private final UncheckedBooleanSupplier defaultMaybeMoreSupplier

lastBytesRead	back to summary
private int lastBytesRead

maxMessagePerRead	back to summary
private int maxMessagePerRead

respectMaybeMoreData	back to summary
private final boolean respectMaybeMoreData

totalBytesRead	back to summary
private int totalBytesRead

totalMessages	back to summary
private int totalMessages

Constructor Detail

MaxMessageHandle	back to summary
public MaxMessageHandle()

Method Detail

allocate	back to summary
public ByteBuf allocate(ByteBufAllocator alloc) Implements io.netty.channel.RecvByteBufAllocator.Handle.allocate. Doc from io.netty.channel.RecvByteBufAllocator.Handle.allocate. Creates a new receive buffer whose capacity is probably large enough to read all inbound data and small enough not to waste its space. Annotations @Override

allocate

back to summary

public ByteBuf allocate(ByteBufAllocator alloc)

Implements io.netty.channel.RecvByteBufAllocator.Handle.allocate.

Doc from io.netty.channel.RecvByteBufAllocator.Handle.allocate.

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

Annotations

@Override

attemptedBytesRead	back to summary
public int attemptedBytesRead() Implements io.netty.channel.RecvByteBufAllocator.Handle.attemptedBytesRead. Doc from io.netty.channel.RecvByteBufAllocator.Handle.attemptedBytesRead. Get how many bytes the read operation will (or did) attempt to read. Returns:int How many bytes the read operation will (or did) attempt to read. Annotations @Override

attemptedBytesRead

back to summary

public int attemptedBytesRead()

Implements io.netty.channel.RecvByteBufAllocator.Handle.attemptedBytesRead.

Doc from io.netty.channel.RecvByteBufAllocator.Handle.attemptedBytesRead.

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

Returns:int

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

Annotations

@Override

attemptedBytesRead	back to summary
public void attemptedBytesRead(int bytes) Implements io.netty.channel.RecvByteBufAllocator.Handle.attemptedBytesRead. Doc from io.netty.channel.RecvByteBufAllocator.Handle.attemptedBytesRead. Set how many bytes the read operation will (or did) attempt to read. Parameters bytes:int How many bytes the read operation will (or did) attempt to read. Annotations @Override

attemptedBytesRead

back to summary

public void attemptedBytesRead(int bytes)

Implements io.netty.channel.RecvByteBufAllocator.Handle.attemptedBytesRead.

Doc from io.netty.channel.RecvByteBufAllocator.Handle.attemptedBytesRead.

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

Parameters

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

Annotations

@Override

continueReading back to summary

continueReading	back to summary
public boolean continueReading() Implements io.netty.channel.RecvByteBufAllocator.Handle.continueReading. Doc from io.netty.channel.RecvByteBufAllocator.Handle.continueReading. Determine if the current read loop should continue. Returns:boolean `true` if the read loop should continue reading. `false` if the read loop is complete. Annotations @Override

public boolean continueReading()

Implements io.netty.channel.RecvByteBufAllocator.Handle.continueReading.

Doc from io.netty.channel.RecvByteBufAllocator.Handle.continueReading.

Determine if the current read loop should continue.

Returns:boolean

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

Annotations

@Override

continueReading back to summary

continueReading	back to summary
public boolean continueReading(UncheckedBooleanSupplier maybeMoreDataSupplier) Implements io.netty.channel.RecvByteBufAllocator.ExtendedHandle.continueReading. Doc from io.netty.channel.RecvByteBufAllocator.ExtendedHandle.continueReading. Same as `Handle#continueReading()` except "more data" is determined by the supplier parameter. Parameters maybeMoreDataSupplier:UncheckedBooleanSupplier A supplier that determines if there maybe more data to read. Annotations @Override

public boolean continueReading(UncheckedBooleanSupplier maybeMoreDataSupplier)

Implements io.netty.channel.RecvByteBufAllocator.ExtendedHandle.continueReading.

Doc from io.netty.channel.RecvByteBufAllocator.ExtendedHandle.continueReading.

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

Parameters

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

Annotations

@Override

incMessagesRead	back to summary
public final void incMessagesRead(int amt) Implements io.netty.channel.RecvByteBufAllocator.Handle.incMessagesRead. Doc from io.netty.channel.RecvByteBufAllocator.Handle.incMessagesRead. Increment the number of messages that have been read for the current read loop. Parameters amt:int The amount to increment by. Annotations @Override

incMessagesRead

back to summary

public final void incMessagesRead(int amt)

Implements io.netty.channel.RecvByteBufAllocator.Handle.incMessagesRead.

Doc from io.netty.channel.RecvByteBufAllocator.Handle.incMessagesRead.

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

Parameters

amt:int: The amount to increment by.

Annotations

@Override

lastBytesRead back to summary

lastBytesRead	back to summary
public void lastBytesRead(int bytes) Implements io.netty.channel.RecvByteBufAllocator.Handle.lastBytesRead. Doc from io.netty.channel.RecvByteBufAllocator.Handle.lastBytesRead. 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. Parameters bytes:int 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 `lastBytesRead()`. A negative value will signal a termination condition enforced externally to this class and is not required to be enforced in `continueReading()`. Annotations @Override

public void lastBytesRead(int bytes)

Implements io.netty.channel.RecvByteBufAllocator.Handle.lastBytesRead.

Doc from io.netty.channel.RecvByteBufAllocator.Handle.lastBytesRead.

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.

Parameters

bytes:int: 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 lastBytesRead(). A negative value will signal a termination condition enforced externally to this class and is not required to be enforced in continueReading().

Annotations

@Override

lastBytesRead	back to summary
public final int lastBytesRead() Implements io.netty.channel.RecvByteBufAllocator.Handle.lastBytesRead. Doc from io.netty.channel.RecvByteBufAllocator.Handle.lastBytesRead. Get the amount of bytes for the previous read operation. Returns:int The amount of bytes for the previous read operation. Annotations @Override

lastBytesRead

back to summary

public final int lastBytesRead()

Implements io.netty.channel.RecvByteBufAllocator.Handle.lastBytesRead.

Doc from io.netty.channel.RecvByteBufAllocator.Handle.lastBytesRead.

Get the amount of bytes for the previous read operation.

Returns:int

The amount of bytes for the previous read operation.

Annotations

@Override

readComplete	back to summary
public void readComplete() Implements io.netty.channel.RecvByteBufAllocator.Handle.readComplete. Doc from io.netty.channel.RecvByteBufAllocator.Handle.readComplete. The read has completed. Annotations @Override

readComplete

back to summary

public void readComplete()

Implements io.netty.channel.RecvByteBufAllocator.Handle.readComplete.

Doc from io.netty.channel.RecvByteBufAllocator.Handle.readComplete.

The read has completed.

Annotations

@Override

reset back to summary

reset	back to summary
public void reset(ChannelConfig config) Implements io.netty.channel.RecvByteBufAllocator.Handle.reset. Only `ChannelConfig#getMaxMessagesPerRead()` is used. Parameters config:ChannelConfig Doc from io.netty.channel.RecvByteBufAllocator.Handle.reset. The channel configuration which may impact this object's behavior. Annotations @Override

public void reset(ChannelConfig config)

Implements io.netty.channel.RecvByteBufAllocator.Handle.reset.

Only ChannelConfig#getMaxMessagesPerRead() is used.

Parameters

config:ChannelConfig

Doc from io.netty.channel.RecvByteBufAllocator.Handle.reset.

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

Annotations