MessageToMessageEncoder (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelOutboundHandlerAdapter
  - - io.netty.handler.codec.MessageToMessageEncoder<I>

All Implemented Interfaces:

ChannelHandler ， ChannelOutboundHandler

已知直接子类：

AbstractMemcacheObjectEncoder ， Base64Encoder ， ByteArrayEncoder ， DatagramDnsQueryEncoder ， DatagramDnsResponseEncoder ， DatagramPacketEncoder ， HttpObjectEncoder ， LengthFieldPrepender ， LineEncoder ， MqttEncoder ， ProtobufEncoder ， ProtobufEncoderNano ， RedisEncoder ， SctpOutboundByteStreamHandler ， SmtpRequestEncoder ， SpdyHttpEncoder ， StompSubframeEncoder ， StringEncoder ， WebSocket00FrameEncoder ， WebSocket08FrameEncoder ， WebSocketExtensionEncoder
```
public abstract class MessageToMessageEncoder<I>
extends ChannelOutboundHandlerAdapter
```
ChannelOutboundHandlerAdapter从一个消息编码到另一个消息例如，这里是一个将Integer解码为Integer的String 。
```
  public class IntegerToStringEncoder extends
             MessageToMessageEncoder<Integer> {

          @Override
         public void encode(ChannelHandlerContext ctx, Integer message, List<Object> out)
                 throws 异常 {
             out.add(message.toString());
         }
     } 
```
请注意，如果消息是ReferenceCounted类型的消息，则需要致电ReferenceCounted.retain() 。这是需要的，因为MessageToMessageEncoder将在编码消息上调用ReferenceCounted.release() 。

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

构造方法摘要

构造方法
Modifier	Constructor and Description
`protected`	`MessageToMessageEncoder()` 创建一个新实例，它将尝试检测类型以匹配该类的类型参数。
`protected`	`MessageToMessageEncoder(java.lang.Class<? extends I> outboundMessageType)` 创建一个新的实例

方法摘要

所有方法接口方法抽象方法具体的方法
Modifier and Type	Method and Description
`boolean`	`acceptOutboundMessage(java.lang.Object msg)` 如果应该处理给定的消息，则返回 `true` 。
`protected abstract void`	`encode(ChannelHandlerContext ctx, I msg, java.util.List<java.lang.Object> out)` 从一条消息编码到另一条消息。
`void`	`write(ChannelHandlerContext ctx, java.lang.Object msg, ChannelPromise promise)` 致电`ChannelOutboundInvoker.write(Object, ChannelPromise)`转发到`ChannelPipeline`中的下一个`ChannelOutboundHandler` 。

Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter
bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable

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

Methods inherited from interface io.netty.channel.ChannelHandler
exceptionCaught, handlerAdded, handlerRemoved

- 构造方法详细信息
  - MessageToMessageEncoder
```
protected MessageToMessageEncoder()
```
    创建一个新实例，它将尝试检测类型以匹配该类的类型参数。
  - MessageToMessageEncoder
```
protected MessageToMessageEncoder(java.lang.Class<? extends I> outboundMessageType)
```
    创建一个新的实例
    
    参数
    
    outboundMessageType - 要匹配和编码的消息类型
- 方法详细信息
  - acceptOutboundMessage
```
public boolean acceptOutboundMessage(java.lang.Object msg)
                              throws java.lang.Exception
```
    如果应该处理给定的消息，则返回true 。如果false它将被传递到ChannelPipeline中的下一个ChannelOutboundHandler 。
    
    异常
    
    java.lang.Exception
  - write
```
public void write(ChannelHandlerContext ctx,
                  java.lang.Object msg,
                  ChannelPromise promise)
           throws java.lang.Exception
```
    从类复制的描述： ChannelOutboundHandlerAdapter
    
    致电ChannelOutboundInvoker.write(Object, ChannelPromise)转发到下一个ChannelOutboundHandler的ChannelPipeline 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    write在界面 ChannelOutboundHandler
    
    重写：
    
    write在课堂上 ChannelOutboundHandlerAdapter
    
    参数
    
    ctx - 进行写入操作的ChannelHandlerContext
    
    msg - 要写的消息
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - encode
```
protected abstract void encode(ChannelHandlerContext ctx,
                               I msg,
                               java.util.List<java.lang.Object> out)
                        throws java.lang.Exception
```
    从一条消息编码到另一条消息。这个方法将被编码器处理的每个书面信息调用。
    
    参数
    
    ctx - 这MessageToMessageEncoder所属的ChannelHandlerContext
    
    msg - 要编码到另一个的消息
    
    out - 应该添加编码味精的 List需要做某种聚合
    
    异常
    
    java.lang.Exception - 如果发生错误则抛出

Class MessageToMessageEncoder<I>

Nested Class Summary

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

构造方法摘要

方法摘要

Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelHandler

构造方法详细信息

MessageToMessageEncoder

MessageToMessageEncoder

方法详细信息

acceptOutboundMessage

write

encode