java.lang.Object
- io.netty.util.DefaultAttributeMap
- - io.netty.channel.AbstractChannel
  - - io.netty.channel.uring.IoUringDomainSocketChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, DuplexChannel, DomainSocketChannel, UnixChannel, AttributeMap, java.lang.Comparable<Channel>
```
public final class IoUringDomainSocketChannel
extends AbstractChannel
implements DomainSocketChannel
```
DomainSocketChannel implementation that uses linux io_uring

Nested Class Summary
- Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel
  AbstractChannel.AbstractUnsafe
- Nested classes/interfaces inherited from interface io.netty.channel.Channel
  Channel.Unsafe

Field Summary

Fields
Modifier and Type Field Description

protected boolean active

Constructor Summary

Constructors
Constructor Description

IoUringDomainSocketChannel()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected boolean`	`allowMultiShotPollIn()`
`protected void`	`cancelOutstandingReads(IoRegistration registration, int numOutstandingReads)`	Cancel all outstanding reads
`protected void`	`cancelOutstandingWrites(IoRegistration registration, int numOutstandingWrites)`	Cancel all outstanding writes
`protected static void`	`checkResolvable(java.net.InetSocketAddress addr)`
`DomainSocketChannelConfig`	`config()`	Returns the configuration of this channel.
`protected void`	`doBeginRead()`	Schedule a read operation.
`protected void`	`doBind(java.net.SocketAddress local)`	Bind the `Channel` to the `SocketAddress`
`protected void`	`doClose()`	Close the `Channel`
`protected 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 void`	`doShutdownOutput()`	Called when conditions justify shutting down the output portion of the channel.
`protected void`	`doWrite(ChannelOutboundBuffer in)`	Flush the content of the given buffer to the remote peer.
`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.
`boolean`	`isActive()`	Return `true` if the `Channel` is active and so connected.
`protected boolean`	`isCompatible(EventLoop loop)`	Return `true` if the given `EventLoop` is compatible with this instance.
`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.
`boolean`	`isOpen()`	Returns `true` if the `Channel` is open and may get active later
`boolean`	`isOutputShutdown()`
`boolean`	`isShutdown()`	Determine if both the input and output of this channel have been shutdown.
`DomainSocketAddress`	`localAddress()`	Returns the local address where this channel is bound to.
`protected java.net.SocketAddress`	`localAddress0()`	Returns the `SocketAddress` which is bound locally.
`ChannelMetadata`	`metadata()`	Return the `ChannelMetadata` of the `Channel` which describe the nature of the `Channel`.
`protected ByteBuf`	`newDirectBuffer(ByteBuf buf)`
`protected ByteBuf`	`newDirectBuffer(java.lang.Object holder, ByteBuf buf)`
`protected io.netty.channel.uring.AbstractIoUringChannel.AbstractUringUnsafe`	`newUnsafe()`	Create a new `AbstractChannel.AbstractUnsafe` instance which will be used for the life-time of the `Channel`
`protected short`	`nextOpsId()`	Returns the next id that should be used when submitting `IoUringIoOps`.
`PeerCredentials`	`peerCredentials()`	Returns the unix credentials (uid, gid, pid) of the peer SO_PEERCRED
`protected IoRegistration`	`registration()`
`DomainSocketAddress`	`remoteAddress()`	Returns the remote address where this channel is connected to.
`protected java.net.SocketAddress`	`remoteAddress0()`	Return the `SocketAddress` which the `Channel` is connected to.
`protected void`	`scheduleWriteIfNeeded(ChannelOutboundBuffer in, boolean submitAndRunNow)`
`ChannelFuture`	`shutdown()`	Will shutdown the input and output sides of this channel.
`ChannelFuture`	`shutdown(ChannelPromise promise)`	Will shutdown the input and output sides of this channel.
`ChannelFuture`	`shutdownInput()`
`ChannelFuture`	`shutdownInput(ChannelPromise promise)`	Will shutdown the input and notify `ChannelPromise`.
`ChannelFuture`	`shutdownOutput()`
`ChannelFuture`	`shutdownOutput(ChannelPromise promise)`	Will shutdown the output and notify `ChannelPromise`.
`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.
`protected void`	`submitAndRunNow()`

Methods inherited from class io.netty.channel.AbstractChannel
closeFuture, compareTo, doRegister, equals, eventLoop, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, maxMessagesPerWrite, newChannelPipeline, newId, parent, pipeline, toString, unsafe, validateFileRegion, voidPromise

Methods inherited from class io.netty.util.DefaultAttributeMap
attr, hasAttr

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.netty.util.AttributeMap
attr, hasAttr

Methods inherited from interface io.netty.channel.Channel
alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, eventLoop, flush, getOption, id, isActive, isOpen, isRegistered, isWritable, metadata, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, setOption, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface java.lang.Comparable
compareTo

