Class AbstractIoUringStreamChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.uring.AbstractIoUringChannel

io.netty.channel.uring.AbstractIoUringStreamChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, DuplexChannel, UnixChannel, AttributeMap, Comparable<Channel>

Direct Known Subclasses:

IoUringDomainSocketChannel, IoUringSocketChannel

abstract class AbstractIoUringStreamChannel
extends AbstractIoUringChannel
implements DuplexChannel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	AbstractIoUringStreamChannel.ByteBufWritableByteChannel	A WritableByteChannel backed by a ByteBuf.
protected class	AbstractIoUringStreamChannel.IoUringStreamUnsafe

Nested classes/interfaces inherited from class AbstractIoUringChannel

AbstractIoUringChannel.AbstractUringUnsafe

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
private IoUringBufferRing	bufferRing
private static final int	FILE_REGION_MAX_CHUNK_SIZE	Maximum bytes per chunk when converting a generic FileRegion to a ByteBuf for the io_uring async send path.
private static final InternalLogger	logger
private static final ChannelMetadata	METADATA
(package private) long	readId
(package private) byte	readOpCode
(package private) long	writeId
(package private) byte	writeOpCode

Fields inherited from class AbstractIoUringChannel

active, socket, writeTracker

Constructor Summary

Constructors

Constructor	Description
AbstractIoUringStreamChannel(Channel parent, LinuxSocket socket, boolean active)
AbstractIoUringStreamChannel(Channel parent, LinuxSocket socket, SocketAddress remote)

Method Summary

