Package io.netty.channel.uring
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
,java.lang.Comparable<Channel>
public final class IoUringDatagramChannel extends AbstractChannel implements DatagramChannel
-
-
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 IoUringDatagramChannel()
Create a new instance which selects theSocketProtocolFamily
to use depending on the Operation Systems default which will be chosen.IoUringDatagramChannel(int fd)
Create a new instance which selects theSocketProtocolFamily
to use depending on the Operation Systems default which will be chosen.IoUringDatagramChannel(SocketProtocolFamily family)
Create a new instance using the givenSocketProtocolFamily
.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods 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 theChannelFuture
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 theChannelFuture
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 theChannelFuture
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 theChannelFuture
once the operation completes.protected void
cancelOutstandingReads(IoRegistration registration, int numOutstandingReads)
Cancel all outstanding readsprotected void
cancelOutstandingWrites(IoRegistration registration, int numOutstandingWrites)
Cancel all outstanding writesprotected static void
checkResolvable(java.net.InetSocketAddress addr)
DatagramChannelConfig
config()
Returns the configuration of this channel.protected void
doBeginRead()
Schedule a read operation.protected void
doBind(java.net.SocketAddress localAddress)
Bind theChannel
to theSocketAddress
protected void
doClose()
Close theChannel
protected void
doDeregister()
protected void
doDisconnect()
Disconnect thisChannel
from its remote peerprotected void
doRegister(ChannelPromise promise)
protected void
doWrite(ChannelOutboundBuffer in)
Flush the content of the given buffer to the remote peer.FileDescriptor
fd()
Returns theFileDescriptor
that is used by thisChannel
.protected java.lang.Object
filterOutboundMessage(java.lang.Object msg)
Invoked when a new message is added to aChannelOutboundBuffer
of thisAbstractChannel
, so that theChannel
implementation converts the message to another.boolean
isActive()
Returntrue
if theChannel
is active and so connected.protected boolean
isCompatible(EventLoop loop)
Returntrue
if the givenEventLoop
is compatible with this instance.boolean
isConnected()
Returntrue
if theDatagramChannel
is connected to the remote peer.boolean
isOpen()
Returnstrue
if theChannel
is open and may get active laterstatic boolean
isSegmentedDatagramPacketSupported()
Returnstrue
if the usage ofSegmentedDatagramPacket
is supported.ChannelFuture
joinGroup(java.net.InetAddress multicastAddress)
Joins a multicast group and notifies theChannelFuture
once the operation completes.ChannelFuture
joinGroup(java.net.InetAddress multicastAddress, ChannelPromise promise)
Joins a multicast group and notifies theChannelFuture
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 theChannelFuture
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 theChannelFuture
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 theChannelFuture
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 theChannelFuture
once the operation completes.ChannelFuture
leaveGroup(java.net.InetAddress multicastAddress)
Leaves a multicast group and notifies theChannelFuture
once the operation completes.ChannelFuture
leaveGroup(java.net.InetAddress multicastAddress, ChannelPromise promise)
Leaves a multicast group and notifies theChannelFuture
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 theChannelFuture
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 theChannelFuture
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 theChannelFuture
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 theChannelFuture
once the operation completes.java.net.InetSocketAddress
localAddress()
Returns the local address where this channel is bound to.protected java.net.SocketAddress
localAddress0()
Returns theSocketAddress
which is bound locally.ChannelMetadata
metadata()
protected ByteBuf
newDirectBuffer(ByteBuf buf)
protected ByteBuf
newDirectBuffer(java.lang.Object holder, ByteBuf buf)
protected AbstractChannel.AbstractUnsafe
newUnsafe()
Create a newAbstractChannel.AbstractUnsafe
instance which will be used for the life-time of theChannel
protected short
nextOpsId()
Returns the next id that should be used when submittingIoUringIoOps
.protected IoRegistration
registration()
java.net.InetSocketAddress
remoteAddress()
Returns the remote address where this channel is connected to.protected java.net.SocketAddress
remoteAddress0()
Return theSocketAddress
which theChannel
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 io.netty.channel.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 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
-
-
-
-
Constructor Detail
-
IoUringDatagramChannel
public IoUringDatagramChannel()
Create a new instance which selects theSocketProtocolFamily
to use depending on the Operation Systems default which will be chosen.
-
IoUringDatagramChannel
public IoUringDatagramChannel(SocketProtocolFamily family)
Create a new instance using the givenSocketProtocolFamily
. Ifnull
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 theSocketProtocolFamily
to use depending on the Operation Systems default which will be chosen.
-
-
Method Detail
-
remoteAddress
public java.net.InetSocketAddress remoteAddress()
Description copied from interface:Channel
Returns the remote address where this channel is connected to. The returnedSocketAddress
is supposed to be down-cast into more concrete type such asInetSocketAddress
to retrieve the detailed information.- Specified by:
remoteAddress
in interfaceChannel
- Specified by:
remoteAddress
in interfaceDatagramChannel
- Overrides:
remoteAddress
in classAbstractChannel
- 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
, useDefaultAddressedEnvelope.recipient()
to determine the origination of the received message as this method will returnnull
.
-
localAddress
public java.net.InetSocketAddress localAddress()
Description copied from interface:Channel
Returns the local address where this channel is bound to. The returnedSocketAddress
is supposed to be down-cast into more concrete type such asInetSocketAddress
to retrieve the detailed information.- Specified by:
localAddress
in interfaceChannel
- Specified by:
localAddress
in interfaceDatagramChannel
- Overrides:
localAddress
in classAbstractChannel
- Returns:
- the local address of this channel.
null
if this channel is not bound.
-
metadata
public ChannelMetadata metadata()
Description copied from interface:Channel
-
isActive
public boolean isActive()
Description copied from interface:Channel
Returntrue
if theChannel
is active and so connected.
-
isConnected
public boolean isConnected()
Description copied from interface:DatagramChannel
Returntrue
if theDatagramChannel
is connected to the remote peer.- Specified by:
isConnected
in interfaceDatagramChannel
-
joinGroup
public ChannelFuture joinGroup(java.net.InetAddress multicastAddress)
Description copied from interface:DatagramChannel
Joins a multicast group and notifies theChannelFuture
once the operation completes.- Specified by:
joinGroup
in interfaceDatagramChannel
-
joinGroup
public ChannelFuture joinGroup(java.net.InetAddress multicastAddress, ChannelPromise promise)
Description copied from interface:DatagramChannel
Joins a multicast group and notifies theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
joinGroup
in interfaceDatagramChannel
-
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 theChannelFuture
once the operation completes.- Specified by:
joinGroup
in interfaceDatagramChannel
-
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 theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
joinGroup
in interfaceDatagramChannel
-
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 theChannelFuture
once the operation completes.- Specified by:
joinGroup
in interfaceDatagramChannel
-
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 theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
joinGroup
in interfaceDatagramChannel
-
leaveGroup
public ChannelFuture leaveGroup(java.net.InetAddress multicastAddress)
Description copied from interface:DatagramChannel
Leaves a multicast group and notifies theChannelFuture
once the operation completes.- Specified by:
leaveGroup
in interfaceDatagramChannel
-
leaveGroup
public ChannelFuture leaveGroup(java.net.InetAddress multicastAddress, ChannelPromise promise)
Description copied from interface:DatagramChannel
Leaves a multicast group and notifies theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
leaveGroup
in interfaceDatagramChannel
-
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 theChannelFuture
once the operation completes.- Specified by:
leaveGroup
in interfaceDatagramChannel
-
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 theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
leaveGroup
in interfaceDatagramChannel
-
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 theChannelFuture
once the operation completes.- Specified by:
leaveGroup
in interfaceDatagramChannel
-
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 theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
leaveGroup
in interfaceDatagramChannel
-
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 theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
block
in interfaceDatagramChannel
-
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 theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
block
in interfaceDatagramChannel
-
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 theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
block
in interfaceDatagramChannel
-
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 theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
block
in interfaceDatagramChannel
-
newUnsafe
protected AbstractChannel.AbstractUnsafe newUnsafe()
Description copied from class:AbstractChannel
Create a newAbstractChannel.AbstractUnsafe
instance which will be used for the life-time of theChannel
- Specified by:
newUnsafe
in classAbstractChannel
-
doBind
protected void doBind(java.net.SocketAddress localAddress) throws java.lang.Exception
Description copied from class:AbstractChannel
Bind theChannel
to theSocketAddress
- Throws:
java.lang.Exception
-
filterOutboundMessage
protected java.lang.Object filterOutboundMessage(java.lang.Object msg)
Description copied from class:AbstractChannel
Invoked when a new message is added to aChannelOutboundBuffer
of thisAbstractChannel
, so that theChannel
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 interfaceChannel
- Specified by:
config
in interfaceDatagramChannel
-
doDisconnect
protected void doDisconnect() throws java.lang.Exception
Description copied from class:AbstractChannel
Disconnect thisChannel
from its remote peer- Throws:
java.lang.Exception
-
doClose
protected void doClose() throws java.lang.Exception
Description copied from class:AbstractChannel
Close theChannel
- Throws:
java.lang.Exception
-
isSegmentedDatagramPacketSupported
public static boolean isSegmentedDatagramPacketSupported()
Returnstrue
if the usage ofSegmentedDatagramPacket
is supported.- Returns:
true
if supported,false
otherwise.
-
cancelOutstandingReads
protected void cancelOutstandingReads(IoRegistration registration, int numOutstandingReads)
Cancel all outstanding reads- Parameters:
registration
- theIoRegistration
.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
- theIoRegistration
.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 submittingIoUringIoOps
.- Returns:
- opsId
-
isOpen
public final boolean isOpen()
Description copied from interface:Channel
Returnstrue
if theChannel
is open and may get active later
-
fd
public final FileDescriptor fd()
Description copied from interface:UnixChannel
Returns theFileDescriptor
that is used by thisChannel
.- Specified by:
fd
in interfaceUnixChannel
-
isCompatible
protected boolean isCompatible(EventLoop loop)
Description copied from class:AbstractChannel
Returntrue
if the givenEventLoop
is compatible with this instance.- Specified by:
isCompatible
in classAbstractChannel
-
doBeginRead
protected final void doBeginRead()
Description copied from class:AbstractChannel
Schedule a read operation.- Specified by:
doBeginRead
in classAbstractChannel
-
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 classAbstractChannel
-
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 theChannel
is registered with itsEventLoop
as part of the register process. Subclasses may override this method- Overrides:
doRegister
in classAbstractChannel
- Parameters:
promise
-ChannelPromise
that must be notified once done to continue the registration.
-
doDeregister
protected final void doDeregister()
Description copied from class:AbstractChannel
- Overrides:
doDeregister
in classAbstractChannel
-
checkResolvable
protected static void checkResolvable(java.net.InetSocketAddress addr)
-
localAddress0
protected final java.net.SocketAddress localAddress0()
Description copied from class:AbstractChannel
Returns theSocketAddress
which is bound locally.- Specified by:
localAddress0
in classAbstractChannel
-
remoteAddress0
protected final java.net.SocketAddress remoteAddress0()
Description copied from class:AbstractChannel
Return theSocketAddress
which theChannel
is connected to.- Specified by:
remoteAddress0
in classAbstractChannel
-
-