DelimiterBasedFrameDecoder (Netty API Reference (4.1.22.Final))

java.lang.Object
- io.netty.channel.ChannelHandlerAdapter
- - io.netty.channel.ChannelInboundHandlerAdapter
  - - io.netty.handler.codec.ByteToMessageDecoder
    - - io.netty.handler.codec.DelimiterBasedFrameDecoder

All Implemented Interfaces:

ChannelHandler ， ChannelInboundHandler
```
public class DelimiterBasedFrameDecoder
extends ByteToMessageDecoder
```
通过一个或多个分隔符分割接收到的ByteBuf的解码器。对于以NUL或newline characters等分隔符结尾的帧进行解码特别有用。
预定义的分隔符

为了方便起见， Delimiters定义了常用的分隔符。

指定多个分隔符

DelimiterBasedFrameDecoder允许您指定多个分隔符。如果在缓冲区中找到多个分隔符，它会选择产生最短帧的分隔符。例如，如果您在缓冲区中有以下数据：
```
  +--------------+
 | ABC\nDEF\r\n |
 +--------------+ 
```
一个DelimiterBasedFrameDecoder （ Delimiters.lineDelimiter() ）会选择'\n'作为第一个分隔符并产生两个帧：
```
  +-----+-----+
 | ABC | DEF |
 +-----+-----+ 
```
而不是错误地选择'\r\n'作为第一个分隔符：
```
  +----------+
 | ABC\nDEF |
 +----------+ 
```

Nested Class Summary
- Nested classes/interfaces inherited from class io.netty.handler.codec.ByteToMessageDecoder
  ByteToMessageDecoder.Cumulator
- Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
  ChannelHandler.Sharable

Field Summary
- Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder
  COMPOSITE_CUMULATOR, MERGE_CUMULATOR

构造方法摘要

构造方法
Constructor and Description
`DelimiterBasedFrameDecoder(int maxFrameLength, boolean stripDelimiter, boolean failFast, ByteBuf... delimiters)` 创建一个新的实例。
`DelimiterBasedFrameDecoder(int maxFrameLength, boolean stripDelimiter, boolean failFast, ByteBuf delimiter)` 创建一个新的实例。
`DelimiterBasedFrameDecoder(int maxFrameLength, boolean stripDelimiter, ByteBuf... delimiters)` 创建一个新的实例。
`DelimiterBasedFrameDecoder(int maxFrameLength, boolean stripDelimiter, ByteBuf delimiter)` 创建一个新的实例。
`DelimiterBasedFrameDecoder(int maxFrameLength, ByteBuf... delimiters)` 创建一个新的实例。
`DelimiterBasedFrameDecoder(int maxFrameLength, ByteBuf delimiter)` 创建一个新的实例。

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`protected java.lang.Object`	`decode(ChannelHandlerContext ctx, ByteBuf buffer)` 从`ByteBuf`中创建一个框架并将其返回。
`protected void`	`decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out)` 解码从一个`ByteBuf`到另一个。

Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder
actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered

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

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

- 构造方法详细信息
  - DelimiterBasedFrameDecoder
```
public DelimiterBasedFrameDecoder(int maxFrameLength,
                                  ByteBuf delimiter)
```
    创建一个新的实例。
    
    参数
    
    maxFrameLength - 解码帧的最大长度。如果帧的长度超过此值，则会引发TooLongFrameException 。
    
    delimiter - 分隔符
  - DelimiterBasedFrameDecoder
```
public DelimiterBasedFrameDecoder(int maxFrameLength,
                                  boolean stripDelimiter,
                                  ByteBuf delimiter)
```
    创建一个新的实例。
    
    参数
    
    maxFrameLength - 解码帧的最大长度。如果帧的长度超过此值，则会引发TooLongFrameException 。
    
    stripDelimiter - 解码帧是否应该删除分隔符
    
    delimiter - 分隔符
  - DelimiterBasedFrameDecoder
