Package io.netty.handler.codec.stomp

Class StompSubframeDecoder

  • All Implemented Interfaces:
    io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler
    public class StompSubframeDecoder
extends io.netty.handler.codec.ReplayingDecoder<StompSubframeDecoder.State>
    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 Classes 
      Modifier and Type Class Description
      static class  StompSubframeDecoder.State
      Deprecated.
      this should never be used by an user!

      • Nested classes/interfaces inherited from class io.netty.handler.codec.ByteToMessageDecoder

        io.netty.handler.codec.ByteToMessageDecoder.Cumulator

      • Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

        io.netty.channel.ChannelHandler.Sharable

    • Field Summary

      • Fields inherited from class io.netty.handler.codec.ByteToMessageDecoder

        COMPOSITE_CUMULATOR, MERGE_CUMULATOR

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      protected void decode​(io.netty.channel.ChannelHandlerContext ctx, io.netty.buffer.ByteBuf in, List<Object> out)  

      • 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 interface io.netty.channel.ChannelHandler

        handlerAdded

    • 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​(io.netty.channel.ChannelHandlerContext ctx,
                      io.netty.buffer.ByteBuf in,
                      List<Object> out)
               throws Exception
        Specified by:
        decode in class io.netty.handler.codec.ByteToMessageDecoder
        Throws:
        Exception