LengthFieldPrepender (Netty API Reference (4.1.22.Final))

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

All Implemented Interfaces:

ChannelHandler ， ChannelOutboundHandler
```
@ChannelHandler.Sharable
public class LengthFieldPrepender
extends MessageToMessageEncoder<ByteBuf>
```
预编码消息长度的编码器。长度值预先作为二进制形式。
例如， LengthFieldPrepender(2)将编码以下12个字节的字符串：
```
  +----------------+
 | "HELLO, WORLD" |
 +----------------+ 
```
分成以下几部分：
```
  +--------+----------------+
 + 0x000C | "HELLO, WORLD" |
 +--------+----------------+ 
```
如果您在构造函数中打开了lengthIncludesLengthFieldLength标志，则编码数据将如下所示（12（原始数据）+ 2（前置数据）= 14（0xE））：
```
  +--------+----------------+
 + 0x000E | "HELLO, WORLD" |
 +--------+----------------+ 
```

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

构造方法摘要

构造方法
Constructor and Description
`LengthFieldPrepender(java.nio.ByteOrder byteOrder, int lengthFieldLength, int lengthAdjustment, boolean lengthIncludesLengthFieldLength)` 创建一个新的实例。
`LengthFieldPrepender(int lengthFieldLength)` 创建一个新的实例。
`LengthFieldPrepender(int lengthFieldLength, boolean lengthIncludesLengthFieldLength)` 创建一个新的实例。
`LengthFieldPrepender(int lengthFieldLength, int lengthAdjustment)` 创建一个新的实例。
`LengthFieldPrepender(int lengthFieldLength, int lengthAdjustment, boolean lengthIncludesLengthFieldLength)` 创建一个新的实例。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`protected void`	`encode(ChannelHandlerContext ctx, ByteBuf msg, java.util.List<java.lang.Object> out)` 从一条消息编码到另一条消息。

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

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

- 构造方法详细信息
  - LengthFieldPrepender
```
public LengthFieldPrepender(int lengthFieldLength)
```
    创建一个新的实例。
    
    参数
    
    lengthFieldLength - 前置长度字段的长度。只允许1,2,3,4和8。
    
    异常
    
    java.lang.IllegalArgumentException -如果 lengthFieldLength不为1，2，3，4，或8
  - LengthFieldPrepender
```
public LengthFieldPrepender(int lengthFieldLength,
                            boolean lengthIncludesLengthFieldLength)
```
    创建一个新的实例。
    
    参数
    
    lengthFieldLength - 前置长度字段的长度。只允许1,2,3,4和8。
    
    lengthIncludesLengthFieldLength - 如果是 true ，则将前置长度字段的长度添加到前置长度字段的值中。
    
    异常
    
    java.lang.IllegalArgumentException -如果 lengthFieldLength不为1，2，3，4，或8
  - LengthFieldPrepender
```
public LengthFieldPrepender(int lengthFieldLength,
                            int lengthAdjustment)
```
    创建一个新的实例。
    
    参数
    
    lengthFieldLength - 前置长度字段的长度。只允许1,2,3,4和8。
    
    lengthAdjustment - 要添加到长度字段值的补偿值
    
    异常
    
    java.lang.IllegalArgumentException -如果 lengthFieldLength不为1，2，3，4，或8
  - LengthFieldPrepender
```
public LengthFieldPrepender(int lengthFieldLength,
                            int lengthAdjustment,
                            boolean lengthIncludesLengthFieldLength)
```
    创建一个新的实例。
    
    参数
    
    lengthFieldLength - 前置长度字段的长度。只允许1,2,3,4和8。
    
    lengthAdjustment - 要添加到长度字段值的补偿值
    
    lengthIncludesLengthFieldLength - 如果是 true ，则将前置长度字段的长度添加到前置长度字段的值中。
    
    异常
    
    java.lang.IllegalArgumentException -如果 lengthFieldLength不为1，2，3，4，或8
  - LengthFieldPrepender
```
public LengthFieldPrepender(java.nio.ByteOrder byteOrder,
                            int lengthFieldLength,
                            int lengthAdjustment,
                            boolean lengthIncludesLengthFieldLength)
```
    创建一个新的实例。
    
    参数
    
    byteOrder - 长度字段的 ByteOrder
    
    lengthFieldLength - 前置长度字段的长度。只允许1,2,3,4和8。
    
    lengthAdjustment - 要添加到长度字段值的补偿值
    
    lengthIncludesLengthFieldLength - 如果 true ，前置长度字段的长度被添加到前置长度字段的值。
    
    异常
    
    java.lang.IllegalArgumentException -如果 lengthFieldLength不为1，2，3，4，或8
- 方法详细信息
  - encode
```
protected void encode(ChannelHandlerContext ctx,
                      ByteBuf msg,
                      java.util.List<java.lang.Object> out)
               throws java.lang.Exception
```
    从类复制的描述： MessageToMessageEncoder
    
    从一条消息编码到另一条消息。这个方法将被编码器处理的每个书面信息调用。
    
    Specified by:
    
    encode在课程 MessageToMessageEncoder<ByteBuf>
    
    参数
    
    ctx - MessageToMessageEncoder属于的ChannelHandlerContext
    
    msg - 要编码到另一个的消息
    
    out - 应该添加编码味精的 List需要做某种聚合
    
    异常
    
    java.lang.Exception - is thrown if an error occurs

Class LengthFieldPrepender

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.ChannelOutboundHandlerAdapter

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty.channel.ChannelHandler

构造方法详细信息

LengthFieldPrepender

LengthFieldPrepender

LengthFieldPrepender

LengthFieldPrepender

LengthFieldPrepender

方法详细信息

encode