Package io.netty.channel.socket.nio

Class NioDatagramChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.nio.AbstractNioChannel

io.netty.channel.nio.AbstractNioMessageChannel

io.netty.channel.socket.nio.NioDatagramChannel

All Implemented Interfaces:

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

public final class NioDatagramChannel
extends AbstractNioMessageChannel
implements DatagramChannel

An NIO datagram Channel that sends and receives an AddressedEnvelope<ByteBuf, SocketAddress>.

See Also:

• AddressedEnvelope
• DatagramPacket

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.channel.nio.AbstractNioChannel

AbstractNioChannel.AbstractNioUnsafe, AbstractNioChannel.NioUnsafe

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 final DatagramChannelConfig	config
private static final SelectorProvider	DEFAULT_SELECTOR_PROVIDER
private static final String	EXPECTED_TYPES
private Map<InetAddress,List<MembershipKey>>	memberships
private static final ChannelMetadata	METADATA

Fields inherited from class io.netty.channel.nio.AbstractNioChannel

readInterestOp

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ChannelFuture	block(InetAddress multicastAddress, InetAddress sourceToBlock)	Block the given sourceToBlock address for the given multicastAddress
ChannelFuture	block(InetAddress multicastAddress, InetAddress sourceToBlock, ChannelPromise promise)	Block the given sourceToBlock address for the given multicastAddress
ChannelFuture	block(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress sourceToBlock)	Block the given sourceToBlock address for the given multicastAddress on the given networkInterface
ChannelFuture	block(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress sourceToBlock, ChannelPromise promise)	Block the given sourceToBlock address for the given multicastAddress on the given networkInterface
private static void	checkJavaVersion()
private static void	checkUnresolved(AddressedEnvelope<?,?> envelope)
(package private) void	clearReadPending0()
protected boolean	closeOnReadError(Throwable cause)
DatagramChannelConfig	config()	Returns the configuration of this channel.
protected boolean	continueOnWriteError()	Returns true if we should continue the write loop on a write error.
protected boolean	continueReading(RecvByteBufAllocator.Handle allocHandle)
protected void	doBind(SocketAddress localAddress)	Bind the Channel to the SocketAddress
private void	doBind0(SocketAddress localAddress)
protected void	doClose()	Close the Channel
protected boolean	doConnect(SocketAddress remoteAddress, SocketAddress localAddress)	Connect to the remote peer
protected void	doDisconnect()	Disconnect this Channel from its remote peer
protected void	doFinishConnect()	Finish the connect
protected int	doReadMessages(List<Object> buf)	Read messages into the given array and return the amount which was read.
protected boolean	doWriteMessage(Object msg, ChannelOutboundBuffer in)	Write a message to the underlying 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.
boolean	isConnected()	Return true if the DatagramChannel is connected to the remote peer.
private static boolean	isSingleDirectBuffer(ByteBuf buf)	Checks if the specified buffer is a direct buffer and is composed of a single NIO buffer.
protected DatagramChannel	javaChannel()
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 SocketAddress	localAddress0()	Returns the SocketAddress which is bound locally.
ChannelMetadata	metadata()	Return the ChannelMetadata of the Channel which describe the nature of the Channel.
private static DatagramChannel	newSocket(SelectorProvider provider)
private static DatagramChannel	newSocket(SelectorProvider provider, InternetProtocolFamily ipFamily)
InetSocketAddress	remoteAddress()	Returns the remote address where this channel is connected to.
protected SocketAddress	remoteAddress0()	Return the SocketAddress which the Channel is connected to.
protected void	setReadPending(boolean readPending)	Deprecated.

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

doBeginRead, doWrite, newUnsafe

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

clearReadPending, doDeregister, doRegister, eventLoop, isCompatible, isOpen, isReadPending, newDirectBuffer, newDirectBuffer, selectionKey, unsafe

Methods inherited from class io.netty.channel.AbstractChannel

alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doShutdownOutput, equals, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, maxMessagesPerWrite, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, toString, validateFileRegion, voidPromise, write, write, writeAndFlush, writeAndFlush

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, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isOpen, isRegistered, isWritable, parent, pipeline, read, unsafe

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker

bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface java.lang.Comparable

compareTo

Field Details

METADATA

private static final ChannelMetadata METADATA

DEFAULT_SELECTOR_PROVIDER

private static final SelectorProvider DEFAULT_SELECTOR_PROVIDER

