Class IoUringServerDomainSocketChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.uring.IoUringServerDomainSocketChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, ServerChannel, ServerDomainSocketChannel, UnixChannel, AttributeMap, Comparable<Channel>

public final class IoUringServerDomainSocketChannel
extends AbstractChannel
implements ServerDomainSocketChannel

Nested Class Summary

Nested classes/interfaces inherited from class AbstractChannel

AbstractChannel.AbstractUnsafe

Modifier and Type	Class	Description
protected class	AbstractChannel.AbstractUnsafe	Channel.Unsafe implementation which sub-classes must extend and use.

Nested classes/interfaces inherited from interface Channel

Channel.Unsafe

Modifier and Type	Interface	Description
static interface	Channel.Unsafe	Unsafe operations that should never be called from user-code.

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	active

Constructor Summary

Constructors

Constructor	Description
IoUringServerDomainSocketChannel()

Method Summary

Modifier and Type	Method	Description
protected boolean	allowMultiShotPollIn()
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 static void	checkResolvable(InetSocketAddress addr)
ChannelConfig	config()	Returns the configuration of this channel.
protected final void	doBeginRead()	Schedule a read operation.
protected void	doBind(SocketAddress localAddress)	Bind the Channel to the SocketAddress
protected final 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()	Retains every in-flight write's references before handing off to doShutdownOutput0(), so a write completion that races the shutdown still finds a live reference to release instead of one the outbound buffer already dropped.
protected void	doShutdownOutput0()	Performs the actual output shutdown.
protected final 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 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.
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.
final boolean	isOpen()	Returns true if the Channel is open and may get active later
protected final boolean	isStreamSocket()
DomainSocketAddress	localAddress()	Returns the local address where this channel is bound to.
protected final SocketAddress	localAddress0()	Returns the SocketAddress which is bound locally.
final ChannelMetadata	metadata()	Return the ChannelMetadata of the Channel which describe the nature of the Channel.
protected final ByteBuf	newDirectBuffer(ByteBuf buf)
protected final ByteBuf	newDirectBuffer(Object holder, ByteBuf buf)
protected final 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 final short	nextOpsId()	Returns the next id that should be used when submitting IoUringIoOps.
protected final IoRegistration	registration()
DomainSocketAddress	remoteAddress()	Returns the remote address where this channel is connected to.
protected final SocketAddress	remoteAddress0()	Return the SocketAddress which the Channel is connected to.
protected void	scheduleWriteIfNeeded(ChannelOutboundBuffer in, boolean submitAndRunNow)
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 AbstractChannel

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

Modifier and Type	Method	Description
ChannelFuture	closeFuture()	Returns the ChannelFuture which will be notified when this channel is closed.
final int	compareTo(Channel o)
protected void	doRegister()	Deprecated. use AbstractChannel.doRegister(ChannelPromise)
final boolean	equals(Object o)	Returns true if and only if the specified object is identical with this channel (i.e: this == o).
EventLoop	eventLoop()	Return the EventLoop this Channel was registered to.
final int	hashCode()	Returns the ID of this channel.
final ChannelId	id()	Returns the globally unique identifier of this Channel.
protected void	invalidateLocalAddress()	Deprecated. no use-case for this.
protected void	invalidateRemoteAddress()	Deprecated. no use-case for this.
boolean	isRegistered()	Returns true if the Channel is registered with an EventLoop.
protected final int	maxMessagesPerWrite()
protected DefaultChannelPipeline	newChannelPipeline()	Returns a new DefaultChannelPipeline instance.
protected ChannelId	newId()	Returns a new DefaultChannelId instance.
Channel	parent()	Returns the parent of this channel.
ChannelPipeline	pipeline()	Return the assigned ChannelPipeline.
String	toString()	Returns the String representation of this channel.
Channel.Unsafe	unsafe()	Returns an internal-use-only object that provides unsafe operations.
protected void	validateFileRegion(DefaultFileRegion region, long position)
final ChannelPromise	voidPromise()	Return a special ChannelPromise which can be reused for different operations.

Methods inherited from class DefaultAttributeMap

attr, hasAttr

Modifier and Type	Method	Description
<T> Attribute<T>	attr(AttributeKey<T> key)	Get the Attribute for the given AttributeKey.
<T> boolean	hasAttr(AttributeKey<T> key)	Returns true if and only if the given Attribute exists in this AttributeMap.

Methods inherited from class Object

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

Methods inherited from interface Channel

alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, flush, getOption, isWritable, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, read, setOption, write, write, writeAndFlush, writeAndFlush

