org.jboss.netty.channel.socket

Interface DatagramChannel

All Superinterfaces:

Channel, java.lang.Comparable<Channel>

All Known Implementing Classes:

NioDatagramChannel, OioDatagramChannel

public interface DatagramChannel
extends Channel

A UDP/IP Channel which is created by DatagramChannelFactory.

Field Summary

Fields inherited from interface org.jboss.netty.channel.Channel

OP_NONE, OP_READ, OP_READ_WRITE, OP_WRITE

Method Summary

Modifier and Type	Method and Description
DatagramChannelConfig	getConfig() Returns the configuration of this channel.
java.net.InetSocketAddress	getLocalAddress() Returns the local address where this channel is bound to.
java.net.InetSocketAddress	getRemoteAddress() Returns the remote address where this channel is connected to.
ChannelFuture	joinGroup(java.net.InetAddress multicastAddress) Joins a multicast group.
ChannelFuture	joinGroup(java.net.InetSocketAddress multicastAddress, java.net.NetworkInterface networkInterface) Joins the specified multicast group at the specified interface.
ChannelFuture	leaveGroup(java.net.InetAddress multicastAddress) Leaves a multicast group.
ChannelFuture	leaveGroup(java.net.InetSocketAddress multicastAddress, java.net.NetworkInterface networkInterface) Leaves a multicast group on a specified local interface.

Methods inherited from interface org.jboss.netty.channel.Channel

bind, close, connect, disconnect, getAttachment, getCloseFuture, getFactory, getId, getInterestOps, getParent, getPipeline, getUserDefinedWritability, isBound, isConnected, isOpen, isReadable, isWritable, setAttachment, setInterestOps, setReadable, setUserDefinedWritability, unbind, write, write

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

getConfig

DatagramChannelConfig getConfig()

Description copied from interface: Channel

Returns the configuration of this channel.

Specified by:

getConfig in interface Channel

getLocalAddress

java.net.InetSocketAddress getLocalAddress()

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:

getLocalAddress in interface Channel

Returns:

the local address of this channel. null if this channel is not bound.

getRemoteAddress

java.net.InetSocketAddress getRemoteAddress()

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:

getRemoteAddress 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.

joinGroup

ChannelFuture joinGroup(java.net.InetAddress multicastAddress)

Joins a multicast group.

joinGroup

ChannelFuture joinGroup(java.net.InetSocketAddress multicastAddress,
                        java.net.NetworkInterface networkInterface)

Joins the specified multicast group at the specified interface.

leaveGroup

ChannelFuture leaveGroup(java.net.InetAddress multicastAddress)

Leaves a multicast group.

leaveGroup

ChannelFuture leaveGroup(java.net.InetSocketAddress multicastAddress,
                         java.net.NetworkInterface networkInterface)

Leaves a multicast group on a specified local interface.