java.lang.Object
- io.netty5.channel.ChannelHandlerAdapter
- - io.netty5.handler.codec.ByteToMessageDecoder
  - - io.netty5.handler.codec.LineBasedFrameDecoder

All Implemented Interfaces:

ChannelHandler
```
public class LineBasedFrameDecoder
extends ByteToMessageDecoder
```
A decoder that splits the received Buffers on line endings.
Both "\n" and "\r\n" are handled.
The byte stream is expected to be in UTF-8 character encoding or ASCII. The current implementation uses direct byte to char cast and then compares that char to a few low range ASCII characters like '\n' or '\r'. UTF-8 is not using low range [0..0x7F] byte values for multibyte codepoint representations therefore fully supported by this implementation.
For a more general delimiter-based decoder, see DelimiterBasedFrameDecoder.

Nested Class Summary
- Nested classes/interfaces inherited from class io.netty5.handler.codec.ByteToMessageDecoder
  ByteToMessageDecoder.Cumulator

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

Constructor Summary

Constructors
Constructor	Description
`LineBasedFrameDecoder(int maxLength)`	Creates a new decoder.
`LineBasedFrameDecoder(int maxLength, boolean stripDelimiter, boolean failFast)`	Creates a new decoder.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`decode(ChannelHandlerContext ctx, Buffer in)`	Decode the from one `Buffer` to another.
`protected Object`	`decode0(ChannelHandlerContext ctx, Buffer buffer)`	Create a frame out of the `Buffer` and return it.

Methods inherited from class io.netty5.handler.codec.ByteToMessageDecoder
actualReadableBytes, channelInactive, channelRead, channelReadComplete, channelShutdown, decodeLast, discardSomeReadBytes, handlerAdded, handlerAdded0, handlerRemoved, handlerRemoved0, internalBuffer, isSharable, isSingleDecode, setSingleDecode

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.netty5.channel.ChannelHandler
bind, channelActive, channelExceptionCaught, channelInboundEvent, channelRegistered, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, flush, pendingOutboundBytes, read, register, sendOutboundEvent, shutdown, write

- Constructor Detail
  - LineBasedFrameDecoder
```
public LineBasedFrameDecoder(int maxLength)
```
    Creates a new decoder.
    
    Parameters:
    
    maxLength - the maximum length of the decoded frame. A TooLongFrameException is thrown if the length of the frame exceeds this value.
  - LineBasedFrameDecoder
```
public LineBasedFrameDecoder(int maxLength,
                             boolean stripDelimiter,
                             boolean failFast)
```
    Creates a new decoder.
    
    Parameters:
    
    maxLength - the maximum length of the decoded frame. A TooLongFrameException is thrown if the length of the frame exceeds this value.
    
    stripDelimiter - whether the decoded frame should strip out the delimiter or not
    
    failFast - If true, a TooLongFrameException is thrown as soon as the decoder notices the length of the frame will exceed maxFrameLength regardless of whether the entire frame has been read. If false, a TooLongFrameException is thrown after the entire frame that exceeds maxFrameLength has been read.
- Method Detail
  - decode
```
protected final void decode(ChannelHandlerContext ctx,
                            Buffer in)
                     throws Exception
```
    Description copied from class: ByteToMessageDecoder
    
    Decode the from one Buffer to another. This method will be called till either the input Buffer has nothing to read when return from this method or till nothing was read from the input Buffer.
    
    Specified by:
    
    decode in class ByteToMessageDecoder
    
    Parameters:
    
    ctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs to
    
    in - the Buffer from which to read data
    
    Throws:
    
    Exception - is thrown if an error occurs
  - decode0
```
protected Object decode0(ChannelHandlerContext ctx,
                         Buffer buffer)
```
    Create a frame out of the Buffer and return it.
    
    Parameters:
    
    ctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs to
    
    buffer - the Buffer from which to read data
    
    Returns:
    
    frame the Buffer which represent the frame or null if no frame could be created.

Class LineBasedFrameDecoder

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface io.netty5.channel.ChannelHandler

Constructor Detail

LineBasedFrameDecoder

LineBasedFrameDecoder

Method Detail

decode

decode0