Module io.netty5.transport

Package io.netty5.channel.socket.nio

Class NioDatagramChannel

java.lang.Object

io.netty5.util.DefaultAttributeMap

io.netty5.channel.AbstractChannel<P,L,R>

io.netty5.channel.nio.AbstractNioChannel<P,L,R>

io.netty5.channel.nio.AbstractNioMessageChannel<Channel,SocketAddress,SocketAddress>

io.netty5.channel.socket.nio.NioDatagramChannel

All Implemented Interfaces:

Channel, ChannelOutboundInvoker, IoHandle, DatagramChannel, io.netty5.util.AttributeMap, io.netty5.util.concurrent.FuturePromiseFactory, Comparable<Channel>

public final class NioDatagramChannel
extends AbstractNioMessageChannel<Channel,SocketAddress,SocketAddress>
implements DatagramChannel

An NIO DatagramChannel that sends and receives an AddressedEnvelope.

See Also:

AddressedEnvelope, Available options In addition to the options provided by , allows the following options in the option map:

Nested Class Summary

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

AbstractChannel.DefaultAbstractChannelPipeline, AbstractChannel.ReadSink, AbstractChannel.WriteSink

Constructor Summary

Constructors

Constructor	Description
NioDatagramChannel(EventLoop eventLoop)	Create a new instance which will use the Operation Systems default ProtocolFamily.
NioDatagramChannel(EventLoop eventLoop, ProtocolFamily family)	Create a new instance using the given ProtocolFamily.
NioDatagramChannel(EventLoop eventLoop, DatagramChannel socket, ProtocolFamily family)	Create a new instance from the given DatagramChannel.
NioDatagramChannel(EventLoop eventLoop, SelectorProvider provider)	Create a new instance using the given SelectorProvider which will use the Operation Systems default ProtocolFamily.
NioDatagramChannel(EventLoop eventLoop, SelectorProvider provider, ProtocolFamily family)	Create a new instance using the given SelectorProvider and ProtocolFamily.

Method Summary

Modifier and Type	Method	Description
io.netty5.util.concurrent.Future<Void>	block(InetAddress multicastAddress, InetAddress sourceToBlock)	Block the given sourceToBlock address for the given multicastAddress
io.netty5.util.concurrent.Future<Void>	block(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress sourceToBlock)	Block the given sourceToBlock address for the given multicastAddress on the given networkInterface
protected void	doBind(SocketAddress localAddress)	Bind the Channel to the SocketAddress
protected boolean	doConnect(SocketAddress remoteAddress, SocketAddress localAddress, io.netty5.buffer.Buffer initialData)	Connect to remote peer.
protected void	doDisconnect()	Disconnect this Channel from its remote peer
protected boolean	doFinishConnect(SocketAddress requestedRemoteAddress)	Finish a connect request.
protected int	doReadMessages(AbstractChannel.ReadSink readSink)	Read messages into the given array and return the amount which was read.
protected void	doShutdown(ChannelShutdownDirection direction)	Shutdown one direction of the Channel.
protected void	doWriteNow(AbstractChannel.WriteSink writeSink)	Called in a loop when writes should be performed until this method returns false or there are no more messages to write.
protected Object	filterOutboundMessage(Object msg)	Invoked when a new message is added to to the outbound queue of this AbstractChannel, so that the Channel implementation converts the message to another.
protected <T> T	getExtendedOption(ChannelOption<T> option)	Override to add support for more ChannelOptions.
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.
protected boolean	isExtendedOptionSupported(ChannelOption<?> option)	Override to add support for more ChannelOptions.
boolean	isShutdown(ChannelShutdownDirection direction)	Returns true if the ChannelShutdownDirection of the Channel was shutdown before.
protected DatagramChannel	javaChannel()
io.netty5.util.concurrent.Future<Void>	joinGroup(InetAddress multicastAddress)	Joins a multicast group and notifies the Future once the operation completes.
io.netty5.util.concurrent.Future<Void>	joinGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source)	Joins the specified multicast group at the specified interface and notifies the Future once the operation completes.
io.netty5.util.concurrent.Future<Void>	leaveGroup(InetAddress multicastAddress)	Leaves a multicast group and notifies the Future once the operation completes.
io.netty5.util.concurrent.Future<Void>	leaveGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source)	Leave the specified multicast group at the specified interface using the specified source and notifies the Future once the operation completes.
protected SocketAddress	localAddress0()	Returns the SocketAddress which is bound locally.
protected SocketAddress	remoteAddress0()	Return the SocketAddress which the Channel is connected to.
protected <T> void	setExtendedOption(ChannelOption<T> option, T value)	Override to add support for more ChannelOptions.

