io.netty.handler.codec.stomp

Class StompSubframeDecoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.ReplayingDecoder<io.netty.handler.codec.stomp.StompSubframeDecoder.State>

io.netty.handler.codec.stomp.StompSubframeDecoder

All Implemented Interfaces:

ChannelHandler

public class StompSubframeDecoder
extends ReplayingDecoder<io.netty.handler.codec.stomp.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/interfaces inherited from class io.netty.handler.codec.ByteToMessageDecoder

ByteToMessageDecoder.Cumulator

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

ChannelHandler.Sharable, ChannelHandler.Skip

Field Summary

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

COMPOSITE_CUMULATOR, MERGE_CUMULATOR

Constructor Summary

Constructors

Constructor and Description
StompSubframeDecoder()
StompSubframeDecoder(int maxLineLength, int maxChunkSize)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) Decode the from one ByteBuf to an other.

Methods inherited from class io.netty.handler.codec.ReplayingDecoder

callDecode, channelInactive, checkpoint, checkpoint, state, state

Methods inherited from class io.netty.handler.codec.ByteToMessageDecoder

actualReadableBytes, channelRead, channelReadComplete, decodeLast, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setCumulator, setSingleDecode

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

bind, channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, exceptionCaught, flush, handlerAdded, isSharable, read, userEventTriggered, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

StompSubframeDecoder

public StompSubframeDecoder()

StompSubframeDecoder

public StompSubframeDecoder(int maxLineLength,
                    int maxChunkSize)

Method Detail

decode

protected void decode(ChannelHandlerContext ctx,
          ByteBuf in,
          List<Object> out)
               throws Exception

Description copied from class: ByteToMessageDecoder

Decode the from one ByteBuf to an other. This method will be called till either the input ByteBuf has nothing to read when return from this method or till nothing was read from the input ByteBuf.

Specified by:

decode in class ByteToMessageDecoder

Parameters:

ctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs to

in - the ByteBuf from which to read data

out - the List to which decoded messages should be added

Throws:

Exception - is thrown if an error accour