Package io.netty.handler.codec.http.websocketx

Class WebSocketFrameAggregator

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

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

io.netty.handler.codec.MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

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

All Implemented Interfaces:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler

public class WebSocketFrameAggregator
extends io.netty.handler.codec.MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor	Description
WebSocketFrameAggregator(int maxContentLength)	Creates a new instance

Method Summary

Modifier and Type	Method	Description
protected WebSocketFrame	beginAggregation(WebSocketFrame start, io.netty.buffer.ByteBuf content)
protected boolean	closeAfterContinueResponse(Object msg)
protected boolean	ignoreContentAfterContinueResponse(Object msg)
protected boolean	isAggregated(WebSocketFrame msg)
protected boolean	isContentLengthInvalid(WebSocketFrame start, int maxContentLength)
protected boolean	isContentMessage(WebSocketFrame msg)
protected boolean	isLastContentMessage(ContinuationWebSocketFrame msg)
protected boolean	isStartMessage(WebSocketFrame msg)
protected Object	newContinueResponse(WebSocketFrame start, int maxContentLength, io.netty.channel.ChannelPipeline pipeline)

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

acceptInboundMessage, aggregate, channelInactive, channelReadComplete, ctx, decode, finishAggregation, handleOversizedMessage, handlerAdded, handlerRemoved, isHandlingOversizedMessage, maxContentLength, maxCumulationBufferComponents, setMaxCumulationBufferComponents

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

channelRead

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, isSharable

Methods inherited from class java.lang.Object

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

Constructor Details

WebSocketFrameAggregator

public WebSocketFrameAggregator(int maxContentLength)

Creates a new instance

Parameters:

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

Method Details

isStartMessage

protected boolean isStartMessage(WebSocketFrame msg)
                          throws Exception

Specified by:

isStartMessage in class io.netty.handler.codec.MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

Throws:

Exception

isContentMessage

protected boolean isContentMessage(WebSocketFrame msg)
                            throws Exception

Specified by:

isContentMessage in class io.netty.handler.codec.MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

Throws:

Exception

isLastContentMessage

protected boolean isLastContentMessage(ContinuationWebSocketFrame msg)
                                throws Exception

Specified by:

isLastContentMessage in class io.netty.handler.codec.MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

Throws:

Exception

isAggregated

protected boolean isAggregated(WebSocketFrame msg)
                        throws Exception

Specified by:

isAggregated in class io.netty.handler.codec.MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

Throws:

Exception

isContentLengthInvalid

protected boolean isContentLengthInvalid(WebSocketFrame start,
 int maxContentLength)

Specified by:

isContentLengthInvalid in class io.netty.handler.codec.MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

newContinueResponse

protected Object newContinueResponse(WebSocketFrame start,
 int maxContentLength,
 io.netty.channel.ChannelPipeline pipeline)

Specified by:

newContinueResponse in class io.netty.handler.codec.MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

closeAfterContinueResponse

protected boolean closeAfterContinueResponse(Object msg)
                                      throws Exception

Specified by:

closeAfterContinueResponse in class io.netty.handler.codec.MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

Throws:

Exception

ignoreContentAfterContinueResponse

protected boolean ignoreContentAfterContinueResponse(Object msg)
                                              throws Exception

Specified by:

ignoreContentAfterContinueResponse in class io.netty.handler.codec.MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

Throws:

Exception

beginAggregation

protected WebSocketFrame beginAggregation(WebSocketFrame start,
 io.netty.buffer.ByteBuf content)
                                   throws Exception

Specified by:

beginAggregation in class io.netty.handler.codec.MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

Throws:

Exception