Class IoUringRecvByteAllocatorHandle

java.lang.Object

io.netty.channel.RecvByteBufAllocator.DelegatingHandle

io.netty.channel.uring.IoUringRecvByteAllocatorHandle

All Implemented Interfaces:

RecvByteBufAllocator.ExtendedHandle, RecvByteBufAllocator.Handle

final class IoUringRecvByteAllocatorHandle
extends RecvByteBufAllocator.DelegatingHandle
implements RecvByteBufAllocator.ExtendedHandle

Field Summary

Fields

Modifier and Type	Field	Description
private final UncheckedBooleanSupplier	defaultSupplier
private boolean	firstRead
private final PreferredDirectByteBufAllocator	preferredDirectByteBufAllocator
private boolean	rdHupReceived
private boolean	readComplete

Constructor Summary

Constructors

Constructor	Description
IoUringRecvByteAllocatorHandle(RecvByteBufAllocator.ExtendedHandle handle)

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.
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.
void	incMessagesRead(int numMessages)	Increment the number of messages that have been read for the current read loop.
boolean	isFirstRead()
(package private) boolean	isReadComplete()
void	lastBytesRead(int bytes)	Set the bytes that have been read for the last read operation.
(package private) void	rdHupReceived()
void	readComplete()	The read has completed.
void	reset(ChannelConfig config)	Reset any counters that have accumulated and recommend how many messages/bytes should be read for the next read loop.

Methods inherited from class RecvByteBufAllocator.DelegatingHandle

attemptedBytesRead, attemptedBytesRead, delegate, guess, lastBytesRead

Methods inherited from class Object

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

Methods inherited from interface RecvByteBufAllocator.Handle

attemptedBytesRead, attemptedBytesRead, guess, lastBytesRead

Field Details

preferredDirectByteBufAllocator

private final PreferredDirectByteBufAllocator preferredDirectByteBufAllocator

defaultSupplier

private final UncheckedBooleanSupplier defaultSupplier

firstRead

private boolean firstRead

rdHupReceived

private boolean rdHupReceived

readComplete

private boolean readComplete

Constructor Details

IoUringRecvByteAllocatorHandle

IoUringRecvByteAllocatorHandle(RecvByteBufAllocator.ExtendedHandle handle)

Method Details

reset

public void reset(ChannelConfig config)

Description copied from interface: RecvByteBufAllocator.Handle

Reset any counters that have accumulated and recommend how many messages/bytes should be read for the next read loop.

This may be used by RecvByteBufAllocator.Handle.continueReading() to determine if the read operation should complete.

This is only ever a hint and may be ignored by the implementation.

Specified by:

reset in interface RecvByteBufAllocator.Handle

Overrides:

reset in class RecvByteBufAllocator.DelegatingHandle

Parameters:

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

rdHupReceived

void rdHupReceived()

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

Overrides:

allocate in class RecvByteBufAllocator.DelegatingHandle

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

Overrides:

continueReading in class RecvByteBufAllocator.DelegatingHandle

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.

isFirstRead

public boolean isFirstRead()

readComplete

public void readComplete()

Description copied from interface: RecvByteBufAllocator.Handle

The read has completed.

Specified by:

readComplete in interface RecvByteBufAllocator.Handle

Overrides:

readComplete in class RecvByteBufAllocator.DelegatingHandle

isReadComplete

boolean isReadComplete()

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

Overrides:

lastBytesRead in class RecvByteBufAllocator.DelegatingHandle

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().

incMessagesRead

public void incMessagesRead(int numMessages)

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

Overrides:

incMessagesRead in class RecvByteBufAllocator.DelegatingHandle

Parameters:

numMessages - The amount to increment by.