DatagramChannel (Netty/Transport 4.0.4.Final API)

All Superinterfaces:

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

All Known Implementing Classes:

NioDatagramChannel, OioDatagramChannel
```
public interface DatagramChannel
extends Channel
```
A UDP/IP Channel}.

Nested Class Summary
- Nested classes/interfaces inherited from interface io.netty.channel.Channel
  Channel.Unsafe

Method Summary

Methods
Modifier and Type	Method and Description
`io.netty.buffer.ByteBufAllocator`	`alloc()` Return the assigned `ByteBufAllocator` which will be used to allocate `ByteBuf`s.
`ChannelFuture`	`bind(SocketAddress localAddress)` Request to bind to the given `SocketAddress` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`bind(SocketAddress localAddress, ChannelPromise promise)` Request to bind to the given `SocketAddress` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`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 future)` 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 future)` Block the given sourceToBlock address for the given multicastAddress on the given networkInterface and notifies the `ChannelFuture` once the operation completes.
`ChannelFuture`	`close()` Request to close this ChannelOutboundInvoker and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`close(ChannelPromise promise)` Request to close this ChannelOutboundInvoker and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`DatagramChannelConfig`	`config()` Returns the configuration of this channel.
`ChannelFuture`	`connect(SocketAddress remoteAddress)` Request to connect to the given `SocketAddress` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`connect(SocketAddress remoteAddress, ChannelPromise promise)` Request to connect to the given `SocketAddress` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`connect(SocketAddress remoteAddress, SocketAddress localAddress)` Request to connect to the given `SocketAddress` while bind to the localAddress and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`connect(SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)` Request to connect to the given `SocketAddress` while bind to the localAddress and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`deregister()` Request to deregister this ChannelOutboundInvoker from the previous assigned `EventExecutor` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`deregister(ChannelPromise promise)` Request to deregister this ChannelOutboundInvoker from the previous assigned `EventExecutor` and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`disconnect()` Request to disconnect from the remote peer and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`ChannelFuture`	`disconnect(ChannelPromise promise)` Request to disconnect from the remote peer and notify the `ChannelFuture` once the operation completes, either because the operation was successful or because of an error.
`boolean`	`isConnected()` Return `true` if the `DatagramChannel` is connected to the remote peer.
`ChannelFuture`	`joinGroup(InetAddress multicastAddress)` Joins a multicast group and notifies the `ChannelFuture` once the operation completes.
`ChannelFuture`	`joinGroup(InetAddress multicastAddress, ChannelPromise future)` 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 future)` 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 future)` 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 future)` 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 future)` 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 future)` 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.
`ChannelFuture`	`newFailedFuture(Throwable cause)` Create a new `ChannelFuture` which is marked as failed already.
`ChannelProgressivePromise`	`newProgressivePromise()` Return an new `ChannelProgressivePromise`
`ChannelPromise`	`newPromise()` Return a new `ChannelPromise`.
`ChannelFuture`	`newSucceededFuture()` Create a new `ChannelFuture` which is marked as succeeded already.
`ChannelPipeline`	`pipeline()` Return the assigned `ChannelPipeline`
`InetSocketAddress`	`remoteAddress()` Returns the remote address where this channel is connected to.
`ChannelPromise`	`voidPromise()` Return a special ChannelPromise which can be reused for different operations.
`ChannelFuture`	`write(Object msg)` Request to write a message via this ChannelOutboundInvoker through the `ChannelPipeline`.
`ChannelFuture`	`write(Object msg, ChannelPromise promise)` Request to write a message via this ChannelOutboundInvoker through the `ChannelPipeline`.
`ChannelFuture`	`writeAndFlush(Object msg)` Shortcut for call `write(Object)` and `flush()`.
`ChannelFuture`	`writeAndFlush(Object msg, ChannelPromise promise)` Shortcut for call `write(Object, ChannelPromise)` and `flush()`.

Methods inherited from interface io.netty.channel.Channel
closeFuture, eventLoop, flush, isActive, isOpen, isRegistered, isWritable, metadata, parent, read, unsafe

Methods inherited from interface io.netty.util.AttributeMap
attr

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 DefaultAddressedEnvelope.recipient() to determine the origination of the received message as this method will return null.
  - isConnected
```
boolean isConnected()
```
    Return true if the DatagramChannel is connected to the remote peer.
  - joinGroup
```
ChannelFuture joinGroup(InetAddress multicastAddress)
```
    Joins a multicast group and notifies the ChannelFuture once the operation completes.
  - joinGroup
```
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.
  - joinGroup
```
ChannelFuture joinGroup(InetSocketAddress multicastAddress,
                      NetworkInterface networkInterface)
```
    Joins the specified multicast group at the specified interface and notifies the ChannelFuture once the operation completes.
  - joinGroup
```
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.
  - joinGroup
```
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.
  - joinGroup
```
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.
  - leaveGroup
```
ChannelFuture leaveGroup(InetAddress multicastAddress)
```
    Leaves a multicast group and notifies the ChannelFuture once the operation completes.
  - leaveGroup
```
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.
  - leaveGroup
```
ChannelFuture leaveGroup(InetSocketAddress multicastAddress,
                       NetworkInterface networkInterface)
```
    Leaves a multicast group on a specified local interface and notifies the ChannelFuture once the operation completes.
  - leaveGroup
```
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.
  - leaveGroup
```
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.
  - leaveGroup
```
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.
  - block
```
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.
  - block
```
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.
  - block
```
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.
  - block
```
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.
  - bind