Methods inherited from class io.netty5.channel.nio.AbstractNioMessageChannel

doReadNow

Methods inherited from class io.netty5.channel.nio.AbstractNioChannel

doClearScheduledRead, doClose, doRead, isOpen, isWriteFlushedScheduled, newDirectBuffer, newDirectBuffer, selectionKey, writeLoopComplete

Methods inherited from class io.netty5.channel.AbstractChannel

bufferAllocator, cacheAddresses, closeFuture, closeTransport, compareTo, equals, executor, finishConnect, getOption, hashCode, id, isConnectPending, isOptionSupported, isReadPending, isRegistered, isSupportingDisconnect, localAddress, newChannelPipeline, newSupportedIdentityOptionsSet, parent, pipeline, prepareToClose, readBufferAllocator, readHandle, readIfIsAutoRead, readLoopComplete, readNow, remoteAddress, setOption, shutdownReadSide, toString, validateEventLoopGroup, validateFileRegion, writableBytes, writeFlushed, writeFlushedNow, writeHandle

Methods inherited from class io.netty5.util.DefaultAttributeMap

attr, hasAttr

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty5.util.AttributeMap

attr, hasAttr

Methods inherited from interface io.netty5.channel.Channel

bind, bufferAllocator, close, closeFuture, connect, connect, deregister, disconnect, executor, flush, getOption, id, isOpen, isOptionSupported, isWritable, localAddress, parent, pipeline, read, read, register, remoteAddress, sendOutboundEvent, setOption, shutdown, writableBytes, write, writeAndFlush

Methods inherited from interface io.netty5.channel.ChannelOutboundInvoker

newFailedFuture, newPromise, newSucceededFuture, newSucceededFuture

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface io.netty5.channel.IoHandle

isRegistered

Constructor Detail

NioDatagramChannel

public NioDatagramChannel(EventLoop eventLoop)

Create a new instance which will use the Operation Systems default ProtocolFamily.

NioDatagramChannel

public NioDatagramChannel(EventLoop eventLoop,
                          SelectorProvider provider)

Create a new instance using the given SelectorProvider which will use the Operation Systems default ProtocolFamily.

NioDatagramChannel

public NioDatagramChannel(EventLoop eventLoop,
                          ProtocolFamily family)

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

NioDatagramChannel

public NioDatagramChannel(EventLoop eventLoop,
                          SelectorProvider provider,
                          ProtocolFamily family)

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

NioDatagramChannel

public NioDatagramChannel(EventLoop eventLoop,
                          DatagramChannel socket,
                          ProtocolFamily family)

Create a new instance from the given DatagramChannel.

Method Detail

getExtendedOption

protected <T> T getExtendedOption(ChannelOption<T> option)

Description copied from class: AbstractChannel

Override to add support for more ChannelOptions. You need to also call {@link super} after handling the extra options.

Overrides:

getExtendedOption in class AbstractChannel<Channel,SocketAddress,SocketAddress>

Type Parameters:

T - the value type.

Parameters:

option - the ChannelOption.

Returns:

the value for the option.

setExtendedOption

protected <T> void setExtendedOption(ChannelOption<T> option,
                                     T value)

Description copied from class: AbstractChannel