Methods inherited from interface io.netty.channel.socket.DuplexChannel
isInputShutdown, isOutputShutdown, isShutdown, shutdown, shutdown, shutdownInput, shutdownInput, shutdownOutput, shutdownOutput

Methods inherited from interface io.netty.channel.unix.UnixChannel
fd

- Field Detail
  - active
```
protected volatile boolean active
```
- Constructor Detail
  - IoUringDomainSocketChannel
```
public IoUringDomainSocketChannel()
```
- Method Detail
  - config
```
public DomainSocketChannelConfig config()
```
    Description copied from interface: Channel
    
    Returns the configuration of this channel.
    
    Specified by:
    
    config in interface Channel
    
    Specified by:
    
    config in interface DomainSocketChannel
  - localAddress
```
public DomainSocketAddress localAddress()
```
    Description copied from interface: Channel
    
    Returns the local address where this channel is bound to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.
    
    Specified by:
    
    localAddress in interface Channel
    
    Specified by:
    
    localAddress in interface DomainSocketChannel
    
    Overrides:
    
    localAddress in class AbstractChannel
    
    Returns:
    
    the local address of this channel. null if this channel is not bound.
  - remoteAddress
```
public DomainSocketAddress remoteAddress()
```
    Description copied from interface: Channel
    
    Returns the remote address where this channel is connected to. The returned SocketAddress is supposed to be down-cast into more concrete type such as InetSocketAddress to retrieve the detailed information.
    
    Specified by:
    
    remoteAddress in interface Channel
    
    Specified by:
    
    remoteAddress in interface DomainSocketChannel
    
    Overrides:
    
    remoteAddress in class AbstractChannel
    
    Returns:
    
    the remote address of this channel. null if this channel is not connected. If this channel is not connected but it can receive messages from arbitrary remote addresses (e.g. DatagramChannel, use DefaultAddressedEnvelope.recipient() to determine the origination of the received message as this method will return null.
  - peerCredentials
```
public PeerCredentials peerCredentials()
                                throws java.io.IOException
```
    Returns the unix credentials (uid, gid, pid) of the peer SO_PEERCRED
    
    Throws:
    
    java.io.IOException
  - 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)
  - newUnsafe
```
protected io.netty.channel.uring.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
  - allowMultiShotPollIn
```
protected boolean allowMultiShotPollIn()
```
  - 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
  - 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.
  - 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
  - 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()
  - 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
    
    Parameters:
    
    promise - ChannelPromise that must be notified once done to continue the registration.
  - cancelOutstandingReads
```
protected final 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 final void cancelOutstandingWrites(IoRegistration registration,
                                             int numOutstandingWrites)
```
    Cancel all outstanding writes
    
    Parameters:
    
    registration - the IoRegistration.
    
    numOutstandingWrites - the number of outstanding writes.
  - socketIsEmpty
```
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.
    
    Parameters:
    
    flags - the flags that were part of the completion
    
    Returns:
    
    true if empty.
  - 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
  - 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)
```
  - newDirectBuffer
```
protected final ByteBuf newDirectBuffer(java.lang.Object holder,
                                        ByteBuf buf)
```
  - 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
  - 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
  - doBeginRead
```
protected final void doBeginRead()
```
    Description copied from class: AbstractChannel
    
    Schedule a read operation.
    
    Specified by:
    
    doBeginRead in class AbstractChannel
  - 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()
```
  - registration
```
protected final IoRegistration 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

Class IoUringDomainSocketChannel

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel

Nested classes/interfaces inherited from interface io.netty.channel.Channel

Field Summary

Constructor Summary

Method Summary

Methods inherited from class io.netty.channel.AbstractChannel

Methods inherited from class io.netty.util.DefaultAttributeMap

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.util.AttributeMap

Methods inherited from interface io.netty.channel.Channel

Methods inherited from interface java.lang.Comparable

Methods inherited from interface io.netty.channel.socket.DuplexChannel

Methods inherited from interface io.netty.channel.unix.UnixChannel

Field Detail

active

Constructor Detail

IoUringDomainSocketChannel

Method Detail

config

localAddress

remoteAddress

peerCredentials

filterOutboundMessage

newUnsafe

allowMultiShotPollIn

metadata

shutdown

shutdown

doShutdownOutput

isOutputShutdown

isInputShutdown

isShutdown

shutdownOutput

shutdownOutput

shutdownInput

shutdownInput

doRegister

cancelOutstandingReads

cancelOutstandingWrites

socketIsEmpty

nextOpsId

isOpen

isActive

fd

isCompatible

newDirectBuffer

newDirectBuffer

doDisconnect

doClose

doBeginRead

doWrite

scheduleWriteIfNeeded

submitAndRunNow

registration

doDeregister

doBind

checkResolvable

localAddress0

remoteAddress0