WebSocketFrameAggregator (Netty API Reference (4.1.22.Final))

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>
```
处理程序聚合碎片WebSocketFrame的。请注意PING / PONG / CLOSE帧是否在分片WebSocketFrame的中间发送，它们只会被转发到流水线中的下一个处理程序。

Nested Class Summary
- Nested classes/interfaces inherited from interface io.netty.channel.ChannelHandler
  ChannelHandler.Sharable

构造方法摘要

构造方法
Constructor and Description
`WebSocketFrameAggregator(int maxContentLength)` 创建一个新的实例

方法摘要

所有方法接口方法具体的方法
Modifier and Type	Method and Description
`protected WebSocketFrame`	`beginAggregation(WebSocketFrame start, ByteBuf content)` 根据指定的开始消息和指定的内容创建新的聚合消息。
`protected boolean`	`closeAfterContinueResponse(java.lang.Object msg)` 在写入 `MessageAggregator.newContinueResponse(Object, int, ChannelPipeline)`的结果之后，确定通道是否应该关闭。
`protected boolean`	`ignoreContentAfterContinueResponse(java.lang.Object msg)` 确定当前请求/响应的所有对象是否应该被忽略。
`protected boolean`	`isAggregated(WebSocketFrame msg)` 当且仅当指定的消息已经聚合时才返回 `true` 。
`protected boolean`	`isContentLengthInvalid(WebSocketFrame start, int maxContentLength)` 确定消息 `start`的内容长度是否已知，并且是否大于 `maxContentLength` 。
`protected boolean`	`isContentMessage(WebSocketFrame msg)` 当且仅当指定的消息是内容消息时返回 `true` 。
`protected boolean`	`isLastContentMessage(ContinuationWebSocketFrame msg)` 当且仅当指定的消息是最后一个内容消息时返回 `true` 。
`protected boolean`	`isStartMessage(WebSocketFrame msg)` 当且仅当指定的消息是开始消息时返回 `true` 。
`protected java.lang.Object`	`newContinueResponse(WebSocketFrame start, int maxContentLength, ChannelPipeline pipeline)` 如有必要，返回指定开始消息的'continue response'。

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

- 构造方法详细信息
  - WebSocketFrameAggregator
```
public WebSocketFrameAggregator(int maxContentLength)
```
    创建一个新的实例
    
    参数
    
    maxContentLength - 如果聚集帧的大小超过此值，则引发TooLongFrameException 。
- 方法详细信息
  - isStartMessage
```
protected boolean isStartMessage(WebSocketFrame msg)
                          throws java.lang.Exception
```
    从类复制的描述： MessageAggregator
    当且仅当指定的消息是开始消息时返回true 。通常情况下，此方法以instanceof作为单个return语句instanceof ：
```
  return msg instanceof MyStartMessage; 
```
    Specified by:
    
    isStartMessage在课堂上 MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>
    
    异常
    
    java.lang.Exception
  - isContentMessage
```
protected boolean isContentMessage(WebSocketFrame msg)
                            throws java.lang.Exception
```
    从类复制的描述： MessageAggregator
    当且仅当指定的消息是内容消息时返回true 。通常，这种方法是作为一个return声明与instanceof ：
```
  return msg instanceof MyContentMessage; 
```
    Specified by:
    
    isContentMessage在课堂上 MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>
    
    异常
    
    java.lang.Exception
  - isLastContentMessage
```
protected boolean isLastContentMessage(ContinuationWebSocketFrame msg)
                                throws java.lang.Exception
```
    从类复制的描述： MessageAggregator
    当且仅当指定的消息是最后一个内容消息时返回true 。通常情况下，此方法作为return的单个return语句instanceof ：
```
  return msg instanceof MyLastContentMessage; 
```
    或者用instanceof和布尔字段检查：
```
  return msg instanceof MyContentMessage && msg.isLastFragment(); 
```
    Specified by:
    
    isLastContentMessage在课程 MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>
    
    异常
    
    java.lang.Exception
  - isAggregated
```
protected boolean isAggregated(WebSocketFrame msg)
                        throws java.lang.Exception
