Package io.netty.channel.uring

Class IoUringDatagramChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.uring.AbstractIoUringChannel

io.netty.channel.uring.IoUringDatagramChannel

All Implemented Interfaces:

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

public final class IoUringDatagramChannel
extends AbstractIoUringChannel
implements DatagramChannel

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private class	IoUringDatagramChannel.IoUringDatagramChannelUnsafe

Nested classes/interfaces inherited from class io.netty.channel.uring.AbstractIoUringChannel

AbstractIoUringChannel.AbstractUringUnsafe

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
private IoUringDatagramChannelConfig	config
private boolean	connected
private static java.lang.String	EXPECTED_TYPES
private static boolean	IP_MULTICAST_ALL
private static InternalLogger	logger
private static ChannelMetadata	METADATA
private MsgHdrMemoryArray	recvmsgHdrs
private MsgHdrMemoryArray	sendmsgHdrs
private int[]	sendmsgResArray

Fields inherited from class io.netty.channel.uring.AbstractIoUringChannel

active, socket, writeTracker

Constructor Summary

Constructors

Modifier	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.
private	IoUringDatagramChannel(LinuxSocket fd, boolean active)

Method Summary

Modifier and Type	Method	Description
ChannelFuture	block(java.net.InetAddress multicastAddress, java.net.InetAddress sourceToBlock)	Block the given sourceToBlock address for the given multicastAddress and notifies the ChannelFuture once the operation completes.
ChannelFuture	block(java.net.InetAddress multicastAddress, java.net.InetAddress sourceToBlock, ChannelPromise promise)	Block the given sourceToBlock address for the given multicastAddress and notifies the ChannelFuture once the operation completes.
ChannelFuture	block(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.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(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.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.
private int	cancel(IoRegistration registration, byte op, MsgHdrMemoryArray array)
protected void	cancelOutstandingReads(IoRegistration registration, int numOutstandingReads)	Cancel all outstanding reads
protected void	cancelOutstandingWrites(IoRegistration registration, int numOutstandingWrites)	Cancel all outstanding writes
private static void	checkUnresolved(AddressedEnvelope<?,?> envelope)
DatagramChannelConfig	config()	Returns the configuration of this channel.
protected void	doBind(java.net.SocketAddress localAddress)	Bind the Channel to the SocketAddress
protected void	doClose()	Close the Channel
protected void	doDisconnect()	Disconnect this Channel from its remote peer
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.
boolean	isConnected()	Return true if the DatagramChannel is connected to the remote peer.
(package private) boolean	isPollInFirst()
static boolean	isSegmentedDatagramPacketSupported()	Returns true if the usage of SegmentedDatagramPacket is supported.
protected boolean	isStreamSocket()
ChannelFuture	joinGroup(java.net.InetAddress multicastAddress)	Joins a multicast group and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(java.net.InetAddress multicastAddress, ChannelPromise promise)	Joins a multicast group and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress source)	Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress source, ChannelPromise promise)	Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(java.net.InetSocketAddress multicastAddress, java.net.NetworkInterface networkInterface)	Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(java.net.InetSocketAddress multicastAddress, java.net.NetworkInterface networkInterface, ChannelPromise promise)	Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(java.net.InetAddress multicastAddress)	Leaves a multicast group and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(java.net.InetAddress multicastAddress, ChannelPromise promise)	Leaves a multicast group and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.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(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.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(java.net.InetSocketAddress multicastAddress, java.net.NetworkInterface networkInterface)	Leaves a multicast group on a specified local interface and notifies the ChannelFuture once the operation completes.
ChannelFuture	leaveGroup(java.net.InetSocketAddress multicastAddress, java.net.NetworkInterface networkInterface, ChannelPromise promise)	Leaves a multicast group on a specified local interface and notifies the ChannelFuture once the operation completes.
java.net.InetSocketAddress	localAddress()	Returns the local address where this channel is bound to.
ChannelMetadata	metadata()	Return the ChannelMetadata of the Channel which describe the nature of the Channel.
protected AbstractChannel.AbstractUnsafe	newUnsafe()	Create a new AbstractChannel.AbstractUnsafe instance which will be used for the life-time of the Channel
java.net.InetSocketAddress	remoteAddress()	Returns the remote address where this channel is connected to.
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.
private static java.io.IOException	translateForConnected(Errors.NativeIoException e)
private static boolean	useIpv6(SocketProtocolFamily family)

Methods inherited from class io.netty.channel.uring.AbstractIoUringChannel

allowMultiShotPollIn, autoReadCleared, checkResolvable, doBeginRead, doDeregister, doRegister, doShutdownOutput, doShutdownOutput0, doWrite, fd, isCompatible, isOpen, localAddress0, newDirectBuffer, newDirectBuffer, nextOpsId, registration, remoteAddress0, resetCachedAddresses, schedulePollRdHup, scheduleWriteIfNeeded, 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, isOpen, isRegistered, isWritable, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, setOption, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

logger

private static final InternalLogger logger

IP_MULTICAST_ALL

private static final boolean IP_MULTICAST_ALL

METADATA

private static final ChannelMetadata METADATA

EXPECTED_TYPES

private static final java.lang.String EXPECTED_TYPES

config

private final IoUringDatagramChannelConfig config

connected

private volatile boolean connected

recvmsgHdrs

private final MsgHdrMemoryArray recvmsgHdrs

sendmsgHdrs

private final MsgHdrMemoryArray sendmsgHdrs

sendmsgResArray

private final int[] sendmsgResArray

Constructor Detail

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.

IoUringDatagramChannel

private IoUringDatagramChannel(LinuxSocket fd,
                               boolean active)

Method Detail

useIpv6

private static boolean useIpv6(SocketProtocolFamily family)

isStreamSocket

protected boolean isStreamSocket()

Specified by:

isStreamSocket in class AbstractIoUringChannel

remoteAddress

public java.net.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 java.net.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

Overrides:

isActive in class AbstractIoUringChannel

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(java.net.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(java.net.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(java.net.InetSocketAddress multicastAddress,
                               java.net.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(java.net.InetSocketAddress multicastAddress,
                               java.net.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(java.net.InetAddress multicastAddress,
                               java.net.NetworkInterface networkInterface,
                               java.net.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(java.net.InetAddress multicastAddress,
                               java.net.NetworkInterface networkInterface,
                               java.net.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(java.net.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(java.net.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(java.net.InetSocketAddress multicastAddress,
                                java.net.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(java.net.InetSocketAddress multicastAddress,
                                java.net.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(java.net.InetAddress multicastAddress,
                                java.net.NetworkInterface networkInterface,
                                java.net.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(java.net.InetAddress multicastAddress,
                                java.net.NetworkInterface networkInterface,
                                java.net.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(java.net.InetAddress multicastAddress,
                           java.net.NetworkInterface networkInterface,
                           java.net.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(java.net.InetAddress multicastAddress,
                           java.net.NetworkInterface networkInterface,
                           java.net.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(java.net.InetAddress multicastAddress,
                           java.net.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(java.net.InetAddress multicastAddress,
                           java.net.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(java.net.SocketAddress localAddress)
               throws java.lang.Exception

Description copied from class: AbstractChannel

Bind the Channel to the SocketAddress

Overrides:

doBind in class AbstractIoUringChannel

Throws:

java.lang.Exception

checkUnresolved

private static void checkUnresolved(AddressedEnvelope<?,?> envelope)

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 AbstractIoUringChannel

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 java.lang.Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Overrides:

doDisconnect in class AbstractIoUringChannel

Throws:

java.lang.Exception

doClose

protected void doClose()
                throws java.lang.Exception

Description copied from class: AbstractChannel

Close the Channel

Overrides:

doClose in class AbstractIoUringChannel

Throws:

java.lang.Exception

translateForConnected

private static java.io.IOException translateForConnected(Errors.NativeIoException e)

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)

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

cancel

private int cancel(IoRegistration registration,
                   byte op,
                   MsgHdrMemoryArray array)

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.

isPollInFirst

boolean isPollInFirst()

Specified by:

isPollInFirst in class AbstractIoUringChannel