io.netty.handler.codec

Class LineBasedFrameDecoder

java.lang.Object

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder<io.netty.buffer.ByteBuf>

io.netty.handler.codec.LineBasedFrameDecoder

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundByteHandler, io.netty.channel.ChannelInboundHandler, io.netty.channel.ChannelStateHandler

public class LineBasedFrameDecoder
extends ByteToMessageDecoder<io.netty.buffer.ByteBuf>

A decoder that splits the received ByteBufs on line endings.

Both "\n" and "\r\n" are handled. For a more general delimiter-based decoder, see DelimiterBasedFrameDecoder.

Nested Class Summary

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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
io.netty.buffer.ByteBuf	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf buffer)

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

beforeAdd, callDecode, channelInactive, decodeLast, freeInboundBuffer, inboundBufferUpdated, newInboundBuffer, replace

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

afterAdd, afterRemove, beforeRemove, channelActive, channelRegistered, channelUnregistered, exceptionCaught, userEventTriggered

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

channelActive, channelRegistered, channelUnregistered

Methods inherited from interface io.netty.channel.ChannelHandler

afterAdd, afterRemove, beforeRemove, exceptionCaught, userEventTriggered

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

public io.netty.buffer.ByteBuf decode(io.netty.channel.ChannelHandlerContext ctx,
                             io.netty.buffer.ByteBuf buffer)
                               throws Exception

Specified by:

decode in class ByteToMessageDecoder<io.netty.buffer.ByteBuf>

Throws:

Exception