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>
An NIO datagram
Channel
that sends and receives an
AddressedEnvelopeinvalid input: '<'ByteBuf, SocketAddress>
.- See Also:
-
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
FieldsModifier and TypeFieldDescriptionprivate final DatagramChannelConfig
private static final SelectorProvider
private static final String
private Map
<InetAddress, List<MembershipKey>> private static final ChannelMetadata
Fields inherited from class io.netty.channel.nio.AbstractNioChannel
readInterestOp
-
Constructor Summary
ConstructorsConstructorDescriptionCreate a new instance which will use the Operation Systems defaultInternetProtocolFamily
.NioDatagramChannel
(InternetProtocolFamily ipFamily) Create a new instance using the givenInternetProtocolFamily
.NioDatagramChannel
(DatagramChannel socket) Create a new instance from the givenDatagramChannel
.NioDatagramChannel
(SelectorProvider provider) Create a new instance using the givenSelectorProvider
which will use the Operation Systems defaultInternetProtocolFamily
.NioDatagramChannel
(SelectorProvider provider, InternetProtocolFamily ipFamily) Create a new instance using the givenSelectorProvider
andInternetProtocolFamily
. -
Method Summary
Modifier and TypeMethodDescriptionblock
(InetAddress multicastAddress, InetAddress sourceToBlock) Block the given sourceToBlock address for the given multicastAddressblock
(InetAddress multicastAddress, InetAddress sourceToBlock, ChannelPromise promise) Block the given sourceToBlock address for the given multicastAddressblock
(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress sourceToBlock) Block the given sourceToBlock address for the given multicastAddress on the given networkInterfaceblock
(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress sourceToBlock, ChannelPromise promise) Block the given sourceToBlock address for the given multicastAddress on the given networkInterfaceprivate static void
private static void
checkUnresolved
(AddressedEnvelope<?, ?> envelope) (package private) void
protected boolean
closeOnReadError
(Throwable cause) config()
Returns the configuration of this channel.protected boolean
Returnstrue
if we should continue the write loop on a write error.protected boolean
continueReading
(RecvByteBufAllocator.Handle allocHandle) protected void
doBind
(SocketAddress localAddress) Bind theChannel
to theSocketAddress
private void
doBind0
(SocketAddress localAddress) protected void
doClose()
Close theChannel
protected boolean
doConnect
(SocketAddress remoteAddress, SocketAddress localAddress) Connect to the remote peerprotected void
Disconnect thisChannel
from its remote peerprotected void
Finish the connectprotected 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 underlyingChannel
.protected Object
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.boolean
Returntrue
if theDatagramChannel
is connected to the remote peer.private static boolean
Checks if the specified buffer is a direct buffer and is composed of a single NIO buffer.protected DatagramChannel
joinGroup
(InetAddress multicastAddress) Joins a multicast group and notifies theChannelFuture
once the operation completes.joinGroup
(InetAddress multicastAddress, ChannelPromise promise) Joins a multicast group and notifies theChannelFuture
once the operation completes.joinGroup
(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source) Joins the specified multicast group at the specified interface and notifies theChannelFuture
once the operation completes.joinGroup
(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, ChannelPromise promise) Joins the specified multicast group at the specified interface and notifies theChannelFuture
once the operation completes.joinGroup
(InetSocketAddress multicastAddress, NetworkInterface networkInterface) Joins the specified multicast group at the specified interface and notifies theChannelFuture
once the operation completes.joinGroup
(InetSocketAddress multicastAddress, NetworkInterface networkInterface, ChannelPromise promise) Joins the specified multicast group at the specified interface and notifies theChannelFuture
once the operation completes.leaveGroup
(InetAddress multicastAddress) Leaves a multicast group and notifies theChannelFuture
once the operation completes.leaveGroup
(InetAddress multicastAddress, ChannelPromise promise) Leaves a multicast group and notifies theChannelFuture
once the operation completes.leaveGroup
(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source) Leave the specified multicast group at the specified interface using the specified source and notifies theChannelFuture
once the operation completes.leaveGroup
(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, ChannelPromise promise) Leave the specified multicast group at the specified interface using the specified source and notifies theChannelFuture
once the operation completes.leaveGroup
(InetSocketAddress multicastAddress, NetworkInterface networkInterface) Leaves a multicast group on a specified local interface and notifies theChannelFuture
once the operation completes.leaveGroup
(InetSocketAddress multicastAddress, NetworkInterface networkInterface, ChannelPromise promise) Leaves a multicast group on a specified local interface and notifies theChannelFuture
once the operation completes.Returns the local address where this channel is bound to.protected SocketAddress
Returns theSocketAddress
which is bound locally.metadata()
private static DatagramChannel
newSocket
(SelectorProvider provider) private static DatagramChannel
newSocket
(SelectorProvider provider, InternetProtocolFamily ipFamily) Returns the remote address where this channel is connected to.protected SocketAddress
Return theSocketAddress
which theChannel
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
-
DEFAULT_SELECTOR_PROVIDER
-
EXPECTED_TYPES
-
config
-
memberships
-
-
Constructor Details
-
NioDatagramChannel
public NioDatagramChannel()Create a new instance which will use the Operation Systems defaultInternetProtocolFamily
. -
NioDatagramChannel
Create a new instance using the givenSelectorProvider
which will use the Operation Systems defaultInternetProtocolFamily
. -
NioDatagramChannel
Create a new instance using the givenInternetProtocolFamily
. Ifnull
is used it will depend on the Operation Systems default which will be chosen. -
NioDatagramChannel
Create a new instance using the givenSelectorProvider
andInternetProtocolFamily
. IfInternetProtocolFamily
isnull
it will depend on the Operation Systems default which will be chosen. -
NioDatagramChannel
Create a new instance from the givenDatagramChannel
.
-
-
Method Details
-
newSocket
-
newSocket
private static DatagramChannel newSocket(SelectorProvider provider, InternetProtocolFamily ipFamily) -
checkJavaVersion
private static void checkJavaVersion() -
metadata
Description copied from interface:Channel
-
config
Description copied from interface:Channel
Returns the configuration of this channel.- Specified by:
config
in interfaceChannel
- Specified by:
config
in interfaceDatagramChannel
-
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
-
javaChannel
- Overrides:
javaChannel
in classAbstractNioChannel
-
localAddress0
Description copied from class:AbstractChannel
Returns theSocketAddress
which is bound locally.- Specified by:
localAddress0
in classAbstractChannel
-
remoteAddress0
Description copied from class:AbstractChannel
Return theSocketAddress
which theChannel
is connected to.- Specified by:
remoteAddress0
in classAbstractChannel
-
doBind
Description copied from class:AbstractChannel
Bind theChannel
to theSocketAddress
- Specified by:
doBind
in classAbstractChannel
- Throws:
Exception
-
doBind0
- 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 classAbstractNioChannel
- Throws:
Exception
-
doFinishConnect
Description copied from class:AbstractNioChannel
Finish the connect- Specified by:
doFinishConnect
in classAbstractNioChannel
- Throws:
Exception
-
doDisconnect
Description copied from class:AbstractChannel
Disconnect thisChannel
from its remote peer- Specified by:
doDisconnect
in classAbstractChannel
- Throws:
Exception
-
doClose
Description copied from class:AbstractChannel
Close theChannel
- Overrides:
doClose
in classAbstractNioChannel
- Throws:
Exception
-
doReadMessages
Description copied from class:AbstractNioMessageChannel
Read messages into the given array and return the amount which was read.- Specified by:
doReadMessages
in classAbstractNioMessageChannel
- Throws:
Exception
-
doWriteMessage
Description copied from class:AbstractNioMessageChannel
Write a message to the underlyingChannel
.- Specified by:
doWriteMessage
in classAbstractNioMessageChannel
- Returns:
true
if and only if the message has been written- Throws:
Exception
-
checkUnresolved
-
filterOutboundMessage
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)- Overrides:
filterOutboundMessage
in classAbstractChannel
-
isSingleDirectBuffer
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
Returnstrue
if we should continue the write loop on a write error.- Overrides:
continueOnWriteError
in classAbstractNioMessageChannel
-
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.
-
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
.
-
joinGroup
Description copied from interface:DatagramChannel
Joins a multicast group and notifies theChannelFuture
once the operation completes.- Specified by:
joinGroup
in interfaceDatagramChannel
-
joinGroup
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(InetSocketAddress multicastAddress, 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(InetSocketAddress multicastAddress, 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(InetAddress multicastAddress, NetworkInterface networkInterface, 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(InetAddress multicastAddress, NetworkInterface networkInterface, 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
Description copied from interface:DatagramChannel
Leaves a multicast group and notifies theChannelFuture
once the operation completes.- Specified by:
leaveGroup
in interfaceDatagramChannel
-
leaveGroup
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(InetSocketAddress multicastAddress, 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(InetSocketAddress multicastAddress, 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(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 theChannelFuture
once the operation completes.- Specified by:
leaveGroup
in interfaceDatagramChannel
-
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 theChannelFuture
once the operation completes. The givenChannelFuture
will be notified and also returned.- Specified by:
leaveGroup
in interfaceDatagramChannel
-
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 interfaceDatagramChannel
-
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 interfaceDatagramChannel
-
block
Block the given sourceToBlock address for the given multicastAddress- Specified by:
block
in interfaceDatagramChannel
-
block
public ChannelFuture block(InetAddress multicastAddress, InetAddress sourceToBlock, ChannelPromise promise) Block the given sourceToBlock address for the given multicastAddress- Specified by:
block
in interfaceDatagramChannel
-
setReadPending
Deprecated.- Overrides:
setReadPending
in classAbstractNioChannel
-
clearReadPending0
void clearReadPending0() -
closeOnReadError
- Overrides:
closeOnReadError
in classAbstractNioMessageChannel
-
continueReading
- Overrides:
continueReading
in classAbstractNioMessageChannel
-