LineBasedFrameDecoder (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.LineBasedFrameDecoder

All Implemented Interfaces:

ChannelHandler ， ChannelInboundHandler

已知直接子类：

SmtpResponseDecoder
```
public class LineBasedFrameDecoder
extends ByteToMessageDecoder
```
一个解码器，将接收到的ByteBuf分解为行尾。
处理"\n"和"\r\n" 。对于更通用的基于分隔符的解码器，请参阅DelimiterBasedFrameDecoder 。

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
`LineBasedFrameDecoder(int maxLength)` 创建一个新的解码器。
`LineBasedFrameDecoder(int maxLength, boolean stripDelimiter, boolean failFast)` 创建一个新的解码器。

方法摘要

所有方法接口方法具体的方法
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

- 构造方法详细信息
  - LineBasedFrameDecoder
```
public LineBasedFrameDecoder(int maxLength)
```
    创建一个新的解码器。
    
    参数
    
    maxLength - 解码帧的最大长度。如果帧的长度超过此值，则会引发TooLongFrameException 。
  - LineBasedFrameDecoder
```
public LineBasedFrameDecoder(int maxLength,
                             boolean stripDelimiter,
                             boolean failFast)
```
    创建一个新的解码器。
    
    参数
    
    maxLength - 解码帧的最大长度。如果帧的长度超过此值，则会引发TooLongFrameException 。
    
    stripDelimiter - 解码后的帧是否应该删除分隔符
    
    failFast - 如果true ，解码器注意到TooLongFrameException会被抛出，帧的长度将超过maxFrameLength ，无论整个帧是否已被读取。如果false，一个TooLongFrameException超过maxFrameLength整个框架已经被读取之后被抛出。
- 方法详细信息
  - 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 LineBasedFrameDecoder

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

构造方法详细信息

LineBasedFrameDecoder

LineBasedFrameDecoder

方法详细信息

decode

decode