Modifier and Type	Method	Description
default ByteBufAllocator	alloc()	Return the assigned ByteBufAllocator which will be used to allocate ByteBufs.
default ChannelFuture	bind(SocketAddress localAddress)	Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	bind(SocketAddress localAddress, ChannelPromise promise)	Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default long	bytesBeforeUnwritable()	Get how many bytes can be written until Channel.isWritable() returns false.
default long	bytesBeforeWritable()	Get how many bytes must be drained from underlying buffers until Channel.isWritable() returns true.
default ChannelFuture	close()	Request to close the Channel and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	close(ChannelPromise promise)	Request to close the Channel and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	connect(SocketAddress remoteAddress)	Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	connect(SocketAddress remoteAddress, ChannelPromise promise)	Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	connect(SocketAddress remoteAddress, SocketAddress localAddress)	Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	connect(SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)	Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	deregister()	Request to deregister from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	deregister(ChannelPromise promise)	Request to deregister from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	disconnect()	Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default ChannelFuture	disconnect(ChannelPromise promise)	Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
default Channel	flush()	Request to flush all pending messages via this ChannelOutboundInvoker.
default <T> T	getOption(ChannelOption<T> option)	Return the value of the given ChannelOption
default boolean	isWritable()	Returns true if and only if the I/O thread will perform the requested write operation immediately.
default ChannelFuture	newFailedFuture(Throwable cause)	Create a new ChannelFuture which is marked as failed already.
default ChannelProgressivePromise	newProgressivePromise()	Return an new ChannelProgressivePromise
default ChannelPromise	newPromise()	Return a new ChannelPromise.
default ChannelFuture	newSucceededFuture()	Create a new ChannelFuture which is marked as succeeded already.
default Channel	read()	Request to Read data from the Channel into the first inbound buffer, triggers an ChannelInboundHandler.channelRead(ChannelHandlerContext, Object) event if data was read, and triggers a channelReadComplete event so the handler can decide to continue reading.
default <T> boolean	setOption(ChannelOption<T> option, T value)	Sets a configuration property with the specified name and value.
default ChannelFuture	write(Object msg)	Request to write a message via this ChannelHandlerContext through the ChannelPipeline.
default ChannelFuture	write(Object msg, ChannelPromise promise)	Request to write a message via this ChannelHandlerContext through the ChannelPipeline.
default ChannelFuture	writeAndFlush(Object msg)	Shortcut for call ChannelOutboundInvoker.write(Object) and ChannelOutboundInvoker.flush().
default ChannelFuture	writeAndFlush(Object msg, ChannelPromise promise)	Shortcut for call ChannelOutboundInvoker.write(Object, ChannelPromise) and ChannelOutboundInvoker.flush().

Field Details

active

protected volatile boolean active

Constructor Details

IoUringServerDomainSocketChannel

public IoUringServerDomainSocketChannel()

Method Details

config

public ChannelConfig config()

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

config in interface Channel

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 ServerDomainSocketChannel

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 ServerDomainSocketChannel

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.

doBind

protected void doBind(SocketAddress localAddress)
               throws Exception

Description copied from class: AbstractChannel

Bind the Channel to the SocketAddress

Throws:

Exception

isStreamSocket

protected final boolean isStreamSocket()

metadata

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

doClose

protected final void doClose()
                      throws Exception

Description copied from class: AbstractChannel

Close the Channel

Throws:

Exception

newUnsafe

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

Specified by:

newUnsafe in class AbstractChannel

doWrite

protected final void doWrite(ChannelOutboundBuffer in)

Description copied from class: AbstractChannel

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

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)

allowMultiShotPollIn

protected boolean allowMultiShotPollIn()

newDirectBuffer

protected final ByteBuf newDirectBuffer(Object holder,
 ByteBuf buf)

doDisconnect

protected void doDisconnect()
                     throws Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Specified by:

doDisconnect in class AbstractChannel

Throws:

Exception

doShutdownOutput

protected final void doShutdownOutput()
                               throws Exception

Retains every in-flight write's references before handing off to doShutdownOutput0(), so a write completion that races the shutdown still finds a live reference to release instead of one the outbound buffer already dropped.

Overrides:

doShutdownOutput in class AbstractChannel

Throws:

Exception

doShutdownOutput0

protected void doShutdownOutput0()
                          throws Exception

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

Throws:

Exception

doBeginRead

protected final void doBeginRead()

Description copied from class: AbstractChannel

Schedule a read operation.

Specified by:

doBeginRead in class AbstractChannel

scheduleWriteIfNeeded

protected void scheduleWriteIfNeeded(ChannelOutboundBuffer in,
 boolean submitAndRunNow)

submitAndRunNow

protected void submitAndRunNow()

registration

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

checkResolvable

protected static void checkResolvable(InetSocketAddress addr)

localAddress0

protected final SocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 in class AbstractChannel

remoteAddress0

protected final SocketAddress remoteAddress0()

Description copied from class: AbstractChannel

Return the SocketAddress which the Channel is connected to.

Specified by:

remoteAddress0 in class AbstractChannel