Class StompSubframeEncoder

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.codec.MessageToMessageEncoder<StompSubframe>

io.netty.handler.codec.stomp.StompSubframeEncoder

All Implemented Interfaces:

ChannelHandler, ChannelOutboundHandler

public class StompSubframeEncoder
extends MessageToMessageEncoder<StompSubframe>

Encodes a StompFrame or a StompSubframe into a ByteBuf.

Nested Class Summary

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
private static final float	DEFAULT_LOAD_FACTOR
private static final FastThreadLocal<LinkedHashMap<CharSequence, CharSequence>>	ESCAPE_HEADER_KEY_CACHE
private static final int	ESCAPE_HEADER_KEY_CACHE_LIMIT

Constructor Summary

Constructors

Constructor	Description
StompSubframeEncoder()

Method Summary

Modifier and Type	Method	Description
protected Object	convertContentSubFrame(StompContentSubframe original, ByteBuf encoded)	An extension method to convert a STOMP encoded buffer to a different message type based on an original StompHeadersSubframe content sub frame.
protected Object	convertFullFrame(StompFrame original, ByteBuf encoded)	An extension method to convert a STOMP encoded buffer to a different message type based on an original StompFrame full frame.
protected Object	convertHeadersSubFrame(StompHeadersSubframe original, ByteBuf encoded)	An extension method to convert a STOMP encoded buffer to a different message type based on an original StompHeadersSubframe headers sub frame.
protected void	encode(ChannelHandlerContext ctx, StompSubframe msg, List<Object> out)	Encode from one message to an other.
private static ByteBuf	encodeContent(StompContentSubframe content, ChannelHandlerContext ctx)
private ByteBuf	encodeFullFrame(StompFrame frame, ChannelHandlerContext ctx)
private static void	encodeHeaders(StompHeadersSubframe frame, ByteBuf buf)
private static CharSequence	escape(CharSequence input)
private static AppendableCharSequence	escapeBuilder(AppendableCharSequence builder, CharSequence input, int offset)
protected int	headersSubFrameSize(StompHeadersSubframe headersSubframe)	Returns a heuristic size for headers (32 bytes per header line) + (2 bytes for colon and eol) + (additional command buffer).
private static boolean	shouldEscape(StompCommand command)

Methods inherited from class MessageToMessageEncoder

acceptOutboundMessage, write

Methods inherited from class ChannelOutboundHandlerAdapter

bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable

Methods inherited from class Object

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

Methods inherited from interface ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

Field Details

ESCAPE_HEADER_KEY_CACHE_LIMIT

private static final int ESCAPE_HEADER_KEY_CACHE_LIMIT

See Also:

• Constant Field Values

DEFAULT_LOAD_FACTOR

private static final float DEFAULT_LOAD_FACTOR

See Also:

• Constant Field Values

ESCAPE_HEADER_KEY_CACHE

private static final FastThreadLocal<LinkedHashMap<CharSequence, CharSequence>> ESCAPE_HEADER_KEY_CACHE

Constructor Details

StompSubframeEncoder

public StompSubframeEncoder()

Method Details

encode

protected void encode(ChannelHandlerContext ctx,
 StompSubframe msg,
 List<Object> out)
               throws Exception

Description copied from class: MessageToMessageEncoder

Encode from one message to an other. This method will be called for each written message that can be handled by this encoder.

Specified by:

encode in class MessageToMessageEncoder<StompSubframe>

Parameters:

ctx - the ChannelHandlerContext which this MessageToMessageEncoder belongs to

msg - the message to encode to an other one

out - the List into which the encoded msg should be added needs to do some kind of aggregation

Throws:

Exception - is thrown if an error occurs

convertFullFrame

protected Object convertFullFrame(StompFrame original,
 ByteBuf encoded)

An extension method to convert a STOMP encoded buffer to a different message type based on an original StompFrame full frame.

By default an encoded buffer is returned as is.

convertHeadersSubFrame

protected Object convertHeadersSubFrame(StompHeadersSubframe original,
 ByteBuf encoded)

An extension method to convert a STOMP encoded buffer to a different message type based on an original StompHeadersSubframe headers sub frame.

By default an encoded buffer is returned as is.

convertContentSubFrame

protected Object convertContentSubFrame(StompContentSubframe original,
 ByteBuf encoded)

An extension method to convert a STOMP encoded buffer to a different message type based on an original StompHeadersSubframe content sub frame.

By default an encoded buffer is returned as is.

headersSubFrameSize

protected int headersSubFrameSize(StompHeadersSubframe headersSubframe)

Returns a heuristic size for headers (32 bytes per header line) + (2 bytes for colon and eol) + (additional command buffer).

encodeFullFrame

private ByteBuf encodeFullFrame(StompFrame frame,
 ChannelHandlerContext ctx)

encodeHeaders

private static void encodeHeaders(StompHeadersSubframe frame,
 ByteBuf buf)

encodeContent

private static ByteBuf encodeContent(StompContentSubframe content,
 ChannelHandlerContext ctx)

shouldEscape

private static boolean shouldEscape(StompCommand command)

escape

private static CharSequence escape(CharSequence input)

escapeBuilder

private static AppendableCharSequence escapeBuilder(AppendableCharSequence builder,
 CharSequence input,
 int offset)