Netty 5.0.0.Alpha5 · io.netty5.channel.socket.DatagramChannel

`ChannelOption`	`INET`	`INET6`	`UNIX`
`ChannelOption#DATAGRAM_CHANNEL_ACTIVE_ON_REGISTRATION`	X	X	-
`ChannelOption#SO_BROADCAST`	X	X	-
`ChannelOption#SO_REUSEADDR`	X	X	-
`ChannelOption#SO_RCVBUF`	X	X	X
`ChannelOption#SO_SNDBUF`	X	X	X
`ChannelOption#IP_MULTICAST_LOOP_DISABLED`	X	X	-
`ChannelOption#IP_MULTICAST_IF`	X	X	-
`ChannelOption#IP_MULTICAST_TTL`	X	X	-
`ChannelOption#IP_TOS`	X	X	-

Method Summary

Modifier and Type	Method and Description
public Future<Void>	Returns: a `Future` which is notified once the operation completes. block(InetAddress the multicast group address. multicastAddress, NetworkInterface the interface to use. networkInterface, InetAddress the source address. sourceToBlock) Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the `Future` once the operation completes.
public Future<Void>	Returns: a `Future` which is notified once the operation completes. block(InetAddress the multicast group address. multicastAddress, InetAddress the source address. sourceToBlock) Block the given sourceToBlock address for the given multicastAddress and notifies the `Future` once the operation completes.
public boolean	isConnected() Return `true` if the `DatagramChannel` is connected to the remote peer.
public Future<Void>	Returns: a `Future` which is notified once the operation completes. joinGroup(InetAddress the multicast group address. multicastAddress) Joins a multicast group and notifies the `Future` once the operation completes.
public Future<Void>	Returns: a `Future` which is notified once the operation completes. joinGroup(InetAddress the multicast group address. multicastAddress, NetworkInterface the interface to use. networkInterface, InetAddress the source address (might be `null`). source) Joins the specified multicast group at the specified interface and notifies the `Future` once the operation completes.
public Future<Void>	Returns: a `Future` which is notified once the operation completes. leaveGroup(InetAddress the multicast group address. multicastAddress) Leaves a multicast group and notifies the `Future` once the operation completes.
public Future<Void>	Returns: a `Future` which is notified once the operation completes. leaveGroup(InetAddress the multicast group address. multicastAddress, NetworkInterface the interface to use. networkInterface, InetAddress the source address (might be `null`). source) Leave the specified multicast group at the specified interface using the specified source and notifies the `Future` once the operation completes.

Method Detail

block back to summary

block	back to summary
public Future<Void> block(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress sourceToBlock) Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the `Future` once the operation completes. If the underlying implementation does not support this operation it will return a `Future` which is failed with an `UnsupportedOperationException`. Parameters multicastAddress:InetAddress the multicast group address. networkInterface:NetworkInterface the interface to use. sourceToBlock:InetAddress the source address. Returns:Future<Void> a `Future` which is notified once the operation completes.

public Future<Void> block(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress sourceToBlock)

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

If the underlying implementation does not support this operation it will return a Future which is failed with an UnsupportedOperationException.

Parameters

multicastAddress:InetAddress: the multicast group address.
networkInterface:NetworkInterface: the interface to use.
sourceToBlock:InetAddress: the source address.

Returns:Future<Void>

a Future which is notified once the operation completes.

block back to summary

block	back to summary
public Future<Void> block(InetAddress multicastAddress, InetAddress sourceToBlock) Block the given sourceToBlock address for the given multicastAddress and notifies the `Future` once the operation completes. If the underlying implementation does not support this operation it will return a `Future` which is failed with an `UnsupportedOperationException`. Parameters multicastAddress:InetAddress the multicast group address. sourceToBlock:InetAddress the source address. Returns:Future<Void> a `Future` which is notified once the operation completes.

public Future<Void> block(InetAddress multicastAddress, InetAddress sourceToBlock)

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

If the underlying implementation does not support this operation it will return a Future which is failed with an UnsupportedOperationException.

Parameters

multicastAddress:InetAddress: the multicast group address.
sourceToBlock:InetAddress: the source address.

Returns:Future<Void>

a Future which is notified once the operation completes.

isConnected	back to summary
public boolean isConnected() Return `true` if the `DatagramChannel` is connected to the remote peer.

joinGroup back to summary

joinGroup	back to summary
public Future<Void> joinGroup(InetAddress multicastAddress) Joins a multicast group and notifies the `Future` once the operation completes. If the underlying implementation does not support this operation it will return a `Future` which is failed with an `UnsupportedOperationException`. Parameters multicastAddress:InetAddress the multicast group address. Returns:Future<Void> a `Future` which is notified once the operation completes.

public Future<Void> joinGroup(InetAddress multicastAddress)

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

If the underlying implementation does not support this operation it will return a Future which is failed with an UnsupportedOperationException.

Parameters

multicastAddress:InetAddress: the multicast group address.

Returns:Future<Void>

a Future which is notified once the operation completes.

joinGroup back to summary

joinGroup	back to summary
public Future<Void> joinGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source) Joins the specified multicast group at the specified interface and notifies the `Future` once the operation completes. If the underlying implementation does not support this operation it will return a `Future` which is failed with an `UnsupportedOperationException`. Parameters multicastAddress:InetAddress the multicast group address. networkInterface:NetworkInterface the interface to use. source:InetAddress the source address (might be `null`). Returns:Future<Void> a `Future` which is notified once the operation completes.

public Future<Void> joinGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source)

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

If the underlying implementation does not support this operation it will return a Future which is failed with an UnsupportedOperationException.

Parameters

multicastAddress:InetAddress: the multicast group address.
networkInterface:NetworkInterface: the interface to use.
source:InetAddress: the source address (might be null).

Returns:Future<Void>

a Future which is notified once the operation completes.

leaveGroup back to summary

leaveGroup	back to summary
public Future<Void> leaveGroup(InetAddress multicastAddress) Leaves a multicast group and notifies the `Future` once the operation completes. If the underlying implementation does not support this operation it will return a `Future` which is failed with an `UnsupportedOperationException`. Parameters multicastAddress:InetAddress the multicast group address. Returns:Future<Void> a `Future` which is notified once the operation completes.

public Future<Void> leaveGroup(InetAddress multicastAddress)

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

If the underlying implementation does not support this operation it will return a Future which is failed with an UnsupportedOperationException.

Parameters

multicastAddress:InetAddress: the multicast group address.

Returns:Future<Void>

a Future which is notified once the operation completes.

leaveGroup back to summary

leaveGroup	back to summary
public Future<Void> leaveGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source) Leave the specified multicast group at the specified interface using the specified source and notifies the `Future` once the operation completes. If the underlying implementation does not support this operation it will return a `Future` which is failed with an `UnsupportedOperationException`. Parameters multicastAddress:InetAddress the multicast group address. networkInterface:NetworkInterface the interface to use. source:InetAddress the source address (might be `null`). Returns:Future<Void> a `Future` which is notified once the operation completes.

public Future<Void> leaveGroup(InetAddress multicastAddress, NetworkInterface networkInterface, InetAddress source)

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

If the underlying implementation does not support this operation it will return a Future which is failed with an UnsupportedOperationException.

Parameters

multicastAddress:InetAddress: the multicast group address.
networkInterface:NetworkInterface: the interface to use.
source:InetAddress: the source address (might be null).

Returns:Future<Void>

a Future which is notified once the operation completes.

public Interface DatagramChannel

Available options

Method Summary

Method Detail