Class LineBasedFrameDecoder
- java.lang.Object
-
- org.jboss.netty.channel.SimpleChannelUpstreamHandler
-
- org.jboss.netty.handler.codec.frame.FrameDecoder
-
- org.jboss.netty.handler.codec.frame.LineBasedFrameDecoder
-
- All Implemented Interfaces:
ChannelHandler
,ChannelUpstreamHandler
,LifeCycleAwareChannelHandler
public class LineBasedFrameDecoder extends FrameDecoder
A decoder that splits the receivedChannelBuffer
s on line endings.Both
"\n"
and"\r\n"
are handled. For a more general delimiter-based decoder, seeDelimiterBasedFrameDecoder
.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.jboss.netty.channel.ChannelHandler
ChannelHandler.Sharable
-
-
Field Summary
-
Fields inherited from class org.jboss.netty.handler.codec.frame.FrameDecoder
cumulation, DEFAULT_MAX_COMPOSITEBUFFER_COMPONENTS
-
-
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 Object
decode(ChannelHandlerContext ctx, Channel channel, ChannelBuffer buffer)
Decodes the received packets so far into a frame.-
Methods inherited from class org.jboss.netty.handler.codec.frame.FrameDecoder
actualReadableBytes, afterAdd, afterRemove, appendToCumulation, beforeAdd, beforeRemove, channelClosed, channelDisconnected, cleanup, decodeLast, exceptionCaught, extractFrame, getMaxCumulationBufferCapacity, getMaxCumulationBufferComponents, internalBuffer, isUnfold, messageReceived, newCumulationBuffer, replace, setMaxCumulationBufferCapacity, setMaxCumulationBufferComponents, setUnfold, unfoldAndFireMessageReceived, updateCumulation
-
Methods inherited from class org.jboss.netty.channel.SimpleChannelUpstreamHandler
channelBound, channelConnected, channelInterestChanged, channelOpen, channelUnbound, childChannelClosed, childChannelOpen, handleUpstream, writeComplete
-
-
-
-
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 Object decode(ChannelHandlerContext ctx, Channel channel, ChannelBuffer buffer) throws Exception
Description copied from class:FrameDecoder
Decodes the received packets so far into a frame. If an sub-class wants to extract a frame out of the buffer it should use theFrameDecoder.extractFrame(ChannelBuffer, int, int)
method, to make optimizations easier later.- Specified by:
decode
in classFrameDecoder
- Parameters:
ctx
- 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.- Returns:
- the decoded frame if a full frame was received and decoded.
null
if there's not enough data in the buffer to decode a frame. - Throws:
Exception
-
-