MessageToByteEncoder (Netty API Reference (4.1.22.Final))

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

All Implemented Interfaces:

ChannelHandler ， ChannelOutboundHandler

已知直接子类：

Bzip2Encoder ， CompatibleMarshallingEncoder ， CompatibleObjectEncoder ， FastLzFrameEncoder ， Lz4FrameEncoder ， LzfEncoder ， LzmaFrameEncoder ， MarshallingEncoder ， ObjectEncoder ， ProtobufVarint32LengthFieldPrepender ， SnappyFrameEncoder ， Socks4ClientEncoder ， Socks4ServerEncoder ， Socks5ClientEncoder ， Socks5ServerEncoder ， SocksMessageEncoder ， ZlibEncoder
```
public abstract class MessageToByteEncoder<I>
extends ChannelOutboundHandlerAdapter
```
ChannelOutboundHandlerAdapter从一条消息到ByteBuf以类似于流的方式编码消息。示例实施方式，其编码Integer s到一个ByteBuf 。
```
  public class IntegerEncoder extends MessageToByteEncoder<Integer> {
          @Override
         public void encode(ChannelHandlerContext ctx, Integer msg, ByteBuf out)
                 throws 异常 {
             out.writeInt(msg);
         }
     } 
```

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

构造方法摘要

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

方法摘要

所有方法接口方法抽象方法具体的方法
Modifier and Type	Method and Description
`boolean`	`acceptOutboundMessage(java.lang.Object msg)` 如果应该处理给定的消息，则返回 `true` 。
`protected ByteBuf`	`allocateBuffer(ChannelHandlerContext ctx, I msg, boolean preferDirect)` 分配`ByteBuf` ，其将被用作参数的`#encode(ChannelHandlerContext, I, ByteBuf)` 。
`protected abstract void`	`encode(ChannelHandlerContext ctx, I msg, ByteBuf out)` 将消息编码成`ByteBuf` 。
`protected boolean`	`isPreferDirect()`
`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

- 构造方法详细信息
  - MessageToByteEncoder
```
protected MessageToByteEncoder()
```
    参见 MessageToByteEncoder(boolean)和 true作为布尔参数。
  - MessageToByteEncoder
```
protected MessageToByteEncoder(java.lang.Class<? extends I> outboundMessageType)
```
    参见 MessageToByteEncoder(Class, boolean)和 true作为布尔值。
  - MessageToByteEncoder
```
protected MessageToByteEncoder(boolean preferDirect)
```
    创建一个新实例，它将尝试检测类型以匹配该类的类型参数。
    
    参数
    
    preferDirect - true如果应该尝试直接使用ByteBuf作为编码消息的目标。如果false用于将分配堆ByteBuf ，其由一个字节数组支持。
  - MessageToByteEncoder
```
protected MessageToByteEncoder(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 。如果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)转发到ChannelPipeline中的下一个ChannelOutboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    write在界面 ChannelOutboundHandler
    
    重写：
    
    write在课堂上 ChannelOutboundHandlerAdapter
    
    参数
    
    ctx - 为其写入操作的ChannelHandlerContext
    
    msg - 写信息
    
    promise - 在操作完成后通知ChannelPromise
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - allocateBuffer
```
protected ByteBuf allocateBuffer(ChannelHandlerContext ctx,
                                 I msg,
                                 boolean preferDirect)
                          throws java.lang.Exception
```
    分配一个ByteBuf ，它将用作#encode(ChannelHandlerContext, I, ByteBuf)参数。子类可以覆盖此方法以返回ByteBuf，并具有完美匹配initialCapacity 。
    
    异常
    
    java.lang.Exception
  - encode
```
protected abstract void encode(ChannelHandlerContext ctx,
                               I msg,
                               ByteBuf out)
                        throws java.lang.Exception
```
    将消息编码为ByteBuf 。这个方法将被编码器处理的每个书面信息调用。
    
    参数
    
    ctx - 这MessageToByteEncoder所属的ChannelHandlerContext
    
    msg - 要编码的消息
    
    out - 将编写消息写入其中的ByteBuf
    
    异常
    
    java.lang.Exception - 发生错误时抛出
  - isPreferDirect
```
protected boolean isPreferDirect()
```

Class MessageToByteEncoder<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

构造方法详细信息

MessageToByteEncoder

MessageToByteEncoder

MessageToByteEncoder

MessageToByteEncoder

方法详细信息

acceptOutboundMessage

write

allocateBuffer

encode

isPreferDirect