io.netty.handler.codec.http.websocketx

类 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

所有已实现的接口:

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.

嵌套类概要

从接口继承的嵌套类/接口 io.netty.channel.ChannelHandler

ChannelHandler.Sharable

构造器概要

构造器

构造器和说明
WebSocketFrameAggregator(int maxContentLength) Creates a new instance

方法概要

限定符和类型	方法和说明
protected WebSocketFrame	beginAggregation(WebSocketFrame start, ByteBuf content) Creates a new aggregated message from the specified start message and the specified content.
protected boolean	closeAfterContinueResponse(java.lang.Object msg) Determine if the channel should be closed after the result of MessageAggregator.newContinueResponse(Object, int, ChannelPipeline) is written.
protected boolean	ignoreContentAfterContinueResponse(java.lang.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 java.lang.Object	newContinueResponse(WebSocketFrame start, int maxContentLength, ChannelPipeline pipeline) Returns the 'continue response' for the specified start message if necessary.

从类继承的方法 io.netty.handler.codec.MessageAggregator

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

从类继承的方法 io.netty.handler.codec.MessageToMessageDecoder

channelRead

从类继承的方法 io.netty.channel.ChannelInboundHandlerAdapter

channelActive, channelRegistered, channelUnregistered, channelWritabilityChanged, exceptionCaught, userEventTriggered

从类继承的方法 io.netty.channel.ChannelHandlerAdapter

ensureNotSharable, isSharable

从类继承的方法 java.lang.Object

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

构造器详细资料

WebSocketFrameAggregator

public WebSocketFrameAggregator(int maxContentLength)

Creates a new instance

参数:

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

方法详细资料

isStartMessage

protected boolean isStartMessage(WebSocketFrame msg)
                          throws java.lang.Exception

从类复制的说明: 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;
 

指定者:

isStartMessage 在类中 MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

抛出:

java.lang.Exception

isContentMessage

protected boolean isContentMessage(WebSocketFrame msg)
                            throws java.lang.Exception

从类复制的说明: 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;
 

指定者:

isContentMessage 在类中 MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

抛出:

java.lang.Exception

isLastContentMessage

protected boolean isLastContentMessage(ContinuationWebSocketFrame msg)
                                throws java.lang.Exception

从类复制的说明: 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();
 

指定者:

isLastContentMessage 在类中 MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

抛出:

java.lang.Exception

isAggregated

protected boolean isAggregated(WebSocketFrame msg)
                        throws java.lang.Exception

从类复制的说明: 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.

指定者:

isAggregated 在类中 MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

抛出:

java.lang.Exception

isContentLengthInvalid

protected boolean isContentLengthInvalid(WebSocketFrame start,
                                         int maxContentLength)

从类复制的说明: MessageAggregator

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

指定者:

isContentLengthInvalid 在类中 MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

参数:

start - The message which may indicate the content length.

maxContentLength - The maximum allowed content length.

返回:

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

newContinueResponse

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

从类复制的说明: 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.

指定者:

newContinueResponse 在类中 MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

返回:

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

closeAfterContinueResponse

protected boolean closeAfterContinueResponse(java.lang.Object msg)
                                      throws java.lang.Exception

从类复制的说明: MessageAggregator

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

指定者:

closeAfterContinueResponse 在类中 MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

参数:

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

返回:

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

抛出:

java.lang.Exception

ignoreContentAfterContinueResponse

protected boolean ignoreContentAfterContinueResponse(java.lang.Object msg)
                                              throws java.lang.Exception

从类复制的说明: 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.

指定者:

ignoreContentAfterContinueResponse 在类中 MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

参数:

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

返回:

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

抛出:

java.lang.Exception

beginAggregation

protected WebSocketFrame beginAggregation(WebSocketFrame start,
                                          ByteBuf content)
                                   throws java.lang.Exception

从类复制的说明: 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.

指定者:

beginAggregation 在类中 MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>

抛出:

java.lang.Exception