NioDatagramChannel (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.util.DefaultAttributeMap
- - io.netty.channel.AbstractChannel
  - - io.netty.channel.nio.AbstractNioChannel
    - - io.netty.channel.nio.AbstractNioMessageChannel
      - io.netty.channel.socket.nio.NioDatagramChannel

All Implemented Interfaces:

Channel ， ChannelOutboundInvoker ， DatagramChannel ， AttributeMap ，java.lang.Comparable的< Channel >
```
public final class NioDatagramChannel
extends AbstractNioMessageChannel
implements DatagramChannel
```
一个数据报NIO Channel发送和接收的AddressedEnvelope 。

另请参见：

AddressedEnvelope ， DatagramPacket

Nested Class Summary
- Nested classes/interfaces inherited from class io.netty.channel.nio.AbstractNioChannel
  AbstractNioChannel.AbstractNioUnsafe, AbstractNioChannel.NioUnsafe
- Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel
  AbstractChannel.AbstractUnsafe
- Nested classes/interfaces inherited from interface io.netty.channel.Channel
  Channel.Unsafe

Field Summary
- Fields inherited from class io.netty.channel.nio.AbstractNioChannel
  readInterestOp

构造方法摘要

构造方法
Constructor and Description
`NioDatagramChannel()` 创建一个将使用操作系统默认值`InternetProtocolFamily`的新实例。
`NioDatagramChannel(java.nio.channels.DatagramChannel socket)` 从给定的 `DatagramChannel`创建一个新实例。
`NioDatagramChannel(InternetProtocolFamily ipFamily)` 使用给定的`InternetProtocolFamily`创建一个新实例。
`NioDatagramChannel(java.nio.channels.spi.SelectorProvider provider)` 使用给定的`SelectorProvider`创建一个新实例，该实例将使用操作系统默认值`InternetProtocolFamily` 。
`NioDatagramChannel(java.nio.channels.spi.SelectorProvider provider, InternetProtocolFamily ipFamily)` 使用给定的`SelectorProvider`和`InternetProtocolFamily`创建一个新实例。

方法摘要

所有方法接口方法具体的方法弃用的方法
Modifier and Type	Method and Description
`ChannelFuture`	`block(java.net.InetAddress multicastAddress, java.net.InetAddress sourceToBlock)` 阻止给定多播地址的给定sourceToBlock地址
`ChannelFuture`	`block(java.net.InetAddress multicastAddress, java.net.InetAddress sourceToBlock, ChannelPromise promise)` 阻止给定多播地址的给定sourceToBlock地址
`ChannelFuture`	`block(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress sourceToBlock)` 阻止给定networkInterface上给定多播地址的给定sourceToBlock地址
`ChannelFuture`	`block(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress sourceToBlock, ChannelPromise promise)` 阻止给定networkInterface上给定多播地址的给定sourceToBlock地址
`protected boolean`	`closeOnReadError(java.lang.Throwable cause)`
`DatagramChannelConfig`	`config()` 返回此频道的配置。
`protected boolean`	`continueOnWriteError()` 如果我们应该在写入错误时继续写入循环，则返回 `true` 。
`protected void`	`doBind(java.net.SocketAddress localAddress)` 将`Channel`绑定到`SocketAddress`
`protected void`	`doClose()` 关闭`Channel`
`protected boolean`	`doConnect(java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress)` 连接到远程对等
`protected void`	`doDisconnect()` 断开此`Channel`与其远程对等端的连接
`protected void`	`doFinishConnect()` 完成连接
`protected int`	`doReadMessages(java.util.List<java.lang.Object> buf)` 将消息读入给定数组并返回读取的数量。
`protected boolean`	`doWriteMessage(java.lang.Object msg, ChannelOutboundBuffer in)` 写下消息到底层 `Channel` 。
`protected java.lang.Object`	`filterOutboundMessage(java.lang.Object msg)` 当新消息添加到此`AbstractChannel`的`ChannelOutboundBuffer`中时调用，以便`Channel`实现将消息转换为另一个消息。
`boolean`	`isActive()` 如果`Channel`处于活动状态且已连接，则返回`true` 。
`boolean`	`isConnected()` 如果`DatagramChannel`连接到远程对等端，则返回`true` 。
`protected java.nio.channels.DatagramChannel`	`javaChannel()`
`ChannelFuture`	`joinGroup(java.net.InetAddress multicastAddress)` 加入一个多播组，并在操作完成后通知`ChannelFuture` 。
`ChannelFuture`	`joinGroup(java.net.InetAddress multicastAddress, ChannelPromise promise)` 一旦操作完成，就加入多播组并通知`ChannelFuture` 。
`ChannelFuture`	`joinGroup(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress source)` 在指定的接口加入指定的组播组，并在操作完成后通知`ChannelFuture` 。
`ChannelFuture`	`joinGroup(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress source, ChannelPromise promise)` 在指定的接口加入指定的组播组，并在操作完成后通知`ChannelFuture` 。
`ChannelFuture`	`joinGroup(java.net.InetSocketAddress multicastAddress, java.net.NetworkInterface networkInterface)` 在指定的接口加入指定的组播组，并在操作完成后通知`ChannelFuture` 。
`ChannelFuture`	`joinGroup(java.net.InetSocketAddress multicastAddress, java.net.NetworkInterface networkInterface, ChannelPromise promise)` 在指定的接口加入指定的组播组，并在操作完成后通知`ChannelFuture` 。
`ChannelFuture`	`leaveGroup(java.net.InetAddress multicastAddress)` 一个操作完成后，离开多播组并通知`ChannelFuture` 。
`ChannelFuture`	`leaveGroup(java.net.InetAddress multicastAddress, ChannelPromise promise)` 一旦操作完成，就离开多播组并通知`ChannelFuture` 。
`ChannelFuture`	`leaveGroup(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress source)` 在指定的接口上使用指定的源保留指定的多播组，并在操作完成后通知`ChannelFuture` 。
`ChannelFuture`	`leaveGroup(java.net.InetAddress multicastAddress, java.net.NetworkInterface networkInterface, java.net.InetAddress source, ChannelPromise promise)` 在指定的接口上使用指定的源保留指定的多播组，并在操作完成后通知`ChannelFuture` 。
`ChannelFuture`	`leaveGroup(java.net.InetSocketAddress multicastAddress, java.net.NetworkInterface networkInterface)` 在指定的本地接口上留下多播组，并在操作完成后通知`ChannelFuture` 。
`ChannelFuture`	`leaveGroup(java.net.InetSocketAddress multicastAddress, java.net.NetworkInterface networkInterface, ChannelPromise promise)` 在指定的本地接口上留下多播组，并在操作完成后通知`ChannelFuture` 。
`java.net.InetSocketAddress`	`localAddress()` 返回此通道绑定的本地地址。
`protected java.net.SocketAddress`	`localAddress0()` 返回本地绑定的 `SocketAddress` 。
`ChannelMetadata`	`metadata()` 返回`ChannelMetadata`的的`Channel`其描述的性质`Channel` 。
`java.net.InetSocketAddress`	`remoteAddress()` 返回此通道连接到的远程地址。
`protected java.net.SocketAddress`	`remoteAddress0()` 返回`SocketAddress`其中`Channel`被连接到。
`protected void`	`setReadPending(boolean readPending)` 已过时。

Methods inherited from class io.netty.channel.nio.AbstractNioMessageChannel
doBeginRead, doWrite, newUnsafe

Methods inherited from class io.netty.channel.nio.AbstractNioChannel
clearReadPending, doDeregister, doRegister, eventLoop, isCompatible, isOpen, isReadPending, newDirectBuffer, newDirectBuffer, selectionKey, unsafe

Methods inherited from class io.netty.channel.AbstractChannel
alloc, bind, bind, bytesBeforeUnwritable, bytesBeforeWritable, close, close, closeFuture, compareTo, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, doShutdownOutput, equals, flush, hashCode, id, invalidateLocalAddress, invalidateRemoteAddress, isRegistered, isWritable, newChannelPipeline, newFailedFuture, newId, newProgressivePromise, newPromise, newSucceededFuture, parent, pipeline, read, toString, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from class io.netty.util.DefaultAttributeMap
attr, hasAttr

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface io.netty.channel.Channel
alloc, bytesBeforeUnwritable, bytesBeforeWritable, closeFuture, eventLoop, flush, id, isOpen, isRegistered, isWritable, parent, pipeline, read, unsafe

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

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker
bind, bind, close, close, connect, connect, connect, connect, deregister, deregister, disconnect, disconnect, newFailedFuture, newProgressivePromise, newPromise, newSucceededFuture, voidPromise, write, write, writeAndFlush, writeAndFlush

Methods inherited from interface java.lang.Comparable
compareTo

- 构造方法详细信息
  - NioDatagramChannel
```
public NioDatagramChannel()
```
    创建一个将使用操作系统默认值InternetProtocolFamily的新实例。
  - NioDatagramChannel
```
public NioDatagramChannel(java.nio.channels.spi.SelectorProvider provider)
```
    使用给定的SelectorProvider创建一个新实例，该实例将使用操作系统默认值InternetProtocolFamily 。
  - NioDatagramChannel
```
public NioDatagramChannel(InternetProtocolFamily ipFamily)
```
    使用给定的InternetProtocolFamily创建一个新实例。如果使用null ，则取决于将要选择的操作系统默认值。
  - NioDatagramChannel
```
public NioDatagramChannel(java.nio.channels.spi.SelectorProvider provider,
                          InternetProtocolFamily ipFamily)
```
    使用给定的SelectorProvider和InternetProtocolFamily创建一个新实例。如果InternetProtocolFamily是null它将取决于将选择的操作系统默认值。
  - NioDatagramChannel
```
public NioDatagramChannel(java.nio.channels.DatagramChannel socket)
```
    从给定的 DatagramChannel创建一个新实例。
- 方法详细信息
  - metadata
```
public ChannelMetadata metadata()
```
    从接口Channel复制的描述
    
    返回ChannelMetadata的的Channel其描述的性质Channel 。
    
    Specified by:
    
    metadata在界面 Channel
  - config
```
public DatagramChannelConfig config()
```
    从接口复制的描述： Channel
    
    返回此频道的配置。
    
    Specified by:
    
    config在界面 Channel
    
    Specified by:
    
    config在界面 DatagramChannel
  - isActive
```
public boolean isActive()
```
    从接口Channel复制的描述
    
    如果Channel处于活动状态并已连接，则返回true 。
    
    Specified by:
    
    isActive在界面 Channel
  - isConnected
```
public boolean isConnected()
```
    从界面复制的描述： DatagramChannel
    
    如果DatagramChannel连接到远程对等端，则返回true 。
    
    Specified by:
    
    isConnected在界面 DatagramChannel
  - javaChannel
```
protected java.nio.channels.DatagramChannel javaChannel()
```
    重写：
    
    javaChannel在课堂上 AbstractNioChannel
  - localAddress0
```
protected java.net.SocketAddress localAddress0()
```
    从类复制的描述： AbstractChannel
    
    返回本地绑定的 SocketAddress 。
    
    Specified by:
    
    localAddress0在课堂 AbstractChannel
  - remoteAddress0
```
protected java.net.SocketAddress remoteAddress0()
```
    从类复制的描述： AbstractChannel
    
    返回SocketAddress连接的SocketAddress 。
    
    Specified by:
    
    remoteAddress0在课堂上 AbstractChannel
  - doBind
```
protected void doBind(java.net.SocketAddress localAddress)
               throws java.lang.Exception
```
    从类复制的描述： AbstractChannel
    
    将Channel绑定到SocketAddress
    
    Specified by:
    
    doBind在课堂 AbstractChannel
    
    异常
    
    java.lang.Exception
  - doConnect
```
protected boolean doConnect(java.net.SocketAddress remoteAddress,
                            java.net.SocketAddress localAddress)
                     throws java.lang.Exception
```
    从类复制的描述： AbstractNioChannel
    
    连接到远程对等
    
    Specified by:
    
    doConnect的 AbstractNioChannel
    
    异常
    
    java.lang.Exception
  - doFinishConnect
```
protected void doFinishConnect()
                        throws java.lang.Exception
```
    从类复制的描述： AbstractNioChannel
    
    完成连接
    
    Specified by:
    
    doFinishConnect在课堂上 AbstractNioChannel
    
    异常
    
    java.lang.Exception
  - doDisconnect
```
protected void doDisconnect()
                     throws java.lang.Exception
```
    从类复制的描述： AbstractChannel
    
    断开此Channel与其远程对等端的连接
    
    Specified by:
    
    doDisconnect在课堂上 AbstractChannel
    
    异常
    
    java.lang.Exception
  - doClose
```
protected void doClose()
                throws java.lang.Exception
```
    从类复制的描述： AbstractChannel
    
    关闭Channel
    
    重写：
    
    doClose在课堂上 AbstractNioChannel
    
    异常
    
    java.lang.Exception
  - doReadMessages
```
protected int doReadMessages(java.util.List<java.lang.Object> buf)
                      throws java.lang.Exception
```
    从类复制的描述： AbstractNioMessageChannel
    
    将消息读入给定数组并返回读取的数量。
    
    Specified by:
    
    doReadMessages在课堂 AbstractNioMessageChannel
    
    异常
    
    java.lang.Exception
  - doWriteMessage
```
protected boolean doWriteMessage(java.lang.Object msg,
                                 ChannelOutboundBuffer in)
                          throws java.lang.Exception
```
    从类复制的描述： AbstractNioMessageChannel
    
    给底层的 Channel写一条消息。
    
    Specified by:
    
    doWriteMessage在课堂上 AbstractNioMessageChannel
    
    结果
    
    true当且仅当消息已被写入
    
    异常
    
    java.lang.Exception
  - filterOutboundMessage
```
protected java.lang.Object filterOutboundMessage(java.lang.Object msg)
```
    从类复制的描述： AbstractChannel
    
    当一个新的消息被添加到调用ChannelOutboundBuffer如此AbstractChannel ，使Channel实施消息转换为另一种。（例如堆缓冲区 - >直接缓冲区）
    
    重写：
    
    filterOutboundMessage在课堂 AbstractChannel
  - continueOnWriteError
```
protected boolean continueOnWriteError()
```
    从类复制的描述： AbstractNioMessageChannel
    
    如果我们应该在写入错误时继续写循环，则返回 true 。
    
    重写：
    
    continueOnWriteError在课堂上 AbstractNioMessageChannel
  - localAddress
```
public java.net.InetSocketAddress localAddress()
```
    从接口Channel复制的描述
    
    返回此通道绑定的本地地址。返回的SocketAddress应该被下调为更具体的类型，例如InetSocketAddress以检索详细信息。
    
    Specified by:
    
    localAddress在界面 Channel
    
    Specified by:
    
    localAddress在界面 DatagramChannel
    
    重写：
    
    localAddress在课堂 AbstractChannel
    
    结果
    
    这个频道的本地地址。 null如果此通道未绑定。
  - remoteAddress
```
public java.net.InetSocketAddress remoteAddress()
```
    从接口Channel复制的描述
    
    返回此通道连接到的远程地址。返回的SocketAddress应该被下调为更具体的类型，例如InetSocketAddress以检索详细信息。
    
    Specified by:
    
    remoteAddress在界面 Channel
    
    Specified by:
    
    remoteAddress在界面 DatagramChannel
    
    重写：
    
    remoteAddress在课堂上 AbstractChannel
    
    结果
    
    该频道的远程地址。 null如果此通道未连接。如果此通道未连接，但它可以接收来自任意远程地址的消息（例如DatagramChannel ，请使用DefaultAddressedEnvelope.recipient()来确定接收消息的来源，因为此方法将返回null 。
  - joinGroup
```
public ChannelFuture joinGroup(java.net.InetAddress multicastAddress)
```
    从接口复制的描述： DatagramChannel
    
    加入一个多播组，并在操作完成后通知ChannelFuture 。
    
    Specified by:
    
    joinGroup ，界面 DatagramChannel
  - joinGroup
```
public ChannelFuture joinGroup(java.net.InetAddress multicastAddress,
                               ChannelPromise promise)
```
    从接口复制的描述： DatagramChannel
    
    加入一个多播组，并在操作完成后通知ChannelFuture 。给定的ChannelFuture将被通知并且返回。
    
    Specified by:
    
    joinGroup在界面 DatagramChannel
  - joinGroup
```
public ChannelFuture joinGroup(java.net.InetSocketAddress multicastAddress,
                               java.net.NetworkInterface networkInterface)
```
    从接口DatagramChannel复制的描述
    
    在指定的接口加入指定的组播组，并在操作完成后通知ChannelFuture 。
    
    Specified by:
    
    joinGroup在界面 DatagramChannel
  - joinGroup
```
public ChannelFuture joinGroup(java.net.InetSocketAddress multicastAddress,
                               java.net.NetworkInterface networkInterface,
                               ChannelPromise promise)
```
    从接口DatagramChannel复制的描述
    
    在指定的接口加入指定的组播组，并在操作完成后通知ChannelFuture 。给定的ChannelFuture将被通知并且返回。
    
    Specified by:
    
    joinGroup在界面 DatagramChannel
  - joinGroup
```
public ChannelFuture joinGroup(java.net.InetAddress multicastAddress,
                               java.net.NetworkInterface networkInterface,
                               java.net.InetAddress source)
```
    从界面复制的描述： DatagramChannel
    
    在指定的接口加入指定的组播组，并在操作完成后通知ChannelFuture 。
    
    Specified by:
    
    joinGroup在界面 DatagramChannel
  - joinGroup
```
public ChannelFuture joinGroup(java.net.InetAddress multicastAddress,
                               java.net.NetworkInterface networkInterface,
                               java.net.InetAddress source,
                               ChannelPromise promise)
```
    从接口DatagramChannel复制的描述
    
    在指定的接口加入指定的组播组，并在操作完成后通知ChannelFuture 。给定的ChannelFuture将被通知并返回。
    
    Specified by:
    
    joinGroup在界面 DatagramChannel
  - leaveGroup
```
public ChannelFuture leaveGroup(java.net.InetAddress multicastAddress)
```
    从接口复制的描述： DatagramChannel
    
    一旦操作完成，就离开多播组并通知ChannelFuture 。
    
    Specified by:
    
    leaveGroup在界面 DatagramChannel
  - leaveGroup
```
public ChannelFuture leaveGroup(java.net.InetAddress multicastAddress,
                                ChannelPromise promise)
```
    从接口复制的描述： DatagramChannel
    
    一旦操作完成，即离开多点传送组并通知ChannelFuture 。给定的ChannelFuture将被通知并返回。
    
    Specified by:
    
    leaveGroup在界面 DatagramChannel
  - leaveGroup
```
public ChannelFuture leaveGroup(java.net.InetSocketAddress multicastAddress,
                                java.net.NetworkInterface networkInterface)
```
    从接口DatagramChannel复制的描述
    
    在指定的本地接口上留下多播组，并在操作完成后通知ChannelFuture 。
    
    Specified by:
    
    leaveGroup在界面 DatagramChannel
  - leaveGroup
```
public ChannelFuture leaveGroup(java.net.InetSocketAddress multicastAddress,
                                java.net.NetworkInterface networkInterface,
                                ChannelPromise promise)
```
    从接口DatagramChannel复制的描述
    
    在指定的本地接口上留下多播组，并在操作完成后通知ChannelFuture 。给定的ChannelFuture将被通知并且返回。
    
    Specified by:
    
    leaveGroup在界面 DatagramChannel
  - leaveGroup
```
public ChannelFuture leaveGroup(java.net.InetAddress multicastAddress,
                                java.net.NetworkInterface networkInterface,
                                java.net.InetAddress source)
```
    从接口DatagramChannel复制的描述
    
    在指定的接口上使用指定的源保留指定的多播组，并在操作完成后通知ChannelFuture 。
    
    Specified by:
    
    leaveGroup在界面 DatagramChannel
  - leaveGroup
```
public ChannelFuture leaveGroup(java.net.InetAddress multicastAddress,
                                java.net.NetworkInterface networkInterface,
                                java.net.InetAddress source,
                                ChannelPromise promise)
```
    从界面复制的描述： DatagramChannel
    
    在指定的接口上使用指定的源保留指定的多播组，并在操作完成后通知ChannelFuture 。给定的ChannelFuture将被通知并且返回。
    
    Specified by:
    
    leaveGroup在界面 DatagramChannel
  - block
```
public ChannelFuture block(java.net.InetAddress multicastAddress,
                           java.net.NetworkInterface networkInterface,
                           java.net.InetAddress sourceToBlock)
```
    阻止给定networkInterface上给定多播地址的给定sourceToBlock地址
    
    Specified by:
    
    block在界面 DatagramChannel
  - block
```
public ChannelFuture block(java.net.InetAddress multicastAddress,
                           java.net.NetworkInterface networkInterface,
                           java.net.InetAddress sourceToBlock,
                           ChannelPromise promise)
```
    阻止给定networkInterface上给定多播地址的给定sourceToBlock地址
    
    Specified by:
    
    block在界面 DatagramChannel
  - block
```
public ChannelFuture block(java.net.InetAddress multicastAddress,
                           java.net.InetAddress sourceToBlock)
```
    阻止给定多播地址的给定sourceToBlock地址
    
    Specified by:
    
    block在界面 DatagramChannel
  - block
```
public ChannelFuture block(java.net.InetAddress multicastAddress,
                           java.net.InetAddress sourceToBlock,
                           ChannelPromise promise)
```
    阻止给定多播地址的给定sourceToBlock地址
    
    Specified by:
    
    block在界面 DatagramChannel
  - setReadPending
```
@Deprecated
protected void setReadPending(boolean readPending)
```
    已过时。
    
    重写：
    
    setReadPending在课堂 AbstractNioChannel
  - closeOnReadError
```
protected boolean closeOnReadError(java.lang.Throwable cause)
```
    重写：
    
    closeOnReadError在课堂 AbstractNioMessageChannel

Class NioDatagramChannel

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.channel.nio.AbstractNioChannel

Nested classes/interfaces inherited from class io.netty.channel.AbstractChannel

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

Field Summary

Fields inherited from class io.netty.channel.nio.AbstractNioChannel

构造方法摘要

方法摘要

Methods inherited from class io.netty.channel.nio.AbstractNioMessageChannel

Methods inherited from class io.netty.channel.nio.AbstractNioChannel

Methods inherited from class io.netty.channel.AbstractChannel

Methods inherited from class io.netty.util.DefaultAttributeMap

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.Channel

Methods inherited from interface io.netty.util.AttributeMap

Methods inherited from interface io.netty.channel.ChannelOutboundInvoker

Methods inherited from interface java.lang.Comparable

构造方法详细信息

NioDatagramChannel

NioDatagramChannel

NioDatagramChannel

NioDatagramChannel

NioDatagramChannel

方法详细信息

metadata

config

isActive

isConnected

javaChannel

localAddress0

remoteAddress0

doBind

doConnect

doFinishConnect

doDisconnect

doClose

doReadMessages

doWriteMessage

filterOutboundMessage

continueOnWriteError

localAddress

remoteAddress

joinGroup

joinGroup

joinGroup

joinGroup

joinGroup

joinGroup

leaveGroup

leaveGroup

leaveGroup

leaveGroup

leaveGroup

leaveGroup

block

block

block

block

setReadPending

closeOnReadError