io.netty.channel.socket.oio

Class OioDatagramChannel

java.lang.Object

io.netty.util.DefaultAttributeMap

io.netty.channel.AbstractChannel

io.netty.channel.oio.AbstractOioChannel

io.netty.channel.oio.AbstractOioMessageChannel

io.netty.channel.socket.oio.OioDatagramChannel

All Implemented Interfaces:

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

public class OioDatagramChannel
extends AbstractOioMessageChannel
implements DatagramChannel

An OIO datagram Channel that sends and receives an AddressedEnvelope.

See Also:

AddressedEnvelope, DatagramPacket

Nested Class Summary

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 inherited from class io.netty.channel.oio.AbstractOioChannel

SO_TIMEOUT

Constructor Summary

Constructors

Constructor and Description
OioDatagramChannel() Create a new instance with an new MulticastSocket.
OioDatagramChannel(MulticastSocket socket) Create a new instance from the given MulticastSocket.

Method Summary

Modifier and Type	Method and 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 promise) 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 promise) 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.
protected void	doBind(SocketAddress localAddress) Bind the Channel to the SocketAddress
protected void	doClose() Close the Channel
protected void	doConnect(SocketAddress remoteAddress, SocketAddress localAddress) Connect to the remote peer using the given localAddress if one is specified or null otherwise.
protected void	doDisconnect() Disconnect this Channel from its remote peer
protected int	doReadMessages(List<Object> buf) Read messages into the given array and return the amount which was read.
protected void	doWrite(ChannelOutboundBuffer in) Flush the content of the given buffer to the remote peer.
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.
boolean	isOpen() Returns true if the Channel is open and may get active later
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.
InetSocketAddress	remoteAddress() Returns the remote address where this channel is connected to.
protected SocketAddress	remoteAddress0() Return the SocketAddress which the Channel is connected to.

Methods inherited from class io.netty.channel.oio.AbstractOioMessageChannel

doRead

Methods inherited from class io.netty.channel.oio.AbstractOioChannel

clearReadPending, doBeginRead, isCompatible, isReadPending, newUnsafe, setReadPending

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, doDeregister, doRegister, equals, eventLoop, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, toString, unsafe, 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.channel.Channel

alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isRegistered, isWritable, parent, pipeline, read, unsafe

Methods inherited from interface io.netty.util.AttributeMap

attr, hasAttr

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

Constructor Detail

OioDatagramChannel

public OioDatagramChannel()

Create a new instance with an new MulticastSocket.

OioDatagramChannel

public OioDatagramChannel(MulticastSocket socket)

Create a new instance from the given MulticastSocket.

Parameters:

socket - the MulticastSocket which is used by this instance

Method Detail

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

isOpen

public boolean isOpen()

Description copied from interface: Channel

Returns true if the Channel is open and may get active later

Specified by:

isOpen 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

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

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.

doConnect

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

Description copied from class: AbstractOioChannel

Connect to the remote peer using the given localAddress if one is specified or null otherwise.

Specified by:

doConnect in class AbstractOioChannel

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

Specified by:

doClose in class AbstractChannel

Throws:

Exception

doReadMessages

protected int doReadMessages(List<Object> buf)
                      throws Exception

Description copied from class: AbstractOioMessageChannel

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

Specified by:

doReadMessages in class AbstractOioMessageChannel

Throws:

Exception

doWrite

protected void doWrite(ChannelOutboundBuffer in)
                throws Exception

Description copied from class: AbstractChannel

Flush the content of the given buffer to the remote peer.

Specified by:

doWrite in class AbstractChannel

Throws:

Exception

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

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)

Description copied from interface: DatagramChannel

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.

Specified by:

block in interface DatagramChannel

block

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

Description copied from interface: DatagramChannel

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.

Specified by:

block in interface DatagramChannel

block

public ChannelFuture block(InetAddress multicastAddress,
                           InetAddress sourceToBlock)

Description copied from interface: DatagramChannel

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.

Specified by:

block in interface DatagramChannel

block

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

Description copied from interface: DatagramChannel

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.

Specified by:

block in interface DatagramChannel