io.netty.channel.socket

Interface DatagramChannel

All Superinterfaces:

io.netty.util.AttributeMap, Channel, ChannelFutureFactory, ChannelOutboundInvoker, Comparable<Channel>

All Known Implementing Classes:

NioDatagramChannel, OioDatagramChannel

public interface DatagramChannel
extends Channel

A UDP/IP Channel which is created by DatagramChannelFactory.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.Channel

Channel.Unsafe

Method Summary

Methods

Modifier and Type	Method and Description
ChannelFuture	block(InetAddress multicastAddress, InetAddress sourceToBlock) Block the given sourceToBlock address for the given multicastAddress
ChannelFuture	block(InetAddress multicastAddress, InetAddress sourceToBlock, ChannelFuture future) 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, ChannelFuture future) Block the given sourceToBlock address for the given multicastAddress on the given networkInterface
DatagramChannelConfig	config() Returns the configuration of this channel.
boolean	isConnected()
ChannelFuture	joinGroup(InetAddress multicastAddress) Joins a multicast group.
ChannelFuture	joinGroup(InetAddress multicastAddress, ChannelFuture future)
ChannelFuture	joinGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source)
ChannelFuture	joinGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, ChannelFuture future)
ChannelFuture	joinGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface) Joins the specified multicast group at the specified interface.
ChannelFuture	joinGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface, ChannelFuture future)
ChannelFuture	leaveGroup(InetAddress multicastAddress) Leaves a multicast group.
ChannelFuture	leaveGroup(InetAddress multicastAddress, ChannelFuture future)
ChannelFuture	leaveGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source) Leave the specified multicast group at the specified interface using the specified source.
ChannelFuture	leaveGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, ChannelFuture future)
ChannelFuture	leaveGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface) Leaves a multicast group on a specified local interface.
ChannelFuture	leaveGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface, ChannelFuture future)
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 io.netty.channel.Channel

closeFuture, eventLoop, id, isActive, isOpen, isRegistered, metadata, outboundByteBuffer, outboundMessageBuffer, parent, pipeline, unsafe

Methods inherited from interface io.netty.util.AttributeMap

attr

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker

bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, flush, flush, write, write

Methods inherited from interface io.netty.channel.ChannelFutureFactory

newFailedFuture, newFuture, newSucceededFuture

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

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 MessageEvent#getRemoteAddress() to determine the origination of the received message as this method will return null.

isConnected

boolean isConnected()

joinGroup

ChannelFuture joinGroup(InetAddress multicastAddress)

Joins a multicast group.

joinGroup

ChannelFuture joinGroup(InetAddress multicastAddress,
                      ChannelFuture future)

joinGroup

ChannelFuture joinGroup(InetSocketAddress multicastAddress,
                      NetworkInterface networkInterface)

Joins the specified multicast group at the specified interface.

joinGroup

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

joinGroup

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

joinGroup

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

leaveGroup

ChannelFuture leaveGroup(InetAddress multicastAddress)

Leaves a multicast group.

leaveGroup

ChannelFuture leaveGroup(InetAddress multicastAddress,
                       ChannelFuture future)

leaveGroup

ChannelFuture leaveGroup(InetSocketAddress multicastAddress,
                       NetworkInterface networkInterface)

Leaves a multicast group on a specified local interface.

leaveGroup

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

leaveGroup

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

Leave the specified multicast group at the specified interface using the specified source.

leaveGroup

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

block

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

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

block

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

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

block

ChannelFuture block(InetAddress multicastAddress,
                  InetAddress sourceToBlock)

Block the given sourceToBlock address for the given multicastAddress

block

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

Block the given sourceToBlock address for the given multicastAddress