Package io.netty.handler.codec
Class LineBasedFrameDecoder
- 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
- Direct Known Subclasses:
SmtpResponseDecoder
public class LineBasedFrameDecoder extends ByteToMessageDecoder
A decoder that splits the receivedByteBuf
s 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
tochar
cast and then compares thatchar
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.netty.handler.codec.ByteToMessageDecoder
ByteToMessageDecoder.Cumulator
-
Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
ChannelHandler.Sharable
-
-
Field Summary
Fields Modifier and Type Field Description private int
discardedBytes
private boolean
discarding
True if we're discarding input because we're already over maxLength.private boolean
failFast
Whether or not to throw an exception as soon as we exceed maxLength.private int
maxLength
Maximum length of a frame we're willing to decode.private int
offset
Last scan position.private boolean
stripDelimiter
-
Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder
COMPOSITE_CUMULATOR, cumulation, 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 java.lang.Object
decode(ChannelHandlerContext ctx, ByteBuf buffer)
Create a frame out of theByteBuf
and return it.protected void
decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out)
Decode the from oneByteBuf
to an other.private void
fail(ChannelHandlerContext ctx, int length)
private void
fail(ChannelHandlerContext ctx, java.lang.String length)
private int
findEndOfLine(ByteBuf buffer)
Returns the index in the buffer of the end of line found.-
Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder
actualReadableBytes, callDecode, channelInactive, channelInputClosed, channelRead, channelReadComplete, decodeLast, decodeRemovalReentryProtection, discardSomeReadBytes, expandCumulation, fireChannelRead, fireChannelRead, 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
-
-
-
-
Field Detail
-
maxLength
private final int maxLength
Maximum length of a frame we're willing to decode.
-
failFast
private final boolean failFast
Whether or not to throw an exception as soon as we exceed maxLength.
-
stripDelimiter
private final boolean stripDelimiter
-
discarding
private boolean discarding
True if we're discarding input because we're already over maxLength.
-
discardedBytes
private int discardedBytes
-
offset
private int offset
Last scan position.
-
-
Constructor Detail
-
LineBasedFrameDecoder
public LineBasedFrameDecoder(int maxLength)
Creates a new decoder.- Parameters:
maxLength
- the maximum length of the decoded frame. ATooLongFrameException
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. ATooLongFrameException
is thrown if the length of the frame exceeds this value.stripDelimiter
- whether the decoded frame should strip out the delimiter or notfailFast
- If true, aTooLongFrameException
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, aTooLongFrameException
is thrown after the entire frame that exceeds maxFrameLength has been read.
-
-
Method Detail
-
decode
protected final void decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out) throws java.lang.Exception
Description copied from class:ByteToMessageDecoder
Decode the from oneByteBuf
to an other. This method will be called till either the inputByteBuf
has nothing to read when return from this method or till nothing was read from the inputByteBuf
.- Specified by:
decode
in classByteToMessageDecoder
- Parameters:
ctx
- theChannelHandlerContext
which thisByteToMessageDecoder
belongs toin
- theByteBuf
from which to read dataout
- theList
to which decoded messages should be added- Throws:
java.lang.Exception
- is thrown if an error occurs
-
decode
protected java.lang.Object decode(ChannelHandlerContext ctx, ByteBuf buffer) throws java.lang.Exception
Create a frame out of theByteBuf
and return it.- Parameters:
ctx
- theChannelHandlerContext
which thisByteToMessageDecoder
belongs tobuffer
- theByteBuf
from which to read data- Returns:
- frame the
ByteBuf
which represent the frame ornull
if no frame could be created. - Throws:
java.lang.Exception
-
fail
private void fail(ChannelHandlerContext ctx, int length)
-
fail
private void fail(ChannelHandlerContext ctx, java.lang.String length)
-
findEndOfLine
private int findEndOfLine(ByteBuf buffer)
Returns the index in the buffer of the end of line found. Returns -1 if no end of line was found in the buffer.
-
-