public class LineBasedFrameDecoder extends ByteToMessageDecoder
ByteBuf
s on line endings.
Both "\n"
and "\r\n"
are handled.
For a more general delimiter-based decoder, see DelimiterBasedFrameDecoder
.
ByteToMessageDecoder.Cumulator
ChannelHandler.Sharable
Modifier and Type | Field and 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 boolean |
stripDelimiter |
COMPOSITE_CUMULATOR, cumulation, MERGE_CUMULATOR
Constructor and Description |
---|
LineBasedFrameDecoder(int maxLength)
Creates a new decoder.
|
LineBasedFrameDecoder(int maxLength,
boolean stripDelimiter,
boolean failFast)
Creates a new decoder.
|
Modifier and Type | Method and Description |
---|---|
protected java.lang.Object |
decode(ChannelHandlerContext ctx,
ByteBuf buffer)
Create a frame out of the
ByteBuf and return it. |
protected void |
decode(ChannelHandlerContext ctx,
ByteBuf in,
java.util.List<java.lang.Object> out)
Decode the from one
ByteBuf to an other. |
private void |
fail(ChannelHandlerContext ctx,
int length) |
private void |
fail(ChannelHandlerContext ctx,
java.lang.String length) |
private static int |
findEndOfLine(ByteBuf buffer)
Returns the index in the buffer of the end of line found.
|
actualReadableBytes, callDecode, channelInactive, channelInputClosed, channelRead, channelReadComplete, decodeLast, discardSomeReadBytes, expandCumulation, fireChannelRead, fireChannelRead, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggered
channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught
handlerAdded, isSharable
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
handlerAdded
private final int maxLength
private final boolean failFast
private final boolean stripDelimiter
private boolean discarding
private int discardedBytes
public LineBasedFrameDecoder(int maxLength)
maxLength
- the maximum length of the decoded frame.
A TooLongFrameException
is thrown if
the length of the frame exceeds this value.public LineBasedFrameDecoder(int maxLength, boolean stripDelimiter, boolean failFast)
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 notfailFast
- 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.protected final void decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out) throws java.lang.Exception
ByteToMessageDecoder
ByteBuf
to an other. This method will be called till either the input
ByteBuf
has nothing to read when return from this method or till nothing was read from the input
ByteBuf
.decode
in class ByteToMessageDecoder
ctx
- the ChannelHandlerContext
which this ByteToMessageDecoder
belongs toin
- the ByteBuf
from which to read dataout
- the List
to which decoded messages should be addedjava.lang.Exception
- is thrown if an error accourprotected java.lang.Object decode(ChannelHandlerContext ctx, ByteBuf buffer) throws java.lang.Exception
ByteBuf
and return it.ctx
- the ChannelHandlerContext
which this ByteToMessageDecoder
belongs tobuffer
- the ByteBuf
from which to read dataByteBuf
which represent the frame or null
if no frame could
be created.java.lang.Exception
private void fail(ChannelHandlerContext ctx, int length)
private void fail(ChannelHandlerContext ctx, java.lang.String length)
private static int findEndOfLine(ByteBuf buffer)