Class AbstractIoUringChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.uring.AbstractIoUringChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, UnixChannel, AttributeMap, java.lang.Comparable<Channel>

Direct Known Subclasses:

AbstractIoUringServerChannel, AbstractIoUringStreamChannel, IoUringDatagramChannel

abstract class AbstractIoUringChannel
extends AbstractChannel
implements UnixChannel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractIoUringChannel.AbstractUringUnsafe
private static final class	AbstractIoUringChannel.DelayedClose

Nested classes/interfaces inherited from class AbstractChannel

AbstractChannel.AbstractUnsafe

Nested classes/interfaces inherited from interface Channel

Channel.Unsafe

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	active
private CleanableDirectBuffer	cleanable
private static final int	CONNECT_SCHEDULED
private long	connectId
private ChannelPromise	connectPromise	The future of the current connection attempt.
private java.util.concurrent.ScheduledFuture<?>	connectTimeoutFuture
private AbstractIoUringChannel.DelayedClose	delayedClose
private long	fastOpenBytes
private java.lang.Object	fastOpenData
private ChannelOutboundBuffer	fastOpenOutboundBuffer
private boolean	inputClosedSeenErrorOnRead
private boolean	inReadComplete
private byte	ioState
private java.net.SocketAddress	local
private static final InternalLogger	logger
private MsgHdrMemoryArray	msgHdrMemoryArray
private short	numOutstandingReads
private short	numOutstandingWrites
private short	opsId
private static final int	POLL_IN_SCHEDULED
private static final int	POLL_OUT_SCHEDULED
private static final int	POLL_RDHUP_SCHEDULED
private long	pollInId
private long	pollOutId
private long	pollRdhupId
private static final int	READ_SCHEDULED
private boolean	readPending
private IoRegistration	registration
private java.net.SocketAddress	remote
private java.nio.ByteBuffer	remoteAddressMemory
private java.net.SocketAddress	requestedRemoteAddress
(package private) final LinuxSocket	socket
private boolean	socketHasMoreData
private static final int	WRITE_SCHEDULED

Constructor Summary

Constructors

Constructor	Description
AbstractIoUringChannel(Channel parent, LinuxSocket socket, boolean active)
AbstractIoUringChannel(Channel parent, LinuxSocket fd, java.net.SocketAddress remote)

Method Summary

