io.netty.handler.codec

Class LineBasedFrameDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelStateHandlerAdapter

io.netty.channel.ChannelInboundByteHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.LineBasedFrameDecoder

All Implemented Interfaces:

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

public class LineBasedFrameDecoder
extends ByteToMessageDecoder

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
protected Object	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf buffer)
protected void	decode(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, io.netty.buffer.MessageBuf<Object> out) Decode the from one ByteBuf to an other.

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

callDecode, channelInactive, channelReadSuspended, decodeLast, inboundBufferUpdated, isSingleDecode, setSingleDecode

Methods inherited from class io.netty.channel.ChannelInboundByteHandlerAdapter

discardInboundReadBytes, inboundBufferUpdated, newInboundBuffer

Methods inherited from class io.netty.channel.ChannelStateHandlerAdapter

channelActive, channelRegistered, channelUnregistered, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

exceptionCaught, handlerAdded, handlerRemoved

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, userEventTriggered

Methods inherited from interface io.netty.channel.ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

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 void decode(io.netty.channel.ChannelHandlerContext ctx,
          io.netty.buffer.ByteBuf in,
          io.netty.buffer.MessageBuf<Object> out)
               throws Exception

Description copied from class: ByteToMessageDecoder

Decode the from one ByteBuf to an other. This method will be called till either the input ByteBuf has nothing to read anymore, till nothing was read from the input ByteBuf or till this method returns null.

Specified by:

decode in class ByteToMessageDecoder

Parameters:

ctx - the ChannelHandlerContext which this ByteToByteDecoder belongs to

in - the ByteBuf from which to read data

out - the MessageBuf to which decoded messages should be added

Throws:

Exception - is thrown if an error accour

decode

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

Throws:

Exception