io.netty.channel.epoll

Class EpollRecvByteAllocatorHandle

java.lang.Object

io.netty.channel.epoll.EpollRecvByteAllocatorHandle

All Implemented Interfaces:

RecvByteBufAllocator.ExtendedHandle, RecvByteBufAllocator.Handle

Direct Known Subclasses:

EpollRecvByteAllocatorStreamingHandle

class EpollRecvByteAllocatorHandle
extends java.lang.Object
implements RecvByteBufAllocator.ExtendedHandle

Field Summary

Fields

Modifier and Type	Field and Description
private UncheckedBooleanSupplier	defaultMaybeMoreDataSupplier
private RecvByteBufAllocator.ExtendedHandle	delegate
private boolean	isEdgeTriggered
private boolean	receivedRdHup

Constructor Summary

Constructors

Constructor and Description
EpollRecvByteAllocatorHandle(RecvByteBufAllocator.ExtendedHandle handle)

Method Summary

Modifier and Type	Method and 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 should continue.
boolean	continueReading(UncheckedBooleanSupplier maybeMoreDataSupplier) Same as RecvByteBufAllocator.Handle.continueReading() except "more data" is determined by the supplier parameter.
(package private) void	edgeTriggered(boolean edgeTriggered)
int	guess() Similar to RecvByteBufAllocator.Handle.allocate(ByteBufAllocator) except that it does not allocate anything but just tells the capacity.
void	incMessagesRead(int numMessages) Increment the number of messages that have been read for the current read loop.
(package private) boolean	isEdgeTriggered()
(package private) boolean	isReceivedRdHup()
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.
(package private) boolean	maybeMoreDataToRead()
void	readComplete() The read has completed.
(package private) void	receivedRdHup()
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 java.lang.Object

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

Field Detail

delegate

private final RecvByteBufAllocator.ExtendedHandle delegate

defaultMaybeMoreDataSupplier

private final UncheckedBooleanSupplier defaultMaybeMoreDataSupplier

isEdgeTriggered

private boolean isEdgeTriggered

receivedRdHup

private boolean receivedRdHup

Constructor Detail

EpollRecvByteAllocatorHandle

EpollRecvByteAllocatorHandle(RecvByteBufAllocator.ExtendedHandle handle)

Method Detail

receivedRdHup

final void receivedRdHup()

isReceivedRdHup

final boolean isReceivedRdHup()

maybeMoreDataToRead

boolean maybeMoreDataToRead()

edgeTriggered

final void edgeTriggered(boolean edgeTriggered)

isEdgeTriggered

final boolean isEdgeTriggered()

allocate

public final 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

guess

public final int guess()

Description copied from interface: RecvByteBufAllocator.Handle

Similar to RecvByteBufAllocator.Handle.allocate(ByteBufAllocator) except that it does not allocate anything but just tells the capacity.

Specified by:

guess in interface RecvByteBufAllocator.Handle

reset

public final 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

Parameters:

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

incMessagesRead

public final 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

Parameters:

numMessages - The amount to increment by.

lastBytesRead

public final 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.

attemptedBytesRead

public final 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 final 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.

readComplete

public final void readComplete()

Description copied from interface: RecvByteBufAllocator.Handle

The read has completed.

Specified by:

readComplete in interface RecvByteBufAllocator.Handle

continueReading

public final 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.

continueReading

public final boolean continueReading()

Description copied from interface: RecvByteBufAllocator.Handle

Determine if the current read loop should 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.