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

Modifier and Type	Interface	Description
static @interface	ChannelHandler.Sharable	Indicates that the same instance of the annotated ChannelHandler can be added to one or more ChannelPipelines multiple times without a race condition.

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.
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).

Methods inherited from class MessageToMessageEncoder

acceptOutboundMessage, write

Modifier and Type	Method	Description
boolean	acceptOutboundMessage(Object msg)	Returns true if the given message should be handled.
void	write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise)	Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

Methods inherited from class ChannelOutboundHandlerAdapter

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

Modifier and Type	Method	Description
void	bind(ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise)	Calls ChannelOutboundInvoker.bind(SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	close(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.close(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	connect(ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)	Calls ChannelOutboundInvoker.connect(SocketAddress, SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	deregister(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.deregister(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	disconnect(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.disconnect(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	flush(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.flush() to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	read(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.read() to forward to the next ChannelOutboundHandler in the ChannelPipeline.

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable

Modifier and Type	Method	Description
protected void	ensureNotSharable()	Throws IllegalStateException if ChannelHandlerAdapter.isSharable() returns true
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause)	Deprecated. is part of ChannelInboundHandler
void	handlerAdded(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
void	handlerRemoved(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
boolean	isSharable()	Return true if the implementation is ChannelHandler.Sharable and so can be added to different ChannelPipelines.

Methods inherited from class Object

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

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).