Top Description Methods
io.netty.channel.socket

public Interface DatagramChannel

extends Channel
Known Direct Implementers
io.netty.channel.socket.nio.NioDatagramChannel, io.netty.channel.socket.oio.OioDatagramChannel
Imports
io.netty.channel.Channel, .ChannelFuture, .ChannelPromise, java.net.InetAddress, .InetSocketAddress, .NetworkInterface

A UDP/IP Channel.

Method Summary

Modifier and TypeMethod and Description
public 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.

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

Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the ChannelFuture once the operation completes.

public ChannelFuture
block(InetAddress multicastAddress, InetAddress sourceToBlock)

Block the given sourceToBlock address for the given multicastAddress and notifies the ChannelFuture once the operation completes.

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

Block the given sourceToBlock address for the given multicastAddress and notifies the ChannelFuture once the operation completes.

public DatagramChannelConfig
config()

Redeclares io.netty.channel.Channel.config.

Returns the configuration of this channel.
public boolean
isConnected()

Return true if the DatagramChannel is connected to the remote peer.

public ChannelFuture
joinGroup(InetAddress multicastAddress)

Joins a multicast group and notifies the ChannelFuture once the operation completes.

public ChannelFuture
joinGroup(InetAddress multicastAddress, ChannelPromise future)

Joins a multicast group and notifies the ChannelFuture once the operation completes.

public ChannelFuture
joinGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface)

Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.

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

Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.

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

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

Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.

public ChannelFuture
leaveGroup(InetAddress multicastAddress)

Leaves a multicast group and notifies the ChannelFuture once the operation completes.

public ChannelFuture
leaveGroup(InetAddress multicastAddress, ChannelPromise future)

Leaves a multicast group and notifies the ChannelFuture once the operation completes.

public ChannelFuture
leaveGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface)

Leaves a multicast group on a specified local interface and notifies the ChannelFuture once the operation completes.

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

Leaves a multicast group on a specified local interface and notifies the ChannelFuture once the operation completes.

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

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

Leave the specified multicast group at the specified interface using the specified source and notifies the ChannelFuture once the operation completes.

public InetSocketAddress
localAddress()

Redeclares io.netty.channel.Channel.localAddress.

Returns the local address where this channel is bound to.
public InetSocketAddress
remoteAddress()

Redeclares io.netty.channel.Channel.remoteAddress.

Returns the remote address where this channel is connected to.
Inherited from io.netty.channel.Channel:
allocbytesBeforeUnwritablebytesBeforeWritablecloseFutureeventLoopflushidisActiveisOpenisRegisteredisWritablemetadataparentpipelinereadunsafe

Method Detail

blockback to summary
public 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. The given ChannelFuture will be notified and also returned.

blockback to summary
public ChannelFuture block(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress sourceToBlock, ChannelPromise future)

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.

blockback to summary
public ChannelFuture block(InetAddress multicastAddress, InetAddress sourceToBlock)

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.

blockback to summary
public ChannelFuture block(InetAddress multicastAddress, InetAddress sourceToBlock, ChannelPromise future)

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.

configback to summary
public DatagramChannelConfig config()

Redeclares io.netty.channel.Channel.config.

Doc from io.netty.channel.Channel.config.

Returns the configuration of this channel.

Annotations
@Override
isConnectedback to summary
public boolean isConnected()

Return true if the DatagramChannel is connected to the remote peer.

joinGroupback to summary
public ChannelFuture joinGroup(InetAddress multicastAddress)

Joins a multicast group and notifies the ChannelFuture once the operation completes.

joinGroupback to summary
public ChannelFuture joinGroup(InetAddress multicastAddress, ChannelPromise future)

Joins a multicast group and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

joinGroupback to summary
public ChannelFuture joinGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface)

Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.

joinGroupback to summary
public ChannelFuture joinGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface, ChannelPromise future)

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.

joinGroupback to summary
public 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.

joinGroupback to summary
public ChannelFuture joinGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, ChannelPromise future)

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.

leaveGroupback to summary
public ChannelFuture leaveGroup(InetAddress multicastAddress)

Leaves a multicast group and notifies the ChannelFuture once the operation completes.

leaveGroupback to summary
public ChannelFuture leaveGroup(InetAddress multicastAddress, ChannelPromise future)

Leaves a multicast group and notifies the ChannelFuture once the operation completes. The given ChannelFuture will be notified and also returned.

leaveGroupback to summary
public ChannelFuture leaveGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface)

Leaves a multicast group on a specified local interface and notifies the ChannelFuture once the operation completes.

leaveGroupback to summary
public ChannelFuture leaveGroup(InetSocketAddress multicastAddress, NetworkInterface networkInterface, ChannelPromise future)

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.

leaveGroupback to summary
public 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.

leaveGroupback to summary
public ChannelFuture leaveGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source, ChannelPromise future)

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.

localAddressback to summary
public InetSocketAddress localAddress()

Redeclares io.netty.channel.Channel.localAddress.

Doc from io.netty.channel.Channel.localAddress.

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.

Returns:InetSocketAddress

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

Annotations
@Override
remoteAddressback to summary
public InetSocketAddress remoteAddress()

Redeclares io.netty.channel.Channel.remoteAddress.

Doc from io.netty.channel.Channel.remoteAddress.

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.

Returns:InetSocketAddress

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

Annotations
@Override