Interface DatagramChannel

All Superinterfaces:

AttributeMap, Channel, ChannelOutboundInvoker, Comparable<Channel>

All Known Implementing Classes:

EpollDatagramChannel, IoUringDatagramChannel, KQueueDatagramChannel, NioDatagramChannel, OioDatagramChannel

public interface DatagramChannel
extends Channel

A UDP/IP Channel.

Nested Class Summary

Nested classes/interfaces inherited from interface Channel

Channel.Unsafe

Method Summary

Modifier and Type	Method	Description
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 future)	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 future)	Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the ChannelFuture once the operation completes.
DatagramChannelConfig	config()	Returns the configuration of this channel.
boolean	isConnected()	Return true if the DatagramChannel is connected to the remote peer.
ChannelFuture	joinGroup(InetAddress multicastAddress)	Joins a multicast group and notifies the ChannelFuture once the operation completes.
ChannelFuture	joinGroup(InetAddress multicastAddress, ChannelPromise future)	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 future)	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 future)	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 future)	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 future)	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 future)	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.
InetSocketAddress	remoteAddress()	Returns the remote address where this channel is connected to.

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, isActive, isOpen, isRegistered, isWritable, metadata, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, setOption, unsafe, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface Comparable

compareTo

Method Details

config

DatagramChannelConfig config()

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

config in interface Channel

localAddress

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

Returns:

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

remoteAddress

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

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.

isConnected

boolean isConnected()

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

joinGroup

ChannelFuture joinGroup(InetAddress multicastAddress)

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

joinGroup

ChannelFuture joinGroup(InetAddress multicastAddress,
 ChannelPromise future)

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

joinGroup

ChannelFuture joinGroup(InetSocketAddress multicastAddress,
 NetworkInterface networkInterface)

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

joinGroup

ChannelFuture joinGroup(InetSocketAddress multicastAddress,
 NetworkInterface networkInterface,
 ChannelPromise future)

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.

joinGroup

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.

joinGroup

ChannelFuture joinGroup(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress source,
 ChannelPromise future)

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.

leaveGroup

ChannelFuture leaveGroup(InetAddress multicastAddress)

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

leaveGroup

ChannelFuture leaveGroup(InetAddress multicastAddress,
 ChannelPromise future)

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

leaveGroup

ChannelFuture leaveGroup(InetSocketAddress multicastAddress,
 NetworkInterface networkInterface)

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

leaveGroup

ChannelFuture leaveGroup(InetSocketAddress multicastAddress,
 NetworkInterface networkInterface,
 ChannelPromise future)

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.

leaveGroup

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.

leaveGroup

ChannelFuture leaveGroup(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress source,
 ChannelPromise future)

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.

block

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. The given ChannelFuture will be notified and also returned.

block

ChannelFuture block(InetAddress multicastAddress,
 NetworkInterface networkInterface,
 InetAddress sourceToBlock,
 ChannelPromise future)

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.

block

ChannelFuture block(InetAddress multicastAddress,
 InetAddress sourceToBlock)

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.

block

ChannelFuture block(InetAddress multicastAddress,
 InetAddress sourceToBlock,
 ChannelPromise future)

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.