DatagramPacketEncoder (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelOutboundHandlerAdapter
  - - io.netty.handler.codec.MessageToMessageEncoder<AddressedEnvelope<M,java.net.InetSocketAddress>>
    - - io.netty.handler.codec.DatagramPacketEncoder<M>

参数类型

M - 要编码的消息类型

All Implemented Interfaces:

ChannelHandler ， ChannelOutboundHandler
```
public class DatagramPacketEncoder<M>
extends MessageToMessageEncoder<AddressedEnvelope<M,java.net.InetSocketAddress>>
```
使用指定的消息编码器将内容编码为AddressedEnvelope至DatagramPacket的编码器。例如，
```
   ChannelPipeline pipeline = ...; pipeline.addLast("udpEncoder", new DatagramPacketEncoder(new ProtobufEncoder(...));  
```
注意：由于UDP数据包乱序，因此应确保编码的消息大小不超过特定网络路径中的最大安全数据包大小，以确保不会发生数据包碎片。

Nested Class Summary
- Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
  ChannelHandler.Sharable

构造方法摘要

构造方法
Constructor and Description
`DatagramPacketEncoder(MessageToMessageEncoder<? super M> encoder)` 创建一个编码器，使用指定的消息编码器将内容编码为`AddressedEnvelope`至`DatagramPacket` 。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`boolean`	`acceptOutboundMessage(java.lang.Object msg)` 如果应该处理给定的消息，则返回 `true` 。
`void`	`bind(ChannelHandlerContext ctx, java.net.SocketAddress localAddress, ChannelPromise promise)` 致电`ChannelOutboundInvoker.bind(SocketAddress, ChannelPromise)`转发至`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。
`void`	`close(ChannelHandlerContext ctx, ChannelPromise promise)` 致电`ChannelOutboundInvoker.close(ChannelPromise)`转发给`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。
`void`	`connect(ChannelHandlerContext ctx, java.net.SocketAddress remoteAddress, java.net.SocketAddress localAddress, ChannelPromise promise)` 致电`ChannelOutboundInvoker.connect(SocketAddress, SocketAddress, ChannelPromise)`转发到`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。
`void`	`deregister(ChannelHandlerContext ctx, ChannelPromise promise)` 致电`ChannelOutboundInvoker.deregister(ChannelPromise)`转发到`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。
`void`	`disconnect(ChannelHandlerContext ctx, ChannelPromise promise)` 致电`ChannelOutboundInvoker.disconnect(ChannelPromise)`转发到`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。
`protected void`	`encode(ChannelHandlerContext ctx, AddressedEnvelope<M,java.net.InetSocketAddress> msg, java.util.List<java.lang.Object> out)` 从一条消息编码到另一条消息。
`void`	`exceptionCaught(ChannelHandlerContext ctx, java.lang.Throwable cause)` 请致电`ChannelHandlerContext.fireExceptionCaught(Throwable)`转发至`ChannelPipeline`中的下一个`ChannelHandler` 。
`void`	`flush(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.flush()`转发至`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。
`void`	`handlerAdded(ChannelHandlerContext ctx)` 子类可以忽略这个方法。
`void`	`handlerRemoved(ChannelHandlerContext ctx)` 子类可以忽略这个方法。
`boolean`	`isSharable()` 如果实现是`Sharable` ，则返回`true` ，因此可以将其添加到不同的`ChannelPipeline` 。
`void`	`read(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.read()`转发到`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。

Methods inherited from class io.netty.handler.codec.MessageToMessageEncoder
write

Methods inherited from class io.netty.channel.ChannelHandlerAdapter
ensureNotSharable

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

- 构造方法详细信息
  - DatagramPacketEncoder
```
public DatagramPacketEncoder(MessageToMessageEncoder<? super M> encoder)
```
    创建一个编码器，使用指定的消息编码器将内容编码为AddressedEnvelope至DatagramPacket 。
    
    参数
    
    encoder - 指定的消息编码器
- 方法详细信息
  - acceptOutboundMessage
```
public boolean acceptOutboundMessage(java.lang.Object msg)
                              throws java.lang.Exception
```
    从类复制的描述： MessageToMessageEncoder
    
    如果应该处理给定的消息，则返回true 。如果false将被传递给ChannelPipeline中的下一个ChannelOutboundHandler 。
    
    重写：
    
    acceptOutboundMessage在课程 MessageToMessageEncoder<AddressedEnvelope<M,java.net.InetSocketAddress>>
    
    异常
    
    java.lang.Exception
  - encode
```
protected void encode(ChannelHandlerContext ctx,
                      AddressedEnvelope<M,java.net.InetSocketAddress> msg,
                      java.util.List<java.lang.Object> out)
               throws java.lang.Exception
```
    从类复制的描述： MessageToMessageEncoder
    
    从一条消息编码到另一条消息。这个方法将被编码器处理的每个书面信息调用。
    
    Specified by:
    
    encode在课堂上 MessageToMessageEncoder<AddressedEnvelope<M,java.net.InetSocketAddress>>
    
    参数
    
    ctx - 此MessageToMessageEncoder所属的ChannelHandlerContext
    
    msg - 要编码到另一个的消息
    
    out - 应该添加编码味精的 List需要做某种聚合
    
    异常
    
    java.lang.Exception - 如果发生错误则抛出
  - bind
```
public void bind(ChannelHandlerContext ctx,
                 java.net.SocketAddress localAddress,
                 ChannelPromise promise)
          throws java.lang.Exception
```
    从类复制的描述： ChannelOutboundHandlerAdapter
    
    致电ChannelOutboundInvoker.bind(SocketAddress, ChannelPromise)转发到8251902014914的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    bind在界面 ChannelOutboundHandler
    
    重写：
    
    bind在课堂上 ChannelOutboundHandlerAdapter
    
    参数
    
    ctx - 为其进行绑定操作的ChannelHandlerContext
    
    localAddress - 它应该绑定的 SocketAddress
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - connect
```
public void connect(ChannelHandlerContext ctx,
                    java.net.SocketAddress remoteAddress,
                    java.net.SocketAddress localAddress,
                    ChannelPromise promise)
             throws java.lang.Exception
```
    从类复制的描述： ChannelOutboundHandlerAdapter
    
    致电ChannelOutboundInvoker.connect(SocketAddress, SocketAddress, ChannelPromise)转发至ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    connect在界面 ChannelOutboundHandler
    
    重写：
    
    connect在课程 ChannelOutboundHandlerAdapter
    
    参数
    
    ctx - 进行连接操作的ChannelHandlerContext
    
    remoteAddress - 它应该连接到的 SocketAddress
    
    localAddress - 用作连接源的 SocketAddress
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - disconnect
```
public void disconnect(ChannelHandlerContext ctx,
                       ChannelPromise promise)
                throws java.lang.Exception
```
    从类复制的描述： ChannelOutboundHandlerAdapter
    
    致电ChannelOutboundInvoker.disconnect(ChannelPromise)转发给ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    disconnect在界面 ChannelOutboundHandler
    
    重写：
    
    disconnect在课堂 ChannelOutboundHandlerAdapter
    
    参数
    
    ctx - 为其进行断开操作的ChannelHandlerContext
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - close
```
public void close(ChannelHandlerContext ctx,
                  ChannelPromise promise)
           throws java.lang.Exception
```
    从类复制的描述： ChannelOutboundHandlerAdapter
    
    致电ChannelOutboundInvoker.close(ChannelPromise)转发到ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    close在界面 ChannelOutboundHandler
    
    重写：
    
    close在课堂 ChannelOutboundHandlerAdapter
    
    参数
    
    ctx - 关闭操作的ChannelHandlerContext
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - deregister
```
public void deregister(ChannelHandlerContext ctx,
                       ChannelPromise promise)
                throws java.lang.Exception
```
    从类复制的描述： ChannelOutboundHandlerAdapter
    
    致电ChannelOutboundInvoker.deregister(ChannelPromise)转发至ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    deregister在界面 ChannelOutboundHandler
    
    重写：
    
    deregister在课堂 ChannelOutboundHandlerAdapter
    
    参数
    
    ctx - 关闭操作的ChannelHandlerContext
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - read
```
public void read(ChannelHandlerContext ctx)
          throws java.lang.Exception
```
    从类复制的描述： ChannelOutboundHandlerAdapter
    
    致电ChannelHandlerContext.read()转发至ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    read在界面 ChannelOutboundHandler
    
    重写：
    
    read在课堂 ChannelOutboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - flush
```
public void flush(ChannelHandlerContext ctx)
           throws java.lang.Exception
```
    从类复制的描述： ChannelOutboundHandlerAdapter
    
    致电ChannelHandlerContext.flush()转发到ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    flush在界面 ChannelOutboundHandler
    
    重写：
    
    flush在课堂 ChannelOutboundHandlerAdapter
    
    参数
    
    ctx - 进行冲洗操作的ChannelHandlerContext
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - handlerAdded
```
public void handlerAdded(ChannelHandlerContext ctx)
                  throws java.lang.Exception
```
    从类复制的描述： ChannelHandlerAdapter
    
    子类可以忽略这个方法。
    
    Specified by:
    
    handlerAdded ，界面 ChannelHandler
    
    重写：
    
    handlerAdded在课堂上 ChannelHandlerAdapter
    
    异常
    
    java.lang.Exception
  - handlerRemoved
```
public void handlerRemoved(ChannelHandlerContext ctx)
                    throws java.lang.Exception
```
    从类复制的描述： ChannelHandlerAdapter
    
    子类可以忽略这个方法。
    
    Specified by:
    
    handlerRemoved在界面 ChannelHandler
    
    重写：
    
    handlerRemoved在课堂上 ChannelHandlerAdapter
    
    异常
    
    java.lang.Exception
  - exceptionCaught
```
public void exceptionCaught(ChannelHandlerContext ctx,
                            java.lang.Throwable cause)
                     throws java.lang.Exception
```
    从类复制的描述： ChannelHandlerAdapter
    
    致电ChannelHandlerContext.fireExceptionCaught(Throwable)转发至ChannelPipeline中的下一个ChannelHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    exceptionCaught ，界面 ChannelHandler
    
    重写：
    
    exceptionCaught ，课时 ChannelHandlerAdapter
    
    异常
    
    java.lang.Exception
  - isSharable
```
public boolean isSharable()
```
    从类复制的描述： ChannelHandlerAdapter
    
    如果执行结果为Sharable ，则返回true ，因此可以将其添加到不同的ChannelPipeline 。
    
    重写：
    
    isSharable in class ChannelHandlerAdapter

Class DatagramPacketEncoder<M>

Nested Class Summary

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

构造方法摘要

方法摘要

Methods inherited from class io.netty.handler.codec.MessageToMessageEncoder

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

构造方法详细信息

DatagramPacketEncoder

方法详细信息

acceptOutboundMessage

encode

bind

connect

disconnect

close

deregister

read

flush

handlerAdded

handlerRemoved

exceptionCaught

isSharable