Modifier and Type	Method	Description
protected final void	cancelOutstandingReads(IoRegistration registration, int numOutstandingReads)	Cancel all outstanding reads
protected final void	cancelOutstandingWrites(IoRegistration registration, int numOutstandingWrites)	Cancel all outstanding writes
protected final void	doRegister(ChannelPromise promise)	Is called after the Channel is registered with its EventLoop as part of the register process.
protected final void	doShutdownOutput0()	Performs the actual output shutdown.
protected Object	filterOutboundMessage(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.
final boolean	isInputShutdown()	Returns true if and only if the remote peer shut down its output so that no more data is received from this channel.
final boolean	isOutputShutdown()
(package private) boolean	isPollInFirst()
final boolean	isShutdown()	Determine if both the input and output of this channel have been shutdown.
protected final boolean	isStreamSocket()
ChannelMetadata	metadata()	Return the ChannelMetadata of the Channel which describe the nature of the Channel.
protected AbstractIoUringChannel.AbstractUringUnsafe	newUnsafe()	Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
protected boolean	shouldCompleteReadLoop(int flags, boolean multishot)
final ChannelFuture	shutdown()	Will shutdown the input and output sides of this channel.
final ChannelFuture	shutdown(ChannelPromise promise)	Will shutdown the input and output sides of this channel.
private static void	shutdownDone(ChannelFuture shutdownOutputFuture, ChannelFuture shutdownInputFuture, ChannelPromise promise)
final ChannelFuture	shutdownInput()
final ChannelFuture	shutdownInput(ChannelPromise promise)	Will shutdown the input and notify ChannelPromise.
private void	shutdownInput0(ChannelPromise promise)
final ChannelFuture	shutdownOutput()
final ChannelFuture	shutdownOutput(ChannelPromise promise)	Will shutdown the output and notify ChannelPromise.
private void	shutdownOutputDone(ChannelFuture shutdownOutputFuture, ChannelPromise promise)
protected 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.

Methods inherited from class AbstractIoUringChannel

allowMultiShotPollIn, autoReadCleared, checkResolvable, doBeginRead, doBind, doClose, doDeregister, doDisconnect, doShutdownOutput, doWrite, fd, isActive, isCompatible, isOpen, localAddress0, newDirectBuffer, newDirectBuffer, nextOpsId, registration, remoteAddress0, resetCachedAddresses, schedulePollRdHup, scheduleWriteIfNeeded, submitAndRunNow

Methods inherited from class AbstractChannel

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

Methods inherited from class DefaultAttributeMap

attr, hasAttr

Methods inherited from class 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, isActive, isOpen, isRegistered, isWritable, localAddress, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, remoteAddress, setOption, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface Comparable

compareTo

Field Details

logger

private static final InternalLogger logger

METADATA

private static final ChannelMetadata METADATA

FILE_REGION_MAX_CHUNK_SIZE

private static final int FILE_REGION_MAX_CHUNK_SIZE

Maximum bytes per chunk when converting a generic FileRegion to a ByteBuf for the io_uring async send path. Overridable via the io.netty.iouring.fileRegionChunkSize system property; capped at 16 MiB to guard against pathological configurations that would risk direct-memory OOM.

writeOpCode

byte writeOpCode

writeId

long writeId

readOpCode

byte readOpCode

readId

long readId

bufferRing

private IoUringBufferRing bufferRing

Constructor Details

AbstractIoUringStreamChannel

AbstractIoUringStreamChannel(Channel parent,
 LinuxSocket socket,
 boolean active)

AbstractIoUringStreamChannel

AbstractIoUringStreamChannel(Channel parent,
 LinuxSocket socket,
 SocketAddress remote)

Method Details

isStreamSocket

protected final boolean isStreamSocket()

Specified by:

isStreamSocket in class AbstractIoUringChannel

metadata

public ChannelMetadata metadata()

Description copied from interface: Channel

Return the ChannelMetadata of the Channel which describe the nature of the Channel.

Specified by:

metadata in interface Channel

newUnsafe

protected AbstractIoUringChannel.AbstractUringUnsafe newUnsafe()

Description copied from class: AbstractChannel

Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel

Specified by:

newUnsafe in class AbstractChannel

shutdown

public final ChannelFuture shutdown()

Description copied from interface: DuplexChannel

Will shutdown the input and output sides of this channel.

Specified by:

shutdown in interface DuplexChannel

Returns:

will be completed when both shutdown operations complete.

shutdown

public final ChannelFuture shutdown(ChannelPromise promise)

Description copied from interface: DuplexChannel

Will shutdown the input and output sides of this channel.

Specified by:

shutdown in interface DuplexChannel

Parameters:

promise - will be completed when both shutdown operations complete.

Returns:

will be completed when both shutdown operations complete.

doShutdownOutput0

protected final void doShutdownOutput0()
                                throws Exception

Description copied from class: AbstractIoUringChannel

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

Overrides:

doShutdownOutput0 in class AbstractIoUringChannel

Throws:

Exception

shutdownInput0

private void shutdownInput0(ChannelPromise promise)

isOutputShutdown

public final boolean isOutputShutdown()

Specified by:

isOutputShutdown in interface DuplexChannel

See Also:

• Socket.isOutputShutdown()

isInputShutdown

public final boolean isInputShutdown()

Description copied from interface: DuplexChannel

Returns true if and only if the remote peer shut down its output so that no more data is received from this channel. Note that the semantic of this method is different from that of Socket.shutdownInput() and Socket.isInputShutdown().

Specified by:

isInputShutdown in interface DuplexChannel

isShutdown

public final boolean isShutdown()

Description copied from interface: DuplexChannel

Determine if both the input and output of this channel have been shutdown.

Specified by:

isShutdown in interface DuplexChannel

shutdownOutput

public final ChannelFuture shutdownOutput()

Specified by:

shutdownOutput in interface DuplexChannel

See Also:

• Socket.shutdownOutput()

shutdownOutput

public final ChannelFuture shutdownOutput(ChannelPromise promise)

Description copied from interface: DuplexChannel

Will shutdown the output and notify ChannelPromise.

Specified by:

shutdownOutput in interface DuplexChannel

See Also:

• Socket.shutdownOutput()

shutdownInput

public final ChannelFuture shutdownInput()

Specified by:

shutdownInput in interface DuplexChannel

See Also:

• Socket.shutdownInput()

shutdownInput

public final ChannelFuture shutdownInput(ChannelPromise promise)

Description copied from interface: DuplexChannel

Will shutdown the input and notify ChannelPromise.

Specified by:

shutdownInput in interface DuplexChannel

See Also:

• Socket.shutdownInput()

shutdownOutputDone

private void shutdownOutputDone(ChannelFuture shutdownOutputFuture,
 ChannelPromise promise)

shutdownDone

private static void shutdownDone(ChannelFuture shutdownOutputFuture,
 ChannelFuture shutdownInputFuture,
 ChannelPromise promise)

doRegister

protected final 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 AbstractIoUringChannel

Parameters:

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

filterOutboundMessage

protected Object filterOutboundMessage(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 AbstractIoUringChannel

cancelOutstandingReads

protected final void cancelOutstandingReads(IoRegistration registration,
 int numOutstandingReads)

Description copied from class: AbstractIoUringChannel

Cancel all outstanding reads

Specified by:

cancelOutstandingReads in class AbstractIoUringChannel

Parameters:

registration - the IoRegistration.

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

cancelOutstandingWrites

protected final void cancelOutstandingWrites(IoRegistration registration,
 int numOutstandingWrites)

Description copied from class: AbstractIoUringChannel

Cancel all outstanding writes

Specified by:

cancelOutstandingWrites in class AbstractIoUringChannel

Parameters:

registration - the IoRegistration.

numOutstandingWrites - the number of outstanding writes.

socketIsEmpty

protected boolean socketIsEmpty(int flags)

Description copied from class: AbstractIoUringChannel

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

Specified by:

socketIsEmpty in class AbstractIoUringChannel

Parameters:

flags - the flags that were part of the completion

Returns:

true if empty.

shouldCompleteReadLoop

protected boolean shouldCompleteReadLoop(int flags,
 boolean multishot)

isPollInFirst

boolean isPollInFirst()

Specified by:

isPollInFirst in class AbstractIoUringChannel