public class LineBasedFrameDecoder extends ByteToMessageDecoder
ByteBufs on line endings.
Both "\n" and "\r\n" are handled.
For a more general delimiter-based decoder, see DelimiterBasedFrameDecoder.
ByteToMessageDecoder.CumulatorChannelHandler.SharableCOMPOSITE_CUMULATOR, 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 Object |
decode(ChannelHandlerContext ctx,
ByteBuf buffer)
Create a frame out of the
ByteBuf and return it. |
protected void |
decode(ChannelHandlerContext ctx,
ByteBuf in,
List<Object> out)
Decode the from one
ByteBuf to an other. |
actualReadableBytes, callDecode, channelInactive, channelRead, channelReadComplete, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggeredchannelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaughthandlerAdded, isSharableclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waithandlerAddedpublic 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, List<Object> out) throws Exception
ByteToMessageDecoderByteBuf 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 ByteToMessageDecoderctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs toin - the ByteBuf from which to read dataout - the List to which decoded messages should be addedException - is thrown if an error accourprotected Object decode(ChannelHandlerContext ctx, ByteBuf buffer) throws 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.ExceptionCopyright © 2008–2016 The Netty Project. All rights reserved.