BufferingStompDecoder

An extension of {@link hunt.stomp.simp.stomp.StompDecoder} that buffers content remaining in the input ByteBuffer after the parent class has read all (complete) STOMP frames from it. The remaining content represents an incomplete STOMP frame. When called repeatedly with additional data, the decode method returns one or more messages or, if there is not enough data still, continues to buffer.

<p>A single instance of this decoder can be invoked repeatedly to read all messages from a single stream (e.g. WebSocket session) as long as decoding does not fail. If there is an exception, StompDecoder instance should not be used any more as its internal state is not guaranteed to be consistent. It is expected that the underlying session is closed at that point.

@author Rossen Stoyanchev @since 4.0.3 @see StompDecoder

Constructors

this
this(StompDecoder stompDecoder, int bufferSizeLimit)

Create a new {@code BufferingStompDecoder} wrapping the given {@code StompDecoder}. @param stompDecoder the target decoder to wrap @param bufferSizeLimit the buffer size limit

Members

Functions

decode
List!(Message!(byte[])) decode(ByteBuffer newBuffer)

Decodes one or more STOMP frames from the given {@code ByteBuffer} into a list of {@link Message Messages}. <p>If there was enough data to parse a "content-length" header, then the value is used to determine how much more data is needed before a new attempt to decode is made. <p>If there was not enough data to parse the "content-length", or if there is "content-length" header, every subsequent call to decode attempts to parse again with all available data. Therefore the presence of a "content-length" header helps to optimize the decoding of large messages. @param newBuffer a buffer containing new data to decode @return decoded messages or an empty list @throws StompConversionException raised in case of decoding issues

getBufferSize
int getBufferSize()

Calculate the current buffer size.

getBufferSizeLimit
int getBufferSizeLimit()

Return the configured buffer size limit.

getExpectedContentLength
Integer getExpectedContentLength()

Get the expected content length of the currently buffered, incomplete STOMP frame.

getStompDecoder
StompDecoder getStompDecoder()

Return the wrapped {@link StompDecoder}.

Meta