Modifier and Type	Method	Description
protected boolean	allowMultiShotPollIn()
(package private) final void	autoReadCleared()
private void	cancelConnectTimeoutFuture()
protected abstract void	cancelOutstandingReads(IoRegistration registration, int numOutstandingReads)	Cancel all outstanding reads
protected abstract void	cancelOutstandingWrites(IoRegistration registration, int numOutstandingWrites)	Cancel all outstanding writes
protected static void	checkResolvable(java.net.InetSocketAddress addr)
private void	clearRead()
private void	computeRemote()
protected final void	doBeginRead()	Schedule a read operation.
private void	doBeginReadNow()
protected void	doBind(java.net.SocketAddress local)	Bind the Channel to the SocketAddress
protected void	doClose()	Close the Channel
protected final void	doDeregister()	Deregister the Channel from its EventLoop.
protected void	doDisconnect()	Disconnect this Channel from its remote peer
protected void	doRegister(ChannelPromise promise)	Is called after the Channel is registered with its EventLoop as part of the register process.
protected final void	doShutdownOutput()	Called when conditions justify shutting down the output portion of the channel.
protected void	doShutdownOutput0()	Performs the actual output shutdown.
protected void	doWrite(ChannelOutboundBuffer in)	Flush the content of the given buffer to the remote peer.
final FileDescriptor	fd()	Returns the FileDescriptor that is used by this Channel.
protected java.lang.Object	filterOutboundMessage(java.lang.Object msg)	Invoked when a new message is added to a ChannelOutboundBuffer of this AbstractChannel, so that the Channel implementation converts the message to another.
private void	freeMsgHdrArray()
private void	freeRemoteAddressMemory()
private AbstractIoUringChannel.AbstractUringUnsafe	ioUringUnsafe()
boolean	isActive()	Return true if the Channel is active and so connected.
private static boolean	isAllowHalfClosure(ChannelConfig config)
protected boolean	isCompatible(EventLoop loop)	Return true if the given EventLoop is compatible with this instance.
final boolean	isOpen()	Returns true if the Channel is open and may get active later
(package private) abstract boolean	isPollInFirst()
protected abstract boolean	isStreamSocket()
protected final java.net.SocketAddress	localAddress0()	Returns the SocketAddress which is bound locally.
private static short	narrowUserData(long userData)
protected final ByteBuf	newDirectBuffer(ByteBuf buf)
protected final ByteBuf	newDirectBuffer(java.lang.Object holder, ByteBuf buf)
private static ByteBuf	newDirectBuffer0(java.lang.Object holder, ByteBuf buf, ByteBufAllocator alloc, int capacity)
protected final short	nextOpsId()	Returns the next id that should be used when submitting IoUringIoOps.
protected final IoRegistration	registration()
protected final java.net.SocketAddress	remoteAddress0()	Return the SocketAddress which the Channel is connected to.
private void	removeFastOpenData()	Removes the bytes that were sent by a TCP_FASTOPEN_CONNECT from the ChannelOutboundBuffer if the channel was connected, and forgets about them otherwise.
(package private) final void	resetCachedAddresses()
private long	schedulePollAdd(int ioMask, int mask, boolean multishot)
private void	schedulePollOut()
(package private) final void	schedulePollRdHup()
private int	scheduleWrite(ChannelOutboundBuffer in)
protected void	scheduleWriteIfNeeded(ChannelOutboundBuffer in, boolean submitAndRunNow)
private boolean	shouldBreakIoUringInReady(ChannelConfig config)
protected abstract boolean	socketIsEmpty(int flags)	Return if the socket is guaranteed to be empty when the submitted io was executed and the completion event be created.
protected void	submitAndRunNow()
private void	submitConnect(DomainSocketAddress unixDomainSocketAddress)
private void	submitConnect(java.net.InetSocketAddress inetSocketAddress)
(package private) final MsgHdrMemory	writeMsgHdr()

Methods inherited from class AbstractChannel

closeFuture, compareTo, doRegister, equals, eventLoop, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, localAddress, maxMessagesPerWrite, newChannelPipeline, newId, newUnsafe, parent, pipeline, remoteAddress, toString, unsafe, validateFileRegion, voidPromise

Methods inherited from class DefaultAttributeMap

attr, hasAttr

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface AttributeMap

attr, hasAttr

Methods inherited from interface Channel

alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, config, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, eventLoop, flush, getOption, id, isRegistered, isWritable, localAddress, metadata, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, setOption, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface java.lang.Comparable

compareTo

Field Details

logger

private static final InternalLogger logger

socket

final LinuxSocket socket

active

protected volatile boolean active

POLL_IN_SCHEDULED

private static final int POLL_IN_SCHEDULED

See Also:

• Constant Field Values

POLL_OUT_SCHEDULED

private static final int POLL_OUT_SCHEDULED

See Also:

• Constant Field Values

POLL_RDHUP_SCHEDULED

private static final int POLL_RDHUP_SCHEDULED

See Also:

• Constant Field Values

WRITE_SCHEDULED

private static final int WRITE_SCHEDULED

See Also:

• Constant Field Values

READ_SCHEDULED

private static final int READ_SCHEDULED

See Also:

• Constant Field Values

CONNECT_SCHEDULED

private static final int CONNECT_SCHEDULED

See Also:

• Constant Field Values

opsId

private short opsId

pollInId

private long pollInId

pollOutId

private long pollOutId

pollRdhupId

private long pollRdhupId

connectId

private long connectId

ioState

private byte ioState

numOutstandingWrites

private short numOutstandingWrites

numOutstandingReads

private short numOutstandingReads

readPending

private boolean readPending

inReadComplete

private boolean inReadComplete

socketHasMoreData

private boolean socketHasMoreData

delayedClose

private AbstractIoUringChannel.DelayedClose delayedClose

