Package io.netty.handler.codec.stomp
Class StompSubframeDecoder
- java.lang.Object
-
- io.netty.channel.ChannelHandlerAdapter
-
- io.netty.channel.ChannelInboundHandlerAdapter
-
- io.netty.handler.codec.ByteToMessageDecoder
-
- io.netty.handler.codec.ReplayingDecoder<StompSubframeDecoder.State>
-
- io.netty.handler.codec.stomp.StompSubframeDecoder
-
- All Implemented Interfaces:
ChannelHandler
,ChannelInboundHandler
public class StompSubframeDecoder extends ReplayingDecoder<StompSubframeDecoder.State>
DecodesByteBuf
s intoStompHeadersSubframe
s andStompContentSubframe
s.Parameters to control memory consumption:
maxLineLength
the maximum length of line - restricts length of command and header lines If the length of the initial line exceeds this value, aTooLongFrameException
will be raised.
maxChunkSize
The maximum length of the content or each chunk. If the content length (or the length of each chunk) exceeds this value, the content or chunk ill be split into multipleStompContentSubframe
s whose length ismaxChunkSize
at maximum.Chunked Content
If the content of a stomp message is greater than
maxChunkSize
the transfer encoding of the HTTP message is 'chunked', this decoder generates multipleStompContentSubframe
instances to avoid excessive memory consumption. Note, that every message, even with no content decodes withLastStompContentSubframe
at the end to simplify upstream message parsing.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description private static class
StompSubframeDecoder.HeaderParser
static class
StompSubframeDecoder.State
private static class
StompSubframeDecoder.Utf8LineParser
-
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
alreadyReadChunkSize
private StompSubframeDecoder.Utf8LineParser
commandParser
private long
contentLength
private static int
DEFAULT_CHUNK_SIZE
private static int
DEFAULT_MAX_LINE_LENGTH
private StompSubframeDecoder.HeaderParser
headerParser
private LastStompContentSubframe
lastContent
private int
maxChunkSize
-
Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder
COMPOSITE_CUMULATOR, MERGE_CUMULATOR
-
-
Constructor Summary
Constructors Constructor Description StompSubframeDecoder()
StompSubframeDecoder(boolean validateHeaders)
StompSubframeDecoder(int maxLineLength, int maxChunkSize)
StompSubframeDecoder(int maxLineLength, int maxChunkSize, boolean validateHeaders)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description protected void
decode(ChannelHandlerContext ctx, ByteBuf in, java.util.List<java.lang.Object> out)
Decode the from oneByteBuf
to an other.private static long
getContentLength(StompHeaders headers)
private StompCommand
readCommand(ByteBuf in)
private StompSubframeDecoder.State
readHeaders(ByteBuf buffer, StompHeadersSubframe headersSubframe)
private void
resetDecoder()
private static void
skipControlCharacters(ByteBuf buffer)
private static void
skipNullCharacter(ByteBuf buffer)
-
Methods inherited from class io.netty.handler.codec.ReplayingDecoder
callDecode, checkpoint, checkpoint, state, state
-
Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder
actualReadableBytes, channelInactive, channelRead, channelReadComplete, decodeLast, discardSomeReadBytes, 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
-
DEFAULT_CHUNK_SIZE
private static final int DEFAULT_CHUNK_SIZE
- See Also:
- Constant Field Values
-
DEFAULT_MAX_LINE_LENGTH
private static final int DEFAULT_MAX_LINE_LENGTH
- See Also:
- Constant Field Values
-
commandParser
private final StompSubframeDecoder.Utf8LineParser commandParser
-
headerParser
private final StompSubframeDecoder.HeaderParser headerParser
-
maxChunkSize
private final int maxChunkSize
-
alreadyReadChunkSize
private int alreadyReadChunkSize
-
lastContent
private LastStompContentSubframe lastContent
-
contentLength
private long contentLength
-
-
Constructor Detail
-
StompSubframeDecoder
public StompSubframeDecoder()
-
StompSubframeDecoder
public StompSubframeDecoder(boolean validateHeaders)
-
StompSubframeDecoder
public StompSubframeDecoder(int maxLineLength, int maxChunkSize)
-
StompSubframeDecoder
public StompSubframeDecoder(int maxLineLength, int maxChunkSize, boolean validateHeaders)
-
-
Method Detail
-
decode
protected 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
-
readCommand
private StompCommand readCommand(ByteBuf in)
-
readHeaders
private StompSubframeDecoder.State readHeaders(ByteBuf buffer, StompHeadersSubframe headersSubframe)
-
getContentLength
private static long getContentLength(StompHeaders headers)
-
skipNullCharacter
private static void skipNullCharacter(ByteBuf buffer)
-
skipControlCharacters
private static void skipControlCharacters(ByteBuf buffer)
-
resetDecoder
private void resetDecoder()
-
-