```
    从类复制的描述： MessageAggregator
    
    当且仅当指定的消息已经聚合时才返回true 。如果此方法返回true ，则此处理程序将仅将消息按true转发给下一个处理程序。
    
    Specified by:
    
    isAggregated在课堂上 MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>
    
    异常
    
    java.lang.Exception
  - isContentLengthInvalid
```
protected boolean isContentLengthInvalid(WebSocketFrame start,
                                         int maxContentLength)
```
    从类复制的描述： MessageAggregator
    
    确定消息 start的内容长度是否已知，并且是否大于 maxContentLength 。
    
    Specified by:
    
    isContentLengthInvalid在课程 MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>
    
    参数
    
    start - 可能指示内容长度的消息。
    
    maxContentLength - 允许的最大内容长度。
    
    结果
    
    true如果消息start的内容长度已知，并且它大于maxContentLength 。 false否则。
  - newContinueResponse
```
protected java.lang.Object newContinueResponse(WebSocketFrame start,
                                               int maxContentLength,
                                               ChannelPipeline pipeline)
```
    从类复制的描述： MessageAggregator
    
    如有必要，返回指定开始消息的'continue response'。例如，这个方法对于处理一个HTTP 100-continue头是很有用的。
    
    Specified by:
    
    newContinueResponse在课堂上 MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>
    
    结果
    
    '继续回复'，或者如果没有要发送的消息，则 null
  - closeAfterContinueResponse
```
protected boolean closeAfterContinueResponse(java.lang.Object msg)
                                      throws java.lang.Exception
```
    从类复制的描述： MessageAggregator
    
    在写入 MessageAggregator.newContinueResponse(Object, int, ChannelPipeline)的结果后，确定通道是否应该关闭。
    
    Specified by:
    
    closeAfterContinueResponse在类 MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>
    
    参数
    
    msg -从返回值 MessageAggregator.newContinueResponse(Object, int, ChannelPipeline) 。
    
    结果
    
    true如果在写入MessageAggregator.newContinueResponse(Object, int, ChannelPipeline)的结果后关闭通道。 false否则。
    
    异常
    
    java.lang.Exception
  - ignoreContentAfterContinueResponse
```
protected boolean ignoreContentAfterContinueResponse(java.lang.Object msg)
                                              throws java.lang.Exception
```
    从类复制的描述： MessageAggregator
    
    确定当前请求/响应的所有对象是否应该被忽略。下次MessageAggregator.isContentMessage(Object)返回true时，消息将不再被忽略。
    
    Specified by:
    
    ignoreContentAfterContinueResponse ，上课 MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>
    
    参数
    
    msg -从返回值 MessageAggregator.newContinueResponse(Object, int, ChannelPipeline) 。
    
    结果
    
    true如果当前请求/响应的所有对象都应该被忽略。 false否则。
    
    异常
    
    java.lang.Exception
  - beginAggregation
```
protected WebSocketFrame beginAggregation(WebSocketFrame start,
                                          ByteBuf content)
                                   throws java.lang.Exception
```
    从类复制的描述： MessageAggregator
    
    根据指定的开始消息和指定的内容创建新的聚合消息。如果启动消息实现ByteBufHolder ，则其内容将附加到指定的content 。此聚合器将继续将收到的内容附加到指定的content 。
    
    Specified by:
    
    beginAggregation在课堂上 MessageAggregator<WebSocketFrame,WebSocketFrame,ContinuationWebSocketFrame,WebSocketFrame>
    
    异常
    
    java.lang.Exception

Class WebSocketFrameAggregator

Nested Class Summary

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

构造方法摘要

方法摘要

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

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

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

Methods inherited from class java.lang.Object

构造方法详细信息

WebSocketFrameAggregator

方法详细信息

isStartMessage

isContentMessage

isLastContentMessage

isAggregated

isContentLengthInvalid

newContinueResponse

closeAfterContinueResponse

ignoreContentAfterContinueResponse

beginAggregation