```
public DelimiterBasedFrameDecoder(int maxFrameLength,
                                  boolean stripDelimiter,
                                  boolean failFast,
                                  ByteBuf delimiter)
```
    创建一个新的实例。
    
    参数
    
    maxFrameLength - 解码帧的最大长度。如果帧的长度超过此值，则会引发TooLongFrameException 。
    
    stripDelimiter - 解码后的帧是否应该删除分隔符
    
    failFast -如果true，一个TooLongFrameException被只要解码器注意到该帧的长度将超过maxFrameLength不管整个帧是否已被读出抛出。如果false，一个TooLongFrameException超过maxFrameLength整个框架已经被读取之后被抛出。
    
    delimiter - 分隔符
  - DelimiterBasedFrameDecoder
```
public DelimiterBasedFrameDecoder(int maxFrameLength,
                                  ByteBuf... delimiters)
```
    创建一个新的实例。
    
    参数
    
    maxFrameLength - 解码帧的最大长度。如果帧的长度超过此值，则会引发TooLongFrameException 。
    
    delimiters - 分隔符
  - DelimiterBasedFrameDecoder
```
public DelimiterBasedFrameDecoder(int maxFrameLength,
                                  boolean stripDelimiter,
                                  ByteBuf... delimiters)
```
    创建一个新的实例。
    
    参数
    
    maxFrameLength - 解码帧的最大长度。如果帧的长度超过此值，则会引发TooLongFrameException 。
    
    stripDelimiter - 解码后的帧是否应该删除分隔符
    
    delimiters - 分隔符
  - DelimiterBasedFrameDecoder
```
public DelimiterBasedFrameDecoder(int maxFrameLength,
                                  boolean stripDelimiter,
                                  boolean failFast,
                                  ByteBuf... delimiters)
```
    创建一个新的实例。
    
    参数
    
    maxFrameLength - 解码帧的最大长度。如果帧的长度超过此值，则会引发TooLongFrameException 。
    
    stripDelimiter - 解码的帧是否应该删除分隔符
    
    failFast -如果true，一个TooLongFrameException被只要解码器注意到该帧的长度将超过maxFrameLength不管整个帧是否已被读出抛出。如果false，一个TooLongFrameException超过maxFrameLength整个框架已经被读取之后被抛出。
    
    delimiters - 分隔符
- 方法详细信息
  - decode
```
protected final void decode(ChannelHandlerContext ctx,
                            ByteBuf in,
                            java.util.List<java.lang.Object> out)
                     throws java.lang.Exception
```
    从类复制的描述： ByteToMessageDecoder
    
    解码从一个ByteBuf到另一个。此方法将被调用，直到输入ByteBuf在从此方法返回时没有任何可读的内容或直到从输入ByteBuf没有读取任何内容。
    
    Specified by:
    
    decode在课堂 ByteToMessageDecoder
    
    参数
    
    ctx - 这ByteToMessageDecoder属于的ChannelHandlerContext
    
    in - 从中读取数据的ByteBuf
    
    out - 应该添加解码消息的 List
    
    异常
    
    java.lang.Exception - 如果发生错误则抛出
  - decode
```
protected java.lang.Object decode(ChannelHandlerContext ctx,
                                  ByteBuf buffer)
                           throws java.lang.Exception
```
    从ByteBuf中创建一个框架并将其返回。
    
    参数
    
    ctx - 这ByteToMessageDecoder所属的ChannelHandlerContext
    
    buffer - 从中读取数据的ByteBuf
    
    结果
    
    如果没有帧可被创建，则构成表示帧的ByteBuf或null 。
    
    异常
    
    java.lang.Exception

Class DelimiterBasedFrameDecoder

预定义的分隔符

指定多个分隔符

Nested Class Summary

Nested classes/interfaces inherited from class io.netty.handler.codec.ByteToMessageDecoder

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

Field Summary

Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder

构造方法摘要

方法摘要

Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder

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

构造方法详细信息

DelimiterBasedFrameDecoder

DelimiterBasedFrameDecoder

DelimiterBasedFrameDecoder

DelimiterBasedFrameDecoder

DelimiterBasedFrameDecoder

DelimiterBasedFrameDecoder

方法详细信息

decode

decode