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
ByteBufs into StompHeadersSubframes and StompContentSubframes.
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 StompContentSubframes 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 TypeClassDescriptionstatic enumDeprecated.this should never be used by an user!Nested classes/interfaces inherited from class ByteToMessageDecoder
ByteToMessageDecoder.CumulatorNested classes/interfaces inherited from interface ChannelHandler
ChannelHandler.Sharable -
Field Summary
Fields inherited from class ByteToMessageDecoder
COMPOSITE_CUMULATOR, MERGE_CUMULATOR -
Constructor Summary
ConstructorsConstructorDescriptionStompSubframeDecoder(boolean validateHeaders) StompSubframeDecoder(int maxLineLength, int maxChunkSize) StompSubframeDecoder(int maxLineLength, int maxChunkSize, boolean validateHeaders) -
Method Summary
Methods inherited from class ReplayingDecoder
callDecode, checkpoint, checkpoint, state, stateMethods inherited from class ByteToMessageDecoder
actualReadableBytes, channelInactive, channelRead, channelReadComplete, decodeLast, discardSomeReadBytes, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setDiscardAfterReads, setSingleDecode, userEventTriggeredMethods inherited from class ChannelInboundHandlerAdapter
channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaughtMethods inherited from class ChannelHandlerAdapter
ensureNotSharable, handlerAdded, isSharableMethods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitMethods inherited from interface ChannelHandler
handlerAdded
-
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:ByteToMessageDecoderDecode the from oneByteBufto an other. This method will be called till either the inputByteBufhas nothing to read when return from this method or till nothing was read from the inputByteBuf.- Specified by:
decodein classByteToMessageDecoder- Parameters:
ctx- theChannelHandlerContextwhich thisByteToMessageDecoderbelongs toin- theByteBuffrom which to read dataout- theListto which decoded messages should be added- Throws:
Exception- is thrown if an error occurs
-