Package io.netty.handler.codec.sctp

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 io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field	Description
private long	bufferedBytes
private static final int	DEFAULT_MAX_BUFFERED_BYTES
private final IntObjectMap<List<ByteBuf>>	incompleteSctpMessages
private final int	maxBufferedBytes
private final int	maxFragments
private final int	maxIncompleteSctpMessages

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
private void	checkBufferedBytes(ByteBuf byteBuf)
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.
private void	removeBufferedBytes(List<ByteBuf> buffers)

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

acceptInboundMessage, channelRead, channelReadComplete

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelInactive, channelRegistered, channelUnregistered, channelWritabilityChanged, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, handlerAdded, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

handlerAdded

Field Details

DEFAULT_MAX_BUFFERED_BYTES

private static final int DEFAULT_MAX_BUFFERED_BYTES

See Also:

• Constant Field Values

incompleteSctpMessages

private final IntObjectMap<List<ByteBuf>> incompleteSctpMessages

maxIncompleteSctpMessages

private final int maxIncompleteSctpMessages

maxFragments

private final int maxFragments

maxBufferedBytes

private final int maxBufferedBytes

bufferedBytes

private long bufferedBytes

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

checkBufferedBytes

private void checkBufferedBytes(ByteBuf byteBuf)

removeBufferedBytes

private void removeBufferedBytes(List<ByteBuf> buffers)

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