inputClosedSeenErrorOnRead

private boolean inputClosedSeenErrorOnRead

connectPromise

private ChannelPromise connectPromise

The future of the current connection attempt. If not null, subsequent connection attempts will fail.

connectTimeoutFuture

private java.util.concurrent.ScheduledFuture<?> connectTimeoutFuture

requestedRemoteAddress

private java.net.SocketAddress requestedRemoteAddress

cleanable

private CleanableDirectBuffer cleanable

remoteAddressMemory

private java.nio.ByteBuffer remoteAddressMemory

msgHdrMemoryArray

private MsgHdrMemoryArray msgHdrMemoryArray

fastOpenOutboundBuffer

private ChannelOutboundBuffer fastOpenOutboundBuffer

fastOpenData

private java.lang.Object fastOpenData

fastOpenBytes

private long fastOpenBytes

registration

private IoRegistration registration

local

private volatile java.net.SocketAddress local

remote

private volatile java.net.SocketAddress remote

Constructor Details

AbstractIoUringChannel

AbstractIoUringChannel(Channel parent,
 LinuxSocket socket,
 boolean active)

AbstractIoUringChannel

AbstractIoUringChannel(Channel parent,
 LinuxSocket fd,
 java.net.SocketAddress remote)

Method Details

autoReadCleared

final void autoReadCleared()

clearRead

private void clearRead()

nextOpsId

protected final short nextOpsId()

Returns the next id that should be used when submitting IoUringIoOps.

Returns:

opsId

isOpen

public final boolean isOpen()

Description copied from interface: Channel

Returns true if the Channel is open and may get active later

Specified by:

isOpen in interface Channel

isActive

public boolean isActive()

Description copied from interface: Channel

Return true if the Channel is active and so connected.

Specified by:

isActive in interface Channel

fd

public final FileDescriptor fd()

Description copied from interface: UnixChannel

Returns the FileDescriptor that is used by this Channel.

Specified by:

fd in interface UnixChannel

ioUringUnsafe

private AbstractIoUringChannel.AbstractUringUnsafe ioUringUnsafe()

isCompatible

protected boolean isCompatible(EventLoop loop)

Description copied from class: AbstractChannel

Return true if the given EventLoop is compatible with this instance.

Specified by:

isCompatible in class AbstractChannel

newDirectBuffer

protected final ByteBuf newDirectBuffer(ByteBuf buf)

allowMultiShotPollIn

protected boolean allowMultiShotPollIn()

newDirectBuffer

protected final ByteBuf newDirectBuffer(java.lang.Object holder,
 ByteBuf buf)

newDirectBuffer0

private static ByteBuf newDirectBuffer0(java.lang.Object holder,
 ByteBuf buf,
 ByteBufAllocator alloc,
 int capacity)

cancelOutstandingReads

protected abstract void cancelOutstandingReads(IoRegistration registration,
 int numOutstandingReads)

Cancel all outstanding reads

Parameters:

registration - the IoRegistration.

numOutstandingReads - the number of outstanding reads, or -1 if multi-shot was used.

cancelOutstandingWrites

protected abstract void cancelOutstandingWrites(IoRegistration registration,
 int numOutstandingWrites)

Cancel all outstanding writes

Parameters:

registration - the IoRegistration.

numOutstandingWrites - the number of outstanding writes.

doDisconnect

protected void doDisconnect()
                     throws java.lang.Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Specified by:

doDisconnect in class AbstractChannel

Throws:

java.lang.Exception

freeRemoteAddressMemory

private void freeRemoteAddressMemory()

writeMsgHdr

final MsgHdrMemory writeMsgHdr()

freeMsgHdrArray

private void freeMsgHdrArray()

doClose

protected void doClose()
                throws java.lang.Exception

Description copied from class: AbstractChannel

Close the Channel

Specified by:

doClose in class AbstractChannel

Throws:

java.lang.Exception

doShutdownOutput

protected final void doShutdownOutput()
                               throws java.lang.Exception

Description copied from class: AbstractChannel

Called when conditions justify shutting down the output portion of the channel. This may happen if a write operation throws an exception.

