Class IoUringDatagramChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.uring.IoUringDatagramChannel

All Implemented Interfaces:

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

public final class IoUringDatagramChannel
extends AbstractChannel
implements DatagramChannel

Nested Class Summary

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

Constructor Summary

Constructors

Constructor	Description
IoUringDatagramChannel()	Create a new instance which selects the SocketProtocolFamily to use depending on the Operation Systems default which will be chosen.
IoUringDatagramChannel(int fd)	Create a new instance which selects the SocketProtocolFamily to use depending on the Operation Systems default which will be chosen.
IoUringDatagramChannel(SocketProtocolFamily family)	Create a new instance using the given SocketProtocolFamily.

Method Summary

Modifier and Type	Method	Description
protected boolean	allowMultiShotPollIn()
ChannelFuture	block(InetAddress multicastAddress, InetAddress sourceToBlock)	Block the given sourceToBlock address for the given multicastAddress and notifies the ChannelFuture once the operation completes.
ChannelFuture	block(InetAddress multicastAddress, InetAddress sourceToBlock, ChannelPromise promise)	Block the given sourceToBlock address for the given multicastAddress and notifies the ChannelFuture once the operation completes.
ChannelFuture	block(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress sourceToBlock)	Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the ChannelFuture once the operation completes.
ChannelFuture	block(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress sourceToBlock, ChannelPromise promise)	Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the ChannelFuture once the operation completes.
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(InetSocketAddress addr)
DatagramChannelConfig	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 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 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.
boolean	isConnected()	Return true if the DatagramChannel is connected to the remote peer.
final boolean	isOpen()	Returns true if the Channel is open and may get active later
static boolean	isSegmentedDatagramPacketSupported()	Returns true if the usage of SegmentedDatagramPacket is supported.
ChannelFuture	joinGroup(InetAddress multicastAddress)	Joins a multicast group and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(InetAddress multicastAddress, ChannelPromise promise)	Joins a multicast group and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source)	Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, ChannelPromise promise)	Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface)	Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface, ChannelPromise promise)	Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(InetAddress multicastAddress)	Leaves a multicast group and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(InetAddress multicastAddress, ChannelPromise promise)	Leaves a multicast group and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source)	Leave the specified multicast group at the specified interface using the specified source and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, ChannelPromise promise)	Leave the specified multicast group at the specified interface using the specified source and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface)	Leaves a multicast group on a specified local interface and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface, ChannelPromise promise)	Leaves a multicast group on a specified local interface and notifies the ChannelFuture once the operation completes.
InetSocketAddress	localAddress()	Returns the local address where this channel is bound to.
protected final 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 final ByteBuf	newDirectBuffer(ByteBuf buf)
protected final ByteBuf	newDirectBuffer(Object holder, ByteBuf buf)
protected AbstractChannel.AbstractUnsafe	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()
InetSocketAddress	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, doShutdownOutput, equals, eventLoop, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, maxMessagesPerWrite, newChannelPipeline, newId, parent, pipeline, 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, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, eventLoop, flush, getOption, id, isOpen, isRegistered, isWritable, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, setOption, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface Comparable

compareTo

Field Details

active

protected volatile boolean active

Constructor Details

IoUringDatagramChannel

public IoUringDatagramChannel()

Create a new instance which selects the SocketProtocolFamily to use depending on the Operation Systems default which will be chosen.

IoUringDatagramChannel

public IoUringDatagramChannel(SocketProtocolFamily family)

Create a new instance using the given SocketProtocolFamily. If null is used it will depend on the Operation Systems default which will be chosen.

IoUringDatagramChannel

public IoUringDatagramChannel(int fd)

Create a new instance which selects the SocketProtocolFamily to use depending on the Operation Systems default which will be chosen.

Method Details

remoteAddress

public InetSocketAddress 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 DatagramChannel

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.

localAddress

public InetSocketAddress 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 DatagramChannel

Overrides:

localAddress in class AbstractChannel

Returns:

the local address of this channel. null if this channel is not bound.

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

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

isConnected

public boolean isConnected()

Description copied from interface: DatagramChannel

Return true if the DatagramChannel is connected to the remote peer.

