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:

ChannelHandler, ChannelInboundHandler

public class WebSocketFrameAggregator
extends 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

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
WebSocketFrameAggregator(int maxContentLength) Creates a new instance

Method Summary

Modifier and Type	Method and Description
protected WebSocketFrame	beginAggregation(WebSocketFrame start, ByteBuf content) Creates a new aggregated message from the specified start message and the specified content.
protected boolean	closeAfterContinueResponse(Object msg) Determine if the channel should be closed after the result of MessageAggregator.newContinueResponse(Object, int, ChannelPipeline) is written.
protected boolean	ignoreContentAfterContinueResponse(Object msg) Determine if all objects for the current request/response should be ignored or not.
protected boolean	isAggregated(WebSocketFrame msg) Returns true if and only if the specified message is already aggregated.
protected boolean	isContentLengthInvalid(WebSocketFrame start, int maxContentLength) Determine if the message start's content length is known, and if it greater than maxContentLength.
protected boolean	isContentMessage(WebSocketFrame msg) Returns true if and only if the specified message is a content message.
protected boolean	isLastContentMessage(ContinuationWebSocketFrame msg) Returns true if and only if the specified message is the last content message.
protected boolean	isStartMessage(WebSocketFrame msg) Returns true if and only if the specified message is a start message.
protected Object	newContinueResponse(WebSocketFrame start, int maxContentLength, ChannelPipeline pipeline) Returns the 'continue response' for the specified start message if necessary.

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

acceptInboundMessage, aggregate, channelInactive, channelReadComplete, ctx, decode, finishAggregation, handleOversizedMessage, handlerAdded, handlerRemoved, isHandlingOversizedMessage, maxContentLength, maxCumulationBufferComponents, releaseCurrentMessage, 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 Detail

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 Detail

isStartMessage

protected boolean isStartMessage(WebSocketFrame msg)
                          throws Exception

Description copied from class: MessageAggregator

Returns true if and only if the specified message is a start message. Typically, this method is implemented as a single return statement with instanceof:

 return msg instanceof MyStartMessage;
 

Specified by:

isStartMessage in class MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

Throws:

Exception

isContentMessage

protected boolean isContentMessage(WebSocketFrame msg)
                            throws Exception

Description copied from class: MessageAggregator

Returns true if and only if the specified message is a content message. Typically, this method is implemented as a single return statement with instanceof:

 return msg instanceof MyContentMessage;
 

Specified by:

isContentMessage in class MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

Throws:

Exception

isLastContentMessage

protected boolean isLastContentMessage(ContinuationWebSocketFrame msg)
                                throws Exception

Description copied from class: MessageAggregator

Returns true if and only if the specified message is the last content message. Typically, this method is implemented as a single return statement with instanceof:

 return msg instanceof MyLastContentMessage;
 

or with instanceof and boolean field check:

 return msg instanceof MyContentMessage && msg.isLastFragment();
 

Specified by:

isLastContentMessage in class MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

Throws:

Exception

isAggregated

protected boolean isAggregated(WebSocketFrame msg)
                        throws Exception

Description copied from class: MessageAggregator

Returns true if and only if the specified message is already aggregated. If this method returns true, this handler will simply forward the message to the next handler as-is.

Specified by:

isAggregated in class MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

Throws:

Exception

isContentLengthInvalid

protected boolean isContentLengthInvalid(WebSocketFrame start,
                                         int maxContentLength)

Description copied from class: MessageAggregator

Determine if the message start's content length is known, and if it greater than maxContentLength.

Specified by:

isContentLengthInvalid in class MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

Parameters:

start - The message which may indicate the content length.

maxContentLength - The maximum allowed content length.

Returns:

true if the message start's content length is known, and if it greater than maxContentLength. false otherwise.

newContinueResponse

protected Object newContinueResponse(WebSocketFrame start,
                                     int maxContentLength,
                                     ChannelPipeline pipeline)

Description copied from class: MessageAggregator

Returns the 'continue response' for the specified start message if necessary. For example, this method is useful to handle an HTTP 100-continue header.

Specified by:

newContinueResponse in class MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

Returns:

the 'continue response', or null if there's no message to send

closeAfterContinueResponse

protected boolean closeAfterContinueResponse(Object msg)
                                      throws Exception

Description copied from class: MessageAggregator

Determine if the channel should be closed after the result of MessageAggregator.newContinueResponse(Object, int, ChannelPipeline) is written.

Specified by:

closeAfterContinueResponse in class MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

Parameters:

msg - The return value from MessageAggregator.newContinueResponse(Object, int, ChannelPipeline).

Returns:

true if the channel should be closed after the result of MessageAggregator.newContinueResponse(Object, int, ChannelPipeline) is written. false otherwise.

Throws:

Exception

ignoreContentAfterContinueResponse

protected boolean ignoreContentAfterContinueResponse(Object msg)
                                              throws Exception

Description copied from class: MessageAggregator

Determine if all objects for the current request/response should be ignored or not. Messages will stop being ignored the next time MessageAggregator.isContentMessage(Object) returns true.

Specified by:

ignoreContentAfterContinueResponse in class MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

Parameters:

msg - The return value from MessageAggregator.newContinueResponse(Object, int, ChannelPipeline).

Returns:

true if all objects for the current request/response should be ignored or not. false otherwise.

Throws:

Exception

beginAggregation

protected WebSocketFrame beginAggregation(WebSocketFrame start,
                                          ByteBuf content)
                                   throws Exception

Description copied from class: MessageAggregator

Creates a new aggregated message from the specified start message and the specified content. If the start message implements ByteBufHolder, its content is appended to the specified content. This aggregator will continue to append the received content to the specified content.

Specified by:

beginAggregation in class MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

Throws:

Exception