Overrides:

doShutdownOutput in class AbstractChannel

Throws:

java.lang.Exception

removeFastOpenData

private void removeFastOpenData()

Removes the bytes that were sent by a TCP_FASTOPEN_CONNECT from the ChannelOutboundBuffer if the channel was connected, and forgets about them otherwise. Must be called before the ChannelOutboundBuffer is written or its messages are failed.

doShutdownOutput0

protected void doShutdownOutput0()
                          throws java.lang.Exception

Performs the actual output shutdown. Overridden by subclasses that support it.

Throws:

java.lang.Exception

doBeginRead

protected final void doBeginRead()

Description copied from class: AbstractChannel

Schedule a read operation.

Specified by:

doBeginRead in class AbstractChannel

doBeginReadNow

private void doBeginReadNow()

doWrite

protected void doWrite(ChannelOutboundBuffer in)

Description copied from class: AbstractChannel

Flush the content of the given buffer to the remote peer.

Specified by:

doWrite in class AbstractChannel

scheduleWriteIfNeeded

protected void scheduleWriteIfNeeded(ChannelOutboundBuffer in,
 boolean submitAndRunNow)

submitAndRunNow

protected void submitAndRunNow()

scheduleWrite

private int scheduleWrite(ChannelOutboundBuffer in)

registration

protected final IoRegistration registration()

schedulePollOut

private void schedulePollOut()

schedulePollRdHup

final void schedulePollRdHup()

isStreamSocket

protected abstract boolean isStreamSocket()

schedulePollAdd

private long schedulePollAdd(int ioMask,
 int mask,
 boolean multishot)

resetCachedAddresses

final void resetCachedAddresses()

narrowUserData

private static short narrowUserData(long userData)

submitConnect

private void submitConnect(java.net.InetSocketAddress inetSocketAddress)

submitConnect

private void submitConnect(DomainSocketAddress unixDomainSocketAddress)

filterOutboundMessage

protected java.lang.Object filterOutboundMessage(java.lang.Object msg)

Description copied from class: AbstractChannel

Invoked when a new message is added to a ChannelOutboundBuffer of this AbstractChannel, so that the Channel implementation converts the message to another. (e.g. heap buffer -> direct buffer)

Overrides:

filterOutboundMessage in class AbstractChannel

doRegister

protected void doRegister(ChannelPromise promise)

Description copied from class: AbstractChannel

Is called after the Channel is registered with its EventLoop as part of the register process. Subclasses may override this method

Overrides:

doRegister in class AbstractChannel

Parameters:

promise - ChannelPromise that must be notified once done to continue the registration.

doDeregister

protected final void doDeregister()

Description copied from class: AbstractChannel

Deregister the Channel from its EventLoop. Sub-classes may override this method

Overrides:

doDeregister in class AbstractChannel

doBind

protected void doBind(java.net.SocketAddress local)
               throws java.lang.Exception

Description copied from class: AbstractChannel

Bind the Channel to the SocketAddress

Specified by:

doBind in class AbstractChannel

Throws:

java.lang.Exception

checkResolvable

protected static void checkResolvable(java.net.InetSocketAddress addr)

localAddress0

protected final java.net.SocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 in class AbstractChannel

remoteAddress0

protected final java.net.SocketAddress remoteAddress0()

Description copied from class: AbstractChannel

Return the SocketAddress which the Channel is connected to.

Specified by:

remoteAddress0 in class AbstractChannel

isAllowHalfClosure

private static boolean isAllowHalfClosure(ChannelConfig config)

cancelConnectTimeoutFuture

private void cancelConnectTimeoutFuture()

computeRemote

private void computeRemote()

shouldBreakIoUringInReady

private boolean shouldBreakIoUringInReady(ChannelConfig config)

socketIsEmpty

protected abstract boolean socketIsEmpty(int flags)

Return if the socket is guaranteed to be empty when the submitted io was executed and the completion event be created.

Parameters:

flags - the flags that were part of the completion

Returns:

true if empty.

isPollInFirst

abstract boolean isPollInFirst()