io.netty.handler.codec.http.websocketx

Class WebSocketFrameAggregator

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

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

io.netty.handler.codec.http.websocketx.WebSocketFrameAggregator

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler

public class WebSocketFrameAggregator
extends MessageToMessageDecoder<WebSocketFrame>

Handler that aggregate fragmented WebSocketFrame's. Be aware if PING/PONG/CLOSE frames are send in the middle of a fragmented WebSocketFrame they will just get forwarded to the next handler in the pipeline.

Nested Class Summary

Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
WebSocketFrameAggregator(int maxFrameSize) Construct a new instance

Method Summary

Modifier and Type	Method and Description
void	channelInactive(ChannelHandlerContext ctx) Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
protected void	decode(ChannelHandlerContext ctx, WebSocketFrame msg, java.util.List<java.lang.Object> out) Decode from one message to an other.
void	handlerRemoved(ChannelHandlerContext ctx) Do nothing by default, sub-classes may override this method.

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

acceptInboundMessage, channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, 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

Constructor Detail

WebSocketFrameAggregator

public WebSocketFrameAggregator(int maxFrameSize)

Construct a new instance

Parameters:

maxFrameSize - If the size of the aggregated frame exceeds this value, a TooLongFrameException is thrown.

Method Detail

decode

protected void decode(ChannelHandlerContext ctx,
                      WebSocketFrame msg,
                      java.util.List<java.lang.Object> out)
               throws java.lang.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 encoder.

Specified by:

decode in class MessageToMessageDecoder<WebSocketFrame>

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:

java.lang.Exception - is thrown if an error occurs

channelInactive

public void channelInactive(ChannelHandlerContext ctx)
                     throws java.lang.Exception

Description copied from class: ChannelInboundHandlerAdapter

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

Specified by:

channelInactive in interface ChannelInboundHandler

Overrides:

channelInactive in class ChannelInboundHandlerAdapter

Throws:

java.lang.Exception

handlerRemoved

public void handlerRemoved(ChannelHandlerContext ctx)
                    throws java.lang.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:

java.lang.Exception