```
ChannelFuture bind(SocketAddress localAddress)
```
    Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelOutboundHandler.bind(ChannelHandlerContext, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
  - connect
```
ChannelFuture connect(SocketAddress remoteAddress)
```
    Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
    If the connection fails because of a connection timeout, the ChannelFuture will get failed with a ConnectTimeoutException. If it fails because of connection refused a ConnectException will be used.
    This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
  - connect
```
ChannelFuture connect(SocketAddress remoteAddress,
                    SocketAddress localAddress)
```
    Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
  - disconnect
```
ChannelFuture disconnect()
```
    Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelOutboundHandler.disconnect(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
  - close
```
ChannelFuture close()
```
    Request to close this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. After it is closed it is not possible to reuse it again.
    This will result in having the ChannelOutboundHandler.close(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
  - deregister
```
ChannelFuture deregister()
```
    Request to deregister this ChannelOutboundInvoker from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error.
    This will result in having the ChannelOutboundHandler.deregister(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
  - bind
```
ChannelFuture bind(SocketAddress localAddress,
                 ChannelPromise promise)
```
    Request to bind to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified.
    This will result in having the ChannelOutboundHandler.bind(ChannelHandlerContext, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
  - connect
```
ChannelFuture connect(SocketAddress remoteAddress,
                    ChannelPromise promise)
```
    Request to connect to the given SocketAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelFuture will be notified.
    If the connection fails because of a connection timeout, the ChannelFuture will get failed with a ConnectTimeoutException. If it fails because of connection refused a ConnectException will be used.
    This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
  - connect
```
ChannelFuture connect(SocketAddress remoteAddress,
                    SocketAddress localAddress,
                    ChannelPromise promise)
```
    Request to connect to the given SocketAddress while bind to the localAddress and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified and also returned.
    This will result in having the ChannelOutboundHandler.connect(ChannelHandlerContext, SocketAddress, SocketAddress, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
  - disconnect
```
ChannelFuture disconnect(ChannelPromise promise)
```
    Request to disconnect from the remote peer and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified.
    This will result in having the ChannelOutboundHandler.disconnect(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
  - close
```
ChannelFuture close(ChannelPromise promise)
```
    Request to close this ChannelOutboundInvoker and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. After it is closed it is not possible to reuse it again. The given ChannelPromise will be notified.
    This will result in having the ChannelOutboundHandler.close(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
  - deregister
```
ChannelFuture deregister(ChannelPromise promise)
```
    Request to deregister this ChannelOutboundInvoker from the previous assigned EventExecutor and notify the ChannelFuture once the operation completes, either because the operation was successful or because of an error. The given ChannelPromise will be notified.
    This will result in having the ChannelOutboundHandler.deregister(ChannelHandlerContext, ChannelPromise) method called of the next ChannelOutboundHandler contained in the ChannelPipeline of the Channel.
  - write
```
ChannelFuture write(Object msg)
```
    Request to write a message via this ChannelOutboundInvoker through the ChannelPipeline. This method will not request to actual flush, so be sure to call flush() once you want to request to flush all pending data to the actual transport.
  - write
```
ChannelFuture write(Object msg,
                  ChannelPromise promise)
```
    Request to write a message via this ChannelOutboundInvoker through the ChannelPipeline. This method will not request to actual flush, so be sure to call flush() once you want to request to flush all pending data to the actual transport.
  - writeAndFlush
```
ChannelFuture writeAndFlush(Object msg,
                          ChannelPromise promise)
```
    Shortcut for call write(Object, ChannelPromise) and flush().
  - writeAndFlush
```
ChannelFuture writeAndFlush(Object msg)
```
    Shortcut for call write(Object) and flush().
  - pipeline
```
ChannelPipeline pipeline()
```
    Return the assigned ChannelPipeline
  - alloc
```
io.netty.buffer.ByteBufAllocator alloc()
```
    Return the assigned ByteBufAllocator which will be used to allocate ByteBufs.
  - newPromise
```
ChannelPromise newPromise()
```
    Return a new ChannelPromise.
  - newProgressivePromise
```
ChannelProgressivePromise newProgressivePromise()
```
    Return an new ChannelProgressivePromise
  - newSucceededFuture
```
ChannelFuture newSucceededFuture()
```
    Create a new ChannelFuture which is marked as succeeded already. So Future.isSuccess() will return true. All FutureListener added to it will be notified directly. Also every call of blocking methods will just return without blocking.
  - newFailedFuture
```
ChannelFuture newFailedFuture(Throwable cause)
```
    Create a new ChannelFuture which is marked as failed already. So Future.isSuccess() will return false. All FutureListener added to it will be notified directly. Also every call of blocking methods will just return without blocking.
  - voidPromise
```
ChannelPromise voidPromise()
```
    Return a special ChannelPromise which can be reused for different operations.
    It's only supported to use it for ChannelOutboundInvoker.write(Object, ChannelPromise).
    
    Be aware that the returned ChannelPromise will not support most operations and should only be used if you want to save an object allocation for every write operation. You will not be able to detect if the operation was complete, only if it failed as the implementation will call ChannelPipeline.fireExceptionCaught(Throwable) in this case.
    Be aware this is an expert feature and should be used with care!

Interface DatagramChannel

Nested Class Summary

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

Method Summary

Methods inherited from interface io.netty.channel.Channel

Methods inherited from interface io.netty.util.AttributeMap

Methods inherited from interface java.lang.Comparable

Method Detail

config

localAddress

remoteAddress

isConnected

joinGroup

joinGroup

joinGroup

joinGroup

joinGroup

joinGroup

leaveGroup

leaveGroup

leaveGroup

leaveGroup

leaveGroup

leaveGroup

block

block

block

block

bind

connect

connect

disconnect

close

deregister

bind

connect

connect

disconnect

close

deregister

write

write

writeAndFlush

writeAndFlush

pipeline

alloc

newPromise

newProgressivePromise

newSucceededFuture

newFailedFuture

voidPromise