Specified by:

isConnected in interface DatagramChannel

joinGroup

public ChannelFuture joinGroup(InetAddress multicastAddress)

Description copied from interface: DatagramChannel

Joins a multicast group and notifies the ChannelFuture once the operation completes.

Specified by:

joinGroup in interface DatagramChannel

joinGroup

public ChannelFuture joinGroup(InetAddress multicastAddress,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Joins a multicast group and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

joinGroup in interface DatagramChannel

joinGroup

public ChannelFuture joinGroup(InetSocketAddress multicastAddress,
 NetworkInterface networkInterface)

Description copied from interface: DatagramChannel

Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.

Specified by:

joinGroup in interface DatagramChannel

joinGroup

public ChannelFuture joinGroup(InetSocketAddress multicastAddress,
 NetworkInterface networkInterface,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

joinGroup in interface DatagramChannel

joinGroup

public ChannelFuture joinGroup(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress source)

Description copied from interface: DatagramChannel

Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.

Specified by:

joinGroup in interface DatagramChannel

joinGroup

public ChannelFuture joinGroup(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress source,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

joinGroup in interface DatagramChannel

leaveGroup

public ChannelFuture leaveGroup(InetAddress multicastAddress)

Description copied from interface: DatagramChannel

Leaves a multicast group and notifies the ChannelFuture once the operation completes.

Specified by:

leaveGroup in interface DatagramChannel

leaveGroup

public ChannelFuture leaveGroup(InetAddress multicastAddress,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Leaves a multicast group and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

leaveGroup in interface DatagramChannel

leaveGroup

public ChannelFuture leaveGroup(InetSocketAddress multicastAddress,
 NetworkInterface networkInterface)

Description copied from interface: DatagramChannel

Leaves a multicast group on a specified local interface and notifies the ChannelFuture once the operation completes.

Specified by:

leaveGroup in interface DatagramChannel

leaveGroup

public ChannelFuture leaveGroup(InetSocketAddress multicastAddress,
 NetworkInterface networkInterface,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Leaves a multicast group on a specified local interface and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

leaveGroup in interface DatagramChannel

leaveGroup

public ChannelFuture leaveGroup(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress source)

Description copied from interface: DatagramChannel

Leave the specified multicast group at the specified interface using the specified source and notifies the ChannelFuture once the operation completes.

Specified by:

leaveGroup in interface DatagramChannel

leaveGroup

public ChannelFuture leaveGroup(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress source,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Leave the specified multicast group at the specified interface using the specified source and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

leaveGroup in interface DatagramChannel

block

public ChannelFuture block(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress sourceToBlock)

Description copied from interface: DatagramChannel

Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

block in interface DatagramChannel

block

public ChannelFuture block(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress sourceToBlock,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

block in interface DatagramChannel

block

public ChannelFuture block(InetAddress multicastAddress,
 InetAddress sourceToBlock)

Description copied from interface: DatagramChannel

Block the given sourceToBlock address for the given multicastAddress and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

block in interface DatagramChannel

block

public ChannelFuture block(InetAddress multicastAddress,
 InetAddress sourceToBlock,
 ChannelPromise promise)

Description copied from interface: DatagramChannel

Block the given sourceToBlock address for the given multicastAddress and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

Specified by:

block in interface DatagramChannel

newUnsafe

protected AbstractChannel.AbstractUnsafe 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

doBind

protected void doBind(SocketAddress localAddress)
               throws Exception

Description copied from class: AbstractChannel

Bind the Channel to the SocketAddress

Throws:

Exception

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)

config

public DatagramChannelConfig config()

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

config in interface Channel

Specified by:

config in interface DatagramChannel

doDisconnect

protected void doDisconnect()
                     throws Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Throws:

Exception

doClose

protected void doClose()
                throws Exception

Description copied from class: AbstractChannel

Close the Channel

Throws:

Exception

isSegmentedDatagramPacketSupported

public static boolean isSegmentedDatagramPacketSupported()

Returns true if the usage of SegmentedDatagramPacket is supported.

Returns:

true if supported, false otherwise.

cancelOutstandingReads

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

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)

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()

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