MessageToMessageCodec (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelInboundHandlerAdapter
  - - io.netty.channel.ChannelDuplexHandler
    - - io.netty.handler.codec.MessageToMessageCodec<INBOUND_IN,OUTBOUND_IN>

All Implemented Interfaces:

ChannelHandler ， ChannelInboundHandler ， ChannelOutboundHandler

已知直接子类：

Http2StreamFrameToHttpObjectCodec ， HttpContentEncoder ， SpdyHttpResponseStreamIdHandler
```
public abstract class MessageToMessageCodec<INBOUND_IN,OUTBOUND_IN>
extends ChannelDuplexHandler
```
用于即时编码/解码消息的编解码器。这可以被认为是MessageToMessageDecoder和MessageToMessageEncoder的组合。这里是一个MessageToMessageCodec的例子，它只是从Integer解码到Long并从Long编码为Integer 。
```
  public class NumberCodec extends
             MessageToMessageCodec<Integer, Long> {
          @Override
         public Long decode(ChannelHandlerContext ctx, Integer msg, List<Object> out)
                 throws 异常 {
             out.add(msg.longValue());
         }

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

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

构造方法摘要

构造方法
Modifier	Constructor and Description
`protected`	`MessageToMessageCodec()` 创建一个新实例，该实例将尝试检测要解码的类型并将其编码为该类的类型参数。
`protected`	`MessageToMessageCodec(java.lang.Class<? extends INBOUND_IN> inboundMessageType, java.lang.Class<? extends OUTBOUND_IN> outboundMessageType)` 创建一个新的实例。

方法摘要

所有方法接口方法抽象方法具体的方法
Modifier and Type	Method and Description
`boolean`	`acceptInboundMessage(java.lang.Object msg)` 当且仅当指定的消息可以被此编解码器解码时返回 `true` 。
`boolean`	`acceptOutboundMessage(java.lang.Object msg)` 当且仅当指定的消息可以由此编解码器编码时返回 `true` 。
`void`	`channelRead(ChannelHandlerContext ctx, java.lang.Object msg)` 致电`ChannelHandlerContext.fireChannelRead(Object)`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`protected abstract void`	`decode(ChannelHandlerContext ctx, INBOUND_IN msg, java.util.List<java.lang.Object> out)`
`protected abstract void`	`encode(ChannelHandlerContext ctx, OUTBOUND_IN 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.ChannelDuplexHandler
bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter
channelActive, channelInactive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter
ensureNotSharable, 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

- 构造方法详细信息
  - MessageToMessageCodec
```
protected MessageToMessageCodec()
```
    创建一个新实例，该实例将尝试检测要解码的类型并将其编码为该类的类型参数。
  - MessageToMessageCodec
```
protected MessageToMessageCodec(java.lang.Class<? extends INBOUND_IN> inboundMessageType,
                                java.lang.Class<? extends OUTBOUND_IN> outboundMessageType)
```
    创建一个新的实例。
    
    参数
    
    inboundMessageType - 要解码的消息类型
    
    outboundMessageType - 要编码的消息类型
- 方法详细信息
  - channelRead
```
public void channelRead(ChannelHandlerContext ctx,
                        java.lang.Object msg)
                 throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelRead(Object)转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelRead ，界面 ChannelInboundHandler
    
    重写：
    
    channelRead在课堂上 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - write
```
public void write(ChannelHandlerContext ctx,
                  java.lang.Object msg,
                  ChannelPromise promise)
           throws java.lang.Exception
```
    从类复制的描述： ChannelDuplexHandler
    
    致电ChannelOutboundInvoker.write(Object, ChannelPromise)转发到ChannelOutboundHandler中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    write在界面 ChannelOutboundHandler
    
    重写：
    
    write在课堂上 ChannelDuplexHandler
    
    参数
    
    ctx - 为其写入操作的ChannelHandlerContext
    
    msg - 写信息
    
    promise - 操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - acceptInboundMessage
```
public boolean acceptInboundMessage(java.lang.Object msg)
                             throws java.lang.Exception
```
    当且仅当指定的消息可以被该编解码器解码时返回 true 。
    
    参数
    
    msg - 消息
    
    异常
    
    java.lang.Exception
  - acceptOutboundMessage
```
public boolean acceptOutboundMessage(java.lang.Object msg)
                              throws java.lang.Exception
```
    当且仅当指定的消息可以由此编解码器编码时返回 true 。
    
    参数
    
    msg - 消息
    
    异常
    
    java.lang.Exception
  - encode
```
protected abstract void encode(ChannelHandlerContext ctx,
                               OUTBOUND_IN msg,
                               java.util.List<java.lang.Object> out)
                        throws java.lang.Exception
```
    异常
    
    java.lang.Exception
    
    另请参见：
    
    MessageToMessageEncoder.encode(ChannelHandlerContext, Object, List)
  - decode
```
protected abstract void decode(ChannelHandlerContext ctx,
                               INBOUND_IN msg,
                               java.util.List<java.lang.Object> out)
                        throws java.lang.Exception
```
    异常
    
    java.lang.Exception
    
    另请参见：
    
    MessageToMessageDecoder.decode(ChannelHandlerContext, Object, List)

Class MessageToMessageCodec<INBOUND_IN,OUTBOUND_IN>

Nested Class Summary

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

构造方法摘要

方法摘要

Methods inherited from class io.netty.channel.ChannelDuplexHandler

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelHandler

构造方法详细信息

MessageToMessageCodec

MessageToMessageCodec

方法详细信息

channelRead

write

acceptInboundMessage

acceptOutboundMessage

encode

decode