ByteToMessageCodec (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.ByteToMessageCodec<I>

All Implemented Interfaces:

ChannelHandler ， ChannelInboundHandler ， ChannelOutboundHandler
```
public abstract class ByteToMessageCodec<I>
extends ChannelDuplexHandler
```
一种编解码器，用于将消息中的字节进行即时编码/解码，反之亦然。这可以被认为是ByteToMessageDecoder和MessageToByteEncoder的组合。请注意， ByteToMessageCodec的子类不能用@Sharable注释。

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

构造方法摘要

构造方法
Modifier	Constructor and Description
`protected`	`ByteToMessageCodec()` 参见 `ByteToMessageCodec(boolean)`和 `true`作为布尔参数。
`protected`	`ByteToMessageCodec(boolean preferDirect)` 创建一个新实例，它将尝试检测类型以匹配该类的类型参数。
`protected`	`ByteToMessageCodec(java.lang.Class<? extends I> outboundMessageType)` 参见 `ByteToMessageCodec(Class, boolean)`和 `true`作为布尔值。
`protected`	`ByteToMessageCodec(java.lang.Class<? extends I> outboundMessageType, boolean preferDirect)` 创建一个新的实例

方法摘要

所有方法接口方法抽象方法具体的方法
Modifier and Type	Method and Description
`boolean`	`acceptOutboundMessage(java.lang.Object msg)` 当且仅当指定的消息可以由此编解码器编码时返回 `true` 。
`void`	`channelInactive(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelInactive()`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`void`	`channelRead(ChannelHandlerContext ctx, java.lang.Object msg)` 致电`ChannelHandlerContext.fireChannelRead(Object)`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`void`	`channelReadComplete(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelReadComplete()`转发到`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`protected abstract void`	`decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out)`
`protected void`	`decodeLast(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out)`
`protected abstract void`	`encode(ChannelHandlerContext ctx, I msg, ByteBuf out)`
`void`	`handlerAdded(ChannelHandlerContext ctx)` 子类可以忽略这个方法。
`void`	`handlerRemoved(ChannelHandlerContext ctx)` 子类可以忽略这个方法。
`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, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

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

- 构造方法详细信息
  - ByteToMessageCodec
```
protected ByteToMessageCodec()
```
    参见 ByteToMessageCodec(boolean)和 true作为布尔参数。
  - ByteToMessageCodec
```
protected ByteToMessageCodec(java.lang.Class<? extends I> outboundMessageType)
```
    参见 ByteToMessageCodec(Class, boolean)和 true作为布尔值。
  - ByteToMessageCodec
```
protected ByteToMessageCodec(boolean preferDirect)
```
    创建一个新实例，它将尝试检测类型以匹配该类的类型参数。
    
    参数
    
    preferDirect - true如果应该尝试直接使用ByteBuf作为编码消息的目标。如果false用于将分配堆ByteBuf ，其由一个字节数组支持。
  - ByteToMessageCodec
```
protected ByteToMessageCodec(java.lang.Class<? extends I> outboundMessageType,
                             boolean preferDirect)
```
    创建一个新的实例
    
    参数
    
    outboundMessageType - 要匹配的消息类型
    
    preferDirect - true如果应尝试直接使用ByteBuf作为编码消息的目标。如果false用于将分配堆ByteBuf ，其由一个字节数组支持。
- 方法详细信息
  - acceptOutboundMessage
```
public boolean acceptOutboundMessage(java.lang.Object msg)
                              throws java.lang.Exception
```
    当且仅当指定的消息可以由此编解码器编码时，返回 true 。
    
    参数
    
    msg - 消息
    
    异常
    
    java.lang.Exception
  - 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)转发到ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    write ，界面 ChannelOutboundHandler
    
    重写：
    
    write ，课时 ChannelDuplexHandler
    
    参数
    
    ctx - 为其写入操作的ChannelHandlerContext
    
    msg - 写信息
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - channelReadComplete
```
public void channelReadComplete(ChannelHandlerContext ctx)
                         throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelReadComplete()转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelReadComplete在界面 ChannelInboundHandler
    
    重写：
    
    channelReadComplete ，上课 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - channelInactive
```
public void channelInactive(ChannelHandlerContext ctx)
                     throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelInactive()转发到ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelInactive接口 ChannelInboundHandler
    
    重写：
    
    channelInactive在课程 ChannelInboundHandlerAdapter
    
    异常
    
    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
  - encode
```
protected abstract void encode(ChannelHandlerContext ctx,
                               I msg,
                               ByteBuf out)
                        throws java.lang.Exception
```
    异常
    
    java.lang.Exception
    
    另请参见：
    
    MessageToByteEncoder.encode(ChannelHandlerContext, Object, ByteBuf)
  - decode
```
protected abstract void decode(ChannelHandlerContext ctx,
                               ByteBuf in,
                               java.util.List<java.lang.Object> out)
                        throws java.lang.Exception
```
    异常
    
    java.lang.Exception
    
    另请参见：
    
    ByteToMessageDecoder.decode(ChannelHandlerContext, ByteBuf, List)
  - decodeLast
```
protected void decodeLast(ChannelHandlerContext ctx,
                          ByteBuf in,
                          java.util.List<java.lang.Object> out)
                   throws java.lang.Exception
```
    异常
    
    java.lang.Exception
    
    另请参见：
    
    ByteToMessageDecoder.decodeLast(ChannelHandlerContext, ByteBuf, List)

Class ByteToMessageCodec<I>

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

构造方法详细信息

ByteToMessageCodec

ByteToMessageCodec

ByteToMessageCodec

ByteToMessageCodec

方法详细信息

acceptOutboundMessage

channelRead

write

channelReadComplete

channelInactive

handlerAdded

handlerRemoved

encode

decode

decodeLast