Class NioDatagramChannel
java.lang.Object
org.jboss.netty.channel.AbstractChannel
org.jboss.netty.channel.socket.nio.AbstractNioChannel<DatagramChannel>
org.jboss.netty.channel.socket.nio.NioDatagramChannel
- All Implemented Interfaces:
Comparable<Channel>
,Channel
,DatagramChannel
public class NioDatagramChannel
extends AbstractNioChannel<DatagramChannel>
implements DatagramChannel
Provides an NIO based
DatagramChannel
.-
Nested Class Summary
Nested classes/interfaces inherited from class org.jboss.netty.channel.socket.nio.AbstractNioChannel
AbstractNioChannel.WriteRequestQueue
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final NioDatagramChannelConfig
private Map
<InetAddress, List<MembershipKey>> Fields inherited from class org.jboss.netty.channel.socket.nio.AbstractNioChannel
channel, currentWriteBuffer, currentWriteEvent, highWaterMarkCounter, inWriteNowLoop, remoteAddress, worker, writeBufferQueue, writeBufferSize, writeLock, writeSuspended, writeTask, writeTaskInTaskQueue
Fields inherited from interface org.jboss.netty.channel.Channel
OP_NONE, OP_READ, OP_READ_WRITE, OP_WRITE
-
Constructor Summary
ConstructorsConstructorDescriptionNioDatagramChannel
(ChannelFactory factory, ChannelPipeline pipeline, ChannelSink sink, NioDatagramWorker worker, InternetProtocolFamily family) -
Method Summary
Modifier and TypeMethodDescriptionblock
(InetAddress multicastAddress, InetAddress sourceToBlock) 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 networkInterfaceReturns the configuration of this channel.(package private) DatagramChannel
(package private) InetSocketAddress
(package private) InetSocketAddress
Return theAbstractNioWorker
that handle the IO of theAbstractNioChannel
boolean
isBound()
Returnstrue
if and only if this channel is bound to a local address.boolean
Returnstrue
if and only if this channel is connected to a remote address.joinGroup
(InetAddress multicastAddress) Joins a multicast group.joinGroup
(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source) Joins the specified multicast group at the specified interface using the specified source.joinGroup
(InetSocketAddress multicastAddress, NetworkInterface networkInterface) Joins the specified multicast group at the specified interface.leaveGroup
(InetAddress multicastAddress) Leaves a multicast group.leaveGroup
(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source) Leave the specified multicast group at the specified interface using the specified source.leaveGroup
(InetSocketAddress multicastAddress, NetworkInterface networkInterface) Leaves a multicast group on a specified local interface.private static DatagramChannel
protected boolean
Marks this channel as closed.write
(Object message, SocketAddress remoteAddress) Sends a message to this channel asynchronously.Methods inherited from class org.jboss.netty.channel.socket.nio.AbstractNioChannel
getInternalInterestOps, getLocalAddress, getRemoteAddress, setInternalInterestOps
Methods inherited from class org.jboss.netty.channel.AbstractChannel
bind, close, compareTo, connect, disconnect, equals, getAttachment, getCloseFuture, getFactory, getId, getInterestOps, getParent, getPipeline, getSucceededFuture, getUnsupportedOperationFuture, getUserDefinedWritability, hashCode, isOpen, isReadable, isWritable, setAttachment, setInterestOps, setReadable, setUnwritable, setUserDefinedWritability, setWritable, toString, unbind, write
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface org.jboss.netty.channel.Channel
bind, close, connect, disconnect, getAttachment, getCloseFuture, getFactory, getId, getInterestOps, getParent, getPipeline, getUserDefinedWritability, isOpen, isReadable, isWritable, setAttachment, setInterestOps, setReadable, setUserDefinedWritability, unbind, write
Methods inherited from interface java.lang.Comparable
compareTo
Methods inherited from interface org.jboss.netty.channel.socket.DatagramChannel
getLocalAddress, getRemoteAddress
-
Field Details
-
config
-
memberships
-
-
Constructor Details
-
NioDatagramChannel
NioDatagramChannel(ChannelFactory factory, ChannelPipeline pipeline, ChannelSink sink, NioDatagramWorker worker, InternetProtocolFamily family)
-
-
Method Details
-
openNonBlockingChannel
-
getWorker
Description copied from class:AbstractNioChannel
Return theAbstractNioWorker
that handle the IO of theAbstractNioChannel
- Overrides:
getWorker
in classAbstractNioChannel<DatagramChannel>
- Returns:
- worker
-
isBound
public boolean isBound()Description copied from interface:Channel
Returnstrue
if and only if this channel is bound to a local address. -
isConnected
public boolean isConnected()Description copied from interface:Channel
Returnstrue
if and only if this channel is connected to a remote address.- Specified by:
isConnected
in interfaceChannel
-
setClosed
protected boolean setClosed()Description copied from class:AbstractChannel
Marks this channel as closed. This method is intended to be called by an internal component - please do not call it unless you know what you are doing.- Overrides:
setClosed
in classAbstractNioChannel<DatagramChannel>
- Returns:
true
if and only if this channel was not marked as closed yet
-
getConfig
Description copied from interface:Channel
Returns the configuration of this channel.- Specified by:
getConfig
in interfaceChannel
- Specified by:
getConfig
in interfaceDatagramChannel
- Specified by:
getConfig
in classAbstractNioChannel<DatagramChannel>
-
getDatagramChannel
DatagramChannel getDatagramChannel() -
joinGroup
Description copied from interface:DatagramChannel
Joins a multicast group.- 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.- Specified by:
joinGroup
in interfaceDatagramChannel
-
joinGroup
public ChannelFuture joinGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source) Joins the specified multicast group at the specified interface using the specified source. -
leaveGroup
Description copied from interface:DatagramChannel
Leaves a multicast group.- 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.- Specified by:
leaveGroup
in interfaceDatagramChannel
-
leaveGroup
public ChannelFuture leaveGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source) Leave the specified multicast group at the specified interface using the specified source. -
block
public ChannelFuture block(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress sourceToBlock) Block the given sourceToBlock address for the given multicastAddress on the given networkInterface -
block
Block the given sourceToBlock address for the given multicastAddress -
getLocalSocketAddress
- Specified by:
getLocalSocketAddress
in classAbstractNioChannel<DatagramChannel>
- Throws:
Exception
-
getRemoteSocketAddress
- Specified by:
getRemoteSocketAddress
in classAbstractNioChannel<DatagramChannel>
- Throws:
Exception
-
write
Description copied from interface:Channel
Sends a message to this channel asynchronously. It has an additional parameter that allows a user to specify where to send the specified message instead of this channel's current remote address. If this channel was created by a connectionless transport (e.g.DatagramChannel
) and is not connected yet, you must specify non-null address. Otherwise, the write request will fail withNotYetConnectedException
and an'exceptionCaught'
event will be triggered.- Specified by:
write
in interfaceChannel
- Overrides:
write
in classAbstractChannel
- Parameters:
message
- the message to writeremoteAddress
- where to send the specified message. This method is identical toChannel.write(Object)
ifnull
is specified here.- Returns:
- the
ChannelFuture
which will be notified when the write request succeeds or fails
-