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
Decodes
ByteBuf
s into StompHeadersSubframe
s and StompContentSubframe
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, a TooLongFrameException
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 multiple StompContentSubframe
s whose length
is maxChunkSize
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 multiple StompContentSubframe
instances to avoid excessive memory
consumption. Note, that every message, even with no content decodes with LastStompContentSubframe
at the end
to simplify upstream message parsing.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate static final class
static enum
private static class
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
FieldsModifier and TypeFieldDescriptionprivate int
private final StompSubframeDecoder.Utf8LineParser
private long
private static final int
private static final int
private final StompSubframeDecoder.HeaderParser
private LastStompContentSubframe
private final int
Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder
COMPOSITE_CUMULATOR, MERGE_CUMULATOR
-
Constructor Summary
ConstructorsConstructorDescriptionStompSubframeDecoder
(boolean validateHeaders) StompSubframeDecoder
(int maxLineLength, int maxChunkSize) StompSubframeDecoder
(int maxLineLength, int maxChunkSize, boolean validateHeaders) -
Method Summary
Modifier and TypeMethodDescriptionprotected void
decode
(ChannelHandlerContext ctx, ByteBuf in, List<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
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 Details
-
DEFAULT_CHUNK_SIZE
private static final int DEFAULT_CHUNK_SIZE- See Also:
-
DEFAULT_MAX_LINE_LENGTH
private static final int DEFAULT_MAX_LINE_LENGTH- See Also:
-
commandParser
-
headerParser
-
maxChunkSize
private final int maxChunkSize -
alreadyReadChunkSize
private int alreadyReadChunkSize -
lastContent
-
contentLength
private long contentLength
-
-
Constructor Details
-
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 Details
-
decode
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:
Exception
- is thrown if an error occurs
-
readCommand
-
readHeaders
private StompSubframeDecoder.State readHeaders(ByteBuf buffer, StompHeadersSubframe headersSubframe) -
getContentLength
-
skipNullCharacter
-
skipControlCharacters
-
resetDecoder
private void resetDecoder()
-