EXPECTED_TYPES

private static final String EXPECTED_TYPES

config

private final DatagramChannelConfig config

memberships

private Map<InetAddress,List<MembershipKey>> memberships

Constructor Details

NioDatagramChannel

public NioDatagramChannel()

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

NioDatagramChannel

public NioDatagramChannel(SelectorProvider provider)

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

NioDatagramChannel

public NioDatagramChannel(InternetProtocolFamily ipFamily)

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

NioDatagramChannel

public NioDatagramChannel(SelectorProvider provider,
 InternetProtocolFamily ipFamily)

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

NioDatagramChannel

public NioDatagramChannel(DatagramChannel socket)

Create a new instance from the given DatagramChannel.

Method Details

newSocket

private static DatagramChannel newSocket(SelectorProvider provider)

newSocket

private static DatagramChannel newSocket(SelectorProvider provider,
 InternetProtocolFamily ipFamily)

checkJavaVersion

private static void checkJavaVersion()

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

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

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

localAddress0

protected SocketAddress localAddress0()

Description copied from class: AbstractChannel

Returns the SocketAddress which is bound locally.

Specified by:

localAddress0 in class AbstractChannel

remoteAddress0

protected SocketAddress remoteAddress0()

Description copied from class: AbstractChannel

Return the SocketAddress which the Channel is connected to.

Specified by:

remoteAddress0 in class AbstractChannel

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

Throws:

Exception

doBind0

private void doBind0(SocketAddress localAddress)
              throws Exception

Throws:

Exception

doConnect

protected boolean doConnect(SocketAddress remoteAddress,
 SocketAddress localAddress)
                     throws Exception

Description copied from class: AbstractNioChannel

Connect to the remote peer

Specified by:

doConnect in class AbstractNioChannel

Throws:

Exception

doFinishConnect

protected void doFinishConnect()
                        throws Exception

Description copied from class: AbstractNioChannel

Finish the connect

Specified by:

doFinishConnect in class AbstractNioChannel

Throws:

Exception

doDisconnect

protected void doDisconnect()
                     throws Exception

Description copied from class: AbstractChannel

Disconnect this Channel from its remote peer

Specified by:

doDisconnect in class AbstractChannel

Throws:

Exception

doClose

protected void doClose()
                throws Exception

Description copied from class: AbstractChannel

Close the Channel

Overrides:

doClose in class AbstractNioChannel

Throws:

Exception

doReadMessages

protected int doReadMessages(List<Object> buf)
                      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

Throws:

Exception

doWriteMessage

protected boolean doWriteMessage(Object msg,
 ChannelOutboundBuffer in)
                          throws Exception

Description copied from class: AbstractNioMessageChannel

Write a message to the underlying Channel.

Specified by:

doWriteMessage in class AbstractNioMessageChannel

Returns:

true if and only if the message has been written

Throws:

Exception

checkUnresolved

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

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)

Overrides:

filterOutboundMessage in class AbstractChannel

isSingleDirectBuffer

private static boolean isSingleDirectBuffer(ByteBuf buf)

Checks if the specified buffer is a direct buffer and is composed of a single NIO buffer. (We check this because otherwise we need to make it a non-composite buffer.)

continueOnWriteError

protected boolean continueOnWriteError()

Description copied from class: AbstractNioMessageChannel

Returns true if we should continue the write loop on a write error.

Overrides:

continueOnWriteError in class AbstractNioMessageChannel

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.

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.

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)

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

Specified by:

block in interface DatagramChannel

block

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

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

Specified by:

block in interface DatagramChannel

block

public ChannelFuture block(InetAddress multicastAddress,
 InetAddress sourceToBlock)

Block the given sourceToBlock address for the given multicastAddress

Specified by:

block in interface DatagramChannel

block

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

Block the given sourceToBlock address for the given multicastAddress

Specified by:

block in interface DatagramChannel

setReadPending

@Deprecated
protected void setReadPending(boolean readPending)

Deprecated.

Overrides:

setReadPending in class AbstractNioChannel

clearReadPending0

void clearReadPending0()

closeOnReadError

protected boolean closeOnReadError(Throwable cause)

Overrides:

closeOnReadError in class AbstractNioMessageChannel

continueReading

protected boolean continueReading(RecvByteBufAllocator.Handle allocHandle)

Overrides:

continueReading in class AbstractNioMessageChannel