MessageAggregator (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<I,S,C,O>

参数类型

I - 涵盖开始消息和内容消息的类型

S - 开始消息的类型

C - 内容消息的类型（必须是ByteBufHolder的子类型）

O - 聚合消息的类型（必须是S和ByteBufHolder的子类型）

All Implemented Interfaces:

ChannelHandler ， ChannelInboundHandler

已知直接子类：

AbstractMemcacheObjectAggregator ， HttpObjectAggregator ， RedisBulkStringAggregator ， StompSubframeAggregator ， WebSocketFrameAggregator
```
public abstract class MessageAggregator<I,S,C extends ByteBufHolder,O extends ByteBufHolder>
extends MessageToMessageDecoder<I>
```
摘要ChannelHandler将一系列消息对象聚合为单个聚合消息。
“一系列消息”由以下内容组成：
- 包含内容的第一部分的单个开始消息，以及
- 1个或更多内容消息。
聚合消息的内容将是开始消息及其后续内容消息的合并内容。如果此聚合器遇到isLastContentMessage(ByteBufHolder)返回true的内容消息，则聚合器将完成聚合并生成聚合消息并期望发送另一个启动消息。

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

构造方法摘要

构造方法
Modifier	Constructor and Description
`protected`	`MessageAggregator(int maxContentLength)` 创建一个新的实例。
`protected`	`MessageAggregator(int maxContentLength, java.lang.Class<? extends I> inboundMessageType)`

方法摘要

所有方法接口方法抽象方法具体的方法弃用的方法
Modifier and Type	Method and Description
`boolean`	`acceptInboundMessage(java.lang.Object msg)` 如果应该处理给定的消息，则返回 `true` 。
`protected void`	`aggregate(O aggregated, C content)` 将指定内容消息提供的信息传输到指定的聚合消息。
`protected abstract O`	`beginAggregation(S start, ByteBuf content)` 根据指定的开始消息和指定的内容创建新的聚合消息。
`void`	`channelInactive(ChannelHandlerContext ctx)` 请致电`ChannelHandlerContext.fireChannelInactive()`转发至`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`void`	`channelReadComplete(ChannelHandlerContext ctx)` 致电`ChannelHandlerContext.fireChannelReadComplete()`转发至`ChannelPipeline`中的下一个`ChannelInboundHandler` 。
`protected abstract boolean`	`closeAfterContinueResponse(java.lang.Object msg)` 确定 `newContinueResponse(Object, int, ChannelPipeline)`的结果写入后是否应关闭通道。
`protected ChannelHandlerContext`	`ctx()`
`protected void`	`decode(ChannelHandlerContext ctx, I msg, java.util.List<java.lang.Object> out)` 从一条消息解码到另一条消息。
`protected void`	`finishAggregation(O aggregated)` 当指定的 `aggregated`消息即将传递给管道中的下一个处理程序时调用。
`protected void`	`handleOversizedMessage(ChannelHandlerContext ctx, S oversized)` 当传入请求超过最大内容长度时调用。
`void`	`handlerAdded(ChannelHandlerContext ctx)` 子类可以忽略这个方法。
`void`	`handlerRemoved(ChannelHandlerContext ctx)` 子类可以忽略这个方法。
`protected abstract boolean`	`ignoreContentAfterContinueResponse(java.lang.Object msg)` 确定当前请求/响应的所有对象是否应该被忽略。
`protected abstract boolean`	`isAggregated(I msg)` 当且仅当指定的消息已经被聚合时才返回 `true` 。
`protected abstract boolean`	`isContentLengthInvalid(S start, int maxContentLength)` 确定消息 `start`的内容长度是否已知，并且是否大于 `maxContentLength` 。
`protected abstract boolean`	`isContentMessage(I msg)` 当且仅当指定的消息是内容消息时才返回 `true` 。
`boolean`	`isHandlingOversizedMessage()` 已过时。将来的发行版中将删除此方法。
`protected abstract boolean`	`isLastContentMessage(C msg)` 当且仅当指定的消息是最后一个内容消息时才返回 `true` 。
`protected abstract boolean`	`isStartMessage(I msg)` 当且仅当指定的消息是开始消息时返回 `true` 。
`int`	`maxContentLength()` 以字节为单位返回聚合消息的最大允许长度。
`int`	`maxCumulationBufferComponents()` 返回累积缓冲区中的最大组件数。
`protected abstract java.lang.Object`	`newContinueResponse(S start, int maxContentLength, ChannelPipeline pipeline)` 如有必要，返回指定开始消息的'continue response'。
`void`	`setMaxCumulationBufferComponents(int maxCumulationBufferComponents)` 设置累积缓冲区中的最大组件数量。

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

- 构造方法详细信息
  - MessageAggregator
```
protected MessageAggregator(int maxContentLength)
```
    创建一个新的实例。
    
    参数
    
    maxContentLength - 聚合内容的最大长度。如果聚合内容的长度超过此值，则会调用handleOversizedMessage(ChannelHandlerContext, Object) 。
  - MessageAggregator
```
protected MessageAggregator(int maxContentLength,
                            java.lang.Class<? extends I> inboundMessageType)
```
- 方法详细信息
  - acceptInboundMessage
```
public boolean acceptInboundMessage(java.lang.Object msg)
                             throws java.lang.Exception
```
    从类复制的描述： MessageToMessageDecoder
    
    如果应该处理给定的消息，则返回true 。如果false它将被传递到ChannelPipeline中的下一个ChannelInboundHandler 。
    
    重写：
    
    acceptInboundMessage在课程 MessageToMessageDecoder<I>
    
    异常
    
    java.lang.Exception
  - isStartMessage
```
protected abstract boolean isStartMessage(I msg)
                                   throws java.lang.Exception
```
    当且仅当指定的消息是开始消息时返回true 。通常情况下，此方法作为return单个语句与instanceof一起instanceof ：
```
  return msg instanceof MyStartMessage; 
```
    异常
    
    java.lang.Exception
  - isContentMessage
```
protected abstract boolean isContentMessage(I msg)
                                     throws java.lang.Exception
```
    当且仅当指定的消息是内容消息时才返回true 。通常情况下，此方法是作为return单个return语句instanceof ：
```
  return msg instanceof MyContentMessage; 
```
    异常
    
    java.lang.Exception
  - isLastContentMessage
```
protected abstract boolean isLastContentMessage(C msg)
                                         throws java.lang.Exception
```
    当且仅当指定的消息是最后一个内容消息时返回true 。通常情况下，此方法是作为return单个语句与instanceof ：
```
  return msg instanceof MyLastContentMessage; 
```
    或用instanceof和布尔型字段检查：
```
  return msg instanceof MyContentMessage && msg.isLastFragment(); 
```
    异常
    
    java.lang.Exception
  - isAggregated
```
protected abstract boolean isAggregated(I msg)
                                 throws java.lang.Exception
```
    当且仅当指定的消息已经聚合时才返回true 。如果此方法返回true ，则此处理程序将仅将消息按true转发给下一个处理程序。
    
    异常
    
    java.lang.Exception
  - maxContentLength
```
public final int maxContentLength()
```
    以字节为单位返回聚合消息的最大允许长度。
  - maxCumulationBufferComponents
```
public final int maxCumulationBufferComponents()
```
    返回累积缓冲区中的最大组件数。如果累积缓冲区中组件的数量超过此值，则累积缓冲区的组件将合并到一个涉及内存副本的组件中。此属性的默认值是。
  - setMaxCumulationBufferComponents
```
public final void setMaxCumulationBufferComponents(int maxCumulationBufferComponents)
```
    设置累积缓冲区中的最大组件数量。如果累积缓冲区中组件的数量超过此值，则累积缓冲区的组件将合并到一个涉及内存副本的组件中。此属性的默认值为，其最小允许值为2 。
  - isHandlingOversizedMessage
```
@Deprecated
public final boolean isHandlingOversizedMessage()
```
    已过时。将来的发行版中将删除此方法。
  - ctx
```
protected final ChannelHandlerContext ctx()
```
  - decode
```
protected void decode(ChannelHandlerContext ctx,
                      I msg,
                      java.util.List<java.lang.Object> out)
               throws java.lang.Exception
```
    从类复制的描述： MessageToMessageDecoder
    
    从一条消息解码到另一条消息。这个方法将被编码器处理的每个书面信息调用。
    
    Specified by:
    
    decode在课程 MessageToMessageDecoder<I>
    
    参数
    
    ctx - 这是MessageToMessageDecoder所属的ChannelHandlerContext
    
    msg - 解码到另一个的消息
    
    out - 应该添加解码消息的 List
    
    异常
    
    java.lang.Exception - 如果发生错误则抛出
  - isContentLengthInvalid
```
protected abstract boolean isContentLengthInvalid(S start,
                                                  int maxContentLength)
                                           throws java.lang.Exception
```
    确定消息 start的内容长度是否已知，以及是否大于 maxContentLength 。
    
    参数
    
    start - 可能指示内容长度的消息。
    
    maxContentLength - 允许的最大内容长度。
    
    结果
    
    true如果消息start的内容长度已知，并且它大于maxContentLength 。否则为false 。
    
    异常
    
    java.lang.Exception
  - newContinueResponse
```
protected abstract java.lang.Object newContinueResponse(S start,
                                                        int maxContentLength,
                                                        ChannelPipeline pipeline)
                                                 throws java.lang.Exception
```
    如有必要，返回指定开始消息的'continue response'。例如，这个方法对于处理一个HTTP 100-continue头是很有用的。
    
    结果
    
    '继续回复'，或者 null如果没有消息要发送
    
    异常
    
    java.lang.Exception
  - closeAfterContinueResponse
```
protected abstract boolean closeAfterContinueResponse(java.lang.Object msg)
                                               throws java.lang.Exception
```
    确定 newContinueResponse(Object, int, ChannelPipeline)的结果写入后是否关闭通道。
    
    参数
    
    msg -从返回值 newContinueResponse(Object, int, ChannelPipeline) 。
    
    结果
    
    true如果在写入newContinueResponse(Object, int, ChannelPipeline)的结果后应该关闭通道。否则为false 。
    
    异常
    
    java.lang.Exception
  - ignoreContentAfterContinueResponse
```
protected abstract boolean ignoreContentAfterContinueResponse(java.lang.Object msg)
                                                       throws java.lang.Exception
```
    确定当前请求/响应的所有对象是否应该被忽略。下次isContentMessage(Object)返回true时，消息将不再被忽略。
    
    参数
    
    msg - 来自 newContinueResponse(Object, int, ChannelPipeline)的返回值。
    
    结果
    
    true如果当前请求/响应的所有对象都应该被忽略。否则为false 。
    
    异常
    
    java.lang.Exception
  - beginAggregation
```
protected abstract O beginAggregation(S start,
                                      ByteBuf content)
                               throws java.lang.Exception
```
    根据指定的开始消息和指定的内容创建新的聚合消息。如果启动消息实现ByteBufHolder ，则其内容将附加到指定的content 。此聚合器将继续将收到的内容追加到指定的content 。
    
    异常
    
    java.lang.Exception
  - aggregate
```
protected void aggregate(O aggregated,
                         C content)
                  throws java.lang.Exception
```
    将指定内容消息提供的信息传输到指定的聚合消息。请注意，指定内容消息的内容已被添加到指定聚合消息的内容中，因此您不需要。使用此方法将内容消息提供的附加信息传输至aggregated 。
    
    异常
    
    java.lang.Exception
  - finishAggregation
```
protected void finishAggregation(O aggregated)
                          throws java.lang.Exception
```
    当指定的 aggregated消息即将传递给管道中的下一个处理程序时调用。
    
    异常
    
    java.lang.Exception
  - handleOversizedMessage
```
protected void handleOversizedMessage(ChannelHandlerContext ctx,
                                      S oversized)
                               throws java.lang.Exception
```
    当传入请求超过最大内容长度时调用。默认behvaior是触发exceptionCaught()事件与TooLongFrameException 。
    
    参数
    
    ctx - ChannelHandlerContext
    
    oversized - oversized累计的信息，其类型为 S或 O
    
    异常
    
    java.lang.Exception
  - channelReadComplete
```
public void channelReadComplete(ChannelHandlerContext ctx)
                         throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelReadComplete()转发至ChannelInboundHandler中的ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelReadComplete在界面 ChannelInboundHandler
    
    重写：
    
    channelReadComplete在课程 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - channelInactive
```
public void channelInactive(ChannelHandlerContext ctx)
                     throws java.lang.Exception
```
    从类复制的描述： ChannelInboundHandlerAdapter
    
    致电ChannelHandlerContext.fireChannelInactive()转发至ChannelPipeline中的下一个ChannelInboundHandler 。子类可以重写此方法来更改行为。
    
    Specified by:
    
    channelInactive在界面 ChannelInboundHandler
    
    重写：
    
    channelInactive在课程 ChannelInboundHandlerAdapter
    
    异常
    
    java.lang.Exception
  - handlerAdded
```
public void handlerAdded(ChannelHandlerContext ctx)
                  throws java.lang.Exception
```
    从类复制的描述： ChannelHandlerAdapter
    
    子类可以忽略这个方法。
    
    Specified by:
    
    handlerAdded在界面 ChannelHandler
    
    重写：
    
    handlerAdded在课程 ChannelHandlerAdapter
    
    异常
    
    java.lang.Exception
  - handlerRemoved
```
public void handlerRemoved(ChannelHandlerContext ctx)
                    throws java.lang.Exception
```
    从类复制的描述： ChannelHandlerAdapter
    
    子类可以忽略这个方法。
    
    Specified by:
    
    handlerRemoved ，界面 ChannelHandler
    
    重写：
    
    handlerRemoved在课程 ChannelHandlerAdapter
    
    异常
    
    java.lang.Exception

Class MessageAggregator<I,S,C extends ByteBufHolder,O extends ByteBufHolder>

Nested Class Summary

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

构造方法摘要

方法摘要

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

构造方法详细信息

MessageAggregator

MessageAggregator

方法详细信息

acceptInboundMessage

isStartMessage

isContentMessage

isLastContentMessage

isAggregated

maxContentLength

maxCumulationBufferComponents

setMaxCumulationBufferComponents

isHandlingOversizedMessage

ctx

decode

isContentLengthInvalid

newContinueResponse

closeAfterContinueResponse

ignoreContentAfterContinueResponse

beginAggregation

aggregate

finishAggregation

handleOversizedMessage

channelReadComplete

channelInactive

handlerAdded

handlerRemoved