public class LineBasedFrameDecoder extends FrameDecoder
ChannelBuffers on line endings.
Both "\n" and "\r\n" are handled.
For a more general delimiter-based decoder, see DelimiterBasedFrameDecoder.
ChannelHandler.Sharablecumulation, DEFAULT_MAX_COMPOSITEBUFFER_COMPONENTS| 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,
Channel channel,
ChannelBuffer buffer)
Decodes the received packets so far into a frame.
|
actualReadableBytes, afterAdd, afterRemove, appendToCumulation, beforeAdd, beforeRemove, channelClosed, channelDisconnected, cleanup, decodeLast, exceptionCaught, extractFrame, getMaxCumulationBufferCapacity, getMaxCumulationBufferComponents, internalBuffer, isUnfold, messageReceived, newCumulationBuffer, replace, setMaxCumulationBufferCapacity, setMaxCumulationBufferComponents, setUnfold, unfoldAndFireMessageReceived, updateCumulationchannelBound, channelConnected, channelInterestChanged, channelOpen, channelUnbound, childChannelClosed, childChannelOpen, handleUpstream, writeCompletepublic 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 Object decode(ChannelHandlerContext ctx, Channel channel, ChannelBuffer buffer) throws Exception
FrameDecoderFrameDecoder.extractFrame(ChannelBuffer, int, int) method,
to make optimizations easier later.decode in class FrameDecoderctx - the context of this handlerchannel - the current channelbuffer - the cumulative buffer of received packets so far.
Note that the buffer might be empty, which means you
should not make an assumption that the buffer contains
at least one byte in your decoder implementation.null if there's not enough data in the buffer to decode a frame.ExceptionCopyright © 2008-2015 The Netty Project. All Rights Reserved.