Module io.netty5.codec.http

Package io.netty5.handler.codec.http.websocketx

Class WebSocketFrameAggregator

java.lang.Object

io.netty5.channel.ChannelHandlerAdapter

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

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

io.netty5.handler.codec.http.websocketx.WebSocketFrameAggregator

All Implemented Interfaces:

ChannelHandler

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.

Constructor Summary

Constructors

Constructor	Description
WebSocketFrameAggregator(int maxContentLength)	Creates a new instance

Method Summary

Modifier and Type	Method	Description
protected void	aggregate(BufferAllocator allocator, WebSocketFrame aggregated, ContinuationWebSocketFrame content)	Aggregated the passed content in the passed aggregate.
protected WebSocketFrame	beginAggregation(BufferAllocator allocator, WebSocketFrame start)	Creates a new aggregated message from the specified start message.
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(Object 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	isLastContentMessage(ContinuationWebSocketFrame msg)	Returns true if and only if the specified message is the last content message.
protected int	lengthForAggregation(WebSocketFrame msg)	Returns the length in bytes of the passed message.
protected int	lengthForContent(ContinuationWebSocketFrame msg)	Returns the length in bytes of the passed message.
protected Object	newContinueResponse(WebSocketFrame start, int maxContentLength, ChannelPipeline pipeline)	Returns the 'continue response' for the specified start message if necessary.
protected ContinuationWebSocketFrame	tryContentMessage(Object msg)	If the passed msg is a content message then cast and return the same, else return null.
protected WebSocketFrame	tryStartMessage(Object msg)	If the passed msg is a start message then cast and return the same, else return null.

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

acceptInboundMessage, channelInactive, channelReadComplete, ctx, decode, finishAggregation, handleOversizedMessage, handlerAdded, handlerRemoved, maxContentLength

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

channelRead, decodeAndClose

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty5.channel.ChannelHandler

bind, channelActive, channelExceptionCaught, channelInboundEvent, channelRegistered, channelShutdown, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, flush, isSharable, pendingOutboundBytes, read, register, sendOutboundEvent, shutdown, write

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

tryStartMessage

protected WebSocketFrame tryStartMessage(Object msg)

Description copied from class: MessageAggregator

If the passed msg is a start message then cast and return the same, else return null.

Specified by:

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

tryContentMessage

protected ContinuationWebSocketFrame tryContentMessage(Object msg)

Description copied from class: MessageAggregator

If the passed msg is a content message then cast and return the same, else return null.

Specified by:

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

isLastContentMessage

protected boolean isLastContentMessage(ContinuationWebSocketFrame msg)

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>

isAggregated

protected boolean isAggregated(Object 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.tryContentMessage(Object) returns a non null value.

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

lengthForContent

protected int lengthForContent(ContinuationWebSocketFrame msg)

Description copied from class: MessageAggregator

Returns the length in bytes of the passed message.

Specified by:

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

Parameters:

msg - to calculate length.

Returns:

Length in bytes of the passed message.

lengthForAggregation

protected int lengthForAggregation(WebSocketFrame msg)

Description copied from class: MessageAggregator

Returns the length in bytes of the passed message.

Specified by:

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

Parameters:

msg - to calculate length.

Returns:

Length in bytes of the passed message.

beginAggregation

protected WebSocketFrame beginAggregation(BufferAllocator allocator,
                                          WebSocketFrame start)

Description copied from class: MessageAggregator

Creates a new aggregated message from the specified start message.

Specified by:

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

aggregate

protected void aggregate(BufferAllocator allocator,
                         WebSocketFrame aggregated,
                         ContinuationWebSocketFrame content)
                  throws Exception

Description copied from class: MessageAggregator

Aggregated the passed content in the passed aggregate.

Specified by:

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

Throws:

Exception