Class SctpMessageCompletionHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.handler.codec.MessageToMessageDecoder<SctpMessage>

io.netty.handler.codec.sctp.SctpMessageCompletionHandler

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public class SctpMessageCompletionHandler
extends MessageToMessageDecoder<SctpMessage>

MessageToMessageDecoder which will take care of handle fragmented SctpMessages, so only complete SctpMessages will be forwarded to the next ChannelInboundHandler.

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
SctpMessageCompletionHandler()
SctpMessageCompletionHandler(int maxIncompleteSctpMessages, int maxFragments)	Create a new instance.
SctpMessageCompletionHandler(int maxIncompleteSctpMessages, int maxFragments, int maxBufferedBytes)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
protected void	decode(ChannelHandlerContext ctx, SctpMessage msg, List<Object> out)	Decode from one message to an other.
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause)	Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.
void	handlerRemoved(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.

Methods inherited from class MessageToMessageDecoder

acceptInboundMessage, channelRead, channelReadComplete

Modifier and Type	Method	Description
boolean	acceptInboundMessage(Object msg)	Returns true if the given message should be handled.
void	channelRead(ChannelHandlerContext ctx, Object msg)	Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelReadComplete(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline.

Methods inherited from class ChannelInboundHandlerAdapter

channelActive, channelInactive, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered

Modifier and Type	Method	Description
void	channelActive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelInactive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRegistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelUnregistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelUnregistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelWritabilityChanged(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	userEventTriggered(ChannelHandlerContext ctx, Object evt)	Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

Modifier and Type	Method	Description
protected void	ensureNotSharable()	Throws IllegalStateException if ChannelHandlerAdapter.isSharable() returns true
void	handlerAdded(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

SctpMessageCompletionHandler

public SctpMessageCompletionHandler()

SctpMessageCompletionHandler

public SctpMessageCompletionHandler(int maxIncompleteSctpMessages,
 int maxFragments)

Create a new instance.

Parameters:

maxIncompleteSctpMessages - the maximum number of incomplete sctp message inflight.

maxFragments - the maximum number of fragments per sctp message.

SctpMessageCompletionHandler

public SctpMessageCompletionHandler(int maxIncompleteSctpMessages,
 int maxFragments,
 int maxBufferedBytes)

Create a new instance.

Parameters:

maxIncompleteSctpMessages - the maximum number of incomplete sctp message inflight.

maxFragments - the maximum number of fragments per sctp message.

maxBufferedBytes - the maximum number of bytes buffered by incomplete sctp messages.

Method Details

decode

protected void decode(ChannelHandlerContext ctx,
 SctpMessage msg,
 List<Object> out)
               throws Exception

Description copied from class: MessageToMessageDecoder

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

Specified by:

decode in class MessageToMessageDecoder<SctpMessage>

Parameters:

ctx - the ChannelHandlerContext which this MessageToMessageDecoder belongs to

msg - the message to decode to an other one

out - the List to which decoded messages should be added

Throws:

Exception - is thrown if an error occurs

handlerRemoved

public void handlerRemoved(ChannelHandlerContext ctx)
                    throws Exception

Description copied from class: ChannelHandlerAdapter

Do nothing by default, sub-classes may override this method.

Specified by:

handlerRemoved in interface ChannelHandler

Overrides:

handlerRemoved in class ChannelHandlerAdapter

Throws:

Exception

exceptionCaught

public void exceptionCaught(ChannelHandlerContext ctx,
 Throwable cause)
                     throws Exception

Description copied from class: ChannelInboundHandlerAdapter

Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline. Sub-classes may override this method to change behavior.

Specified by:

exceptionCaught in interface ChannelHandler

Specified by:

exceptionCaught in interface ChannelInboundHandler

Overrides:

exceptionCaught in class ChannelInboundHandlerAdapter

Throws:

Exception