Override to add support for more ChannelOptions. You need to also call super after handling the extra options.

Overrides:

setExtendedOption in class AbstractChannel<Channel,SocketAddress,SocketAddress>

Type Parameters:

T - the value type.

Parameters:

option - the ChannelOption.

isExtendedOptionSupported

protected boolean isExtendedOptionSupported(ChannelOption<?> option)

Description copied from class: AbstractChannel

Override to add support for more ChannelOptions. You need to also call super after handling the extra options.

Overrides:

isExtendedOptionSupported in class AbstractChannel<Channel,SocketAddress,SocketAddress>

Parameters:

option - the ChannelOption.

Returns:

true if supported, false otherwise.

doShutdown

protected void doShutdown(ChannelShutdownDirection direction)

Description copied from class: AbstractChannel

Shutdown one direction of the Channel.

Specified by:

doShutdown in class AbstractChannel<Channel,SocketAddress,SocketAddress>

Parameters:

direction - the direction to shut down.

isShutdown

public boolean isShutdown(ChannelShutdownDirection direction)

Description copied from interface: Channel

Returns true if the ChannelShutdownDirection of the Channel was shutdown before.

Specified by:

isShutdown 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

javaChannel

protected DatagramChannel javaChannel()

Overrides:

javaChannel in class AbstractNioChannel<Channel,SocketAddress,SocketAddress>

localAddress0

protected SocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 in class AbstractChannel<Channel,SocketAddress,SocketAddress>

Returns:

the local address if any, null otherwise.

remoteAddress0

protected SocketAddress remoteAddress0()

Description copied from class: AbstractChannel

Return the SocketAddress which the Channel is connected to.

Specified by:

remoteAddress0 in class AbstractChannel<Channel,SocketAddress,SocketAddress>

Returns:

the remote address if any, null otherwise.

doBind

protected void doBind(SocketAddress localAddress)
               throws Exception

Description copied from class: AbstractChannel

Bind the Channel to the SocketAddress

Specified by:

doBind in class AbstractChannel<Channel,SocketAddress,SocketAddress>

Parameters:

localAddress - the SocketAddress to bound to.

Throws:

Exception - when an error happens.

doConnect

protected boolean doConnect(SocketAddress remoteAddress,
                            SocketAddress localAddress,
                            io.netty5.buffer.Buffer initialData)
                     throws Exception

Description copied from class: AbstractChannel

Connect to remote peer. This method should never be directly called.

Specified by:

doConnect in class AbstractChannel<Channel,SocketAddress,SocketAddress>

Parameters:

remoteAddress - the address of the remote peer.

localAddress - the local address of this channel.

initialData - the initial data that is written during connect (if ChannelOption.TCP_FASTOPEN_CONNECT is supported and configured). If data is written care must be taken to update the reader offset.

Returns:

true if the connect operation was completed, false if AbstractChannel.finishConnect() will be called later again to try finish connecting.

Throws:

Exception - thrown on error.

doFinishConnect

protected boolean doFinishConnect(SocketAddress requestedRemoteAddress)

Description copied from class: AbstractChannel

Finish a connect request. This method should never be directly called, use AbstractChannel.finishConnect() instead.

Specified by:

doFinishConnect in class AbstractChannel<Channel,SocketAddress,SocketAddress>

Parameters:

requestedRemoteAddress - the remote address of the peer.

Returns:

true if the connect operations was completed, false if AbstractChannel.finishConnect() will be called later again to try finishing the connect operation.

doDisconnect

protected void doDisconnect()
                     throws Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Specified by:

doDisconnect in class AbstractChannel<Channel,SocketAddress,SocketAddress>

Throws:

Exception - thrown on error.

doReadMessages

protected int doReadMessages(AbstractChannel.ReadSink readSink)
                      throws Exception

Description copied from class: AbstractNioMessageChannel

Read messages into the given array and return the amount which was read.

Specified by:

doReadMessages in class AbstractNioMessageChannel<Channel,SocketAddress,SocketAddress>

Throws:

Exception

doWriteNow

protected void doWriteNow(AbstractChannel.WriteSink writeSink)
                   throws Exception

Description copied from class: AbstractChannel

Called in a loop when writes should be performed until this method returns false or there are no more messages to write. Implementations are responsible for handling partial writes, which for example means that if Buffers are written partial implementations need to ensure the readerOffset is updated accordingly.

Specified by:

doWriteNow in class AbstractChannel<Channel,SocketAddress,SocketAddress>

Parameters:

writeSink - the AbstractChannel.WriteSink that must be completed with the write progress. AbstractChannel.WriteSink.complete(long, long, int, boolean) or AbstractChannel.WriteSink.complete(long, Throwable, boolean) must be called exactly once before this method returns non-exceptional.

Throws:

Exception - if an error happened during writing. This will also terminate the write loop.

filterOutboundMessage

protected Object filterOutboundMessage(Object msg)

Description copied from class: AbstractChannel

Invoked when a new message is added to to the outbound queue of this AbstractChannel, so that the Channel implementation converts the message to another. (e.g. heap buffer -> direct buffer)

Overrides:

filterOutboundMessage in class AbstractChannel<Channel,SocketAddress,SocketAddress>

Parameters:

msg - the message to filter / convert.

joinGroup

public io.netty5.util.concurrent.Future<Void> joinGroup(InetAddress multicastAddress)

Description copied from interface: DatagramChannel

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

If the underlying implementation does not support this operation it will return a Future which is failed with an UnsupportedOperationException.

Specified by:

joinGroup in interface DatagramChannel

Parameters:

multicastAddress - the multicast group address.

Returns:

a Future which is notified once the operation completes.

joinGroup

public io.netty5.util.concurrent.Future<Void> joinGroup(InetAddress multicastAddress,
                                                        NetworkInterface networkInterface,
                                                        InetAddress source)

Description copied from interface: DatagramChannel

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

If the underlying implementation does not support this operation it will return a Future which is failed with an UnsupportedOperationException.

Specified by:

joinGroup in interface DatagramChannel

Parameters:

multicastAddress - the multicast group address.

networkInterface - the interface to use.

source - the source address (might be null).

Returns:

a Future which is notified once the operation completes.

leaveGroup

public io.netty5.util.concurrent.Future<Void> leaveGroup(InetAddress multicastAddress)

Description copied from interface: DatagramChannel

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

If the underlying implementation does not support this operation it will return a Future which is failed with an UnsupportedOperationException.

Specified by:

leaveGroup in interface DatagramChannel

Parameters:

multicastAddress - the multicast group address.

Returns:

a Future which is notified once the operation completes.

leaveGroup

public io.netty5.util.concurrent.Future<Void> 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 Future once the operation completes.

If the underlying implementation does not support this operation it will return a Future which is failed with an UnsupportedOperationException.

Specified by:

leaveGroup in interface DatagramChannel

Parameters:

multicastAddress - the multicast group address.

networkInterface - the interface to use.

source - the source address (might be null).

Returns:

a Future which is notified once the operation completes.

block

public io.netty5.util.concurrent.Future<Void> block(InetAddress multicastAddress,
                                                    NetworkInterface networkInterface,
                                                    InetAddress sourceToBlock)

Block the given sourceToBlock address for the given multicastAddress on the given networkInterface

Specified by:

block in interface DatagramChannel

Parameters:

multicastAddress - the multicast group address.

networkInterface - the interface to use.

sourceToBlock - the source address.

Returns:

a Future which is notified once the operation completes.

block

public io.netty5.util.concurrent.Future<Void> block(InetAddress multicastAddress,
                                                    InetAddress sourceToBlock)

Block the given sourceToBlock address for the given multicastAddress

Specified by:

block in interface DatagramChannel

Parameters:

multicastAddress - the multicast group address.

sourceToBlock - the source address.

Returns:

a Future which is notified once the operation completes.