AbstractMemcacheObjectAggregator (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<MemcacheObject,H,MemcacheContent,FullMemcacheMessage>
      - io.netty.handler.codec.memcache.AbstractMemcacheObjectAggregator<H>

All Implemented Interfaces:: ChannelHandler ， ChannelInboundHandler

已知直接子类：: BinaryMemcacheObjectAggregator

@UnstableApi
public abstract class AbstractMemcacheObjectAggregator<H extends MemcacheMessage>
extends MessageAggregator<MemcacheObject,H,MemcacheContent,FullMemcacheMessage>

A ChannelHandler ，将MemcacheMessage及其随后的MemcacheContent合并为一个MemcacheMessage ，但没有MemcacheContent 。当您不想处理内容以块形式出现的memcache消息时，它非常有用。将该处理程序插入ChannelPipeline中的AbstractMemcacheObjectDecoder之后。

例如，这里是二进制协议：

  ChannelPipeline p = ...;
 ...
 p.addLast("decoder", new BinaryMemcacheRequestDecoder());
 p.addLast("aggregator", new BinaryMemcacheObjectAggregator(1048576) );
 ...
 p.addLast("encoder", new BinaryMemcacheResponseEncoder());
 p.addLast("handler", new YourMemcacheRequestHandler());

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

构造方法摘要

构造方法
Modifier	Constructor and Description
`protected`	`AbstractMemcacheObjectAggregator(int maxContentLength)`

方法摘要

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

Methods inherited from class io.netty.handler.codec.MessageAggregator
acceptInboundMessage, aggregate, beginAggregation, channelInactive, channelReadComplete, ctx, decode, finishAggregation, handleOversizedMessage, handlerAdded, handlerRemoved, isHandlingOversizedMessage, isStartMessage, 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

- 构造方法详细信息
  - AbstractMemcacheObjectAggregator
```
protected AbstractMemcacheObjectAggregator(int maxContentLength)
```
- 方法详细信息
  - isContentMessage
```
protected boolean isContentMessage(MemcacheObject msg)
                            throws java.lang.Exception
```
    从类复制的描述： MessageAggregator
    当且仅当指定的消息是内容消息时返回true 。通常情况下，此方法作为return声明与instanceof ：
```
  return msg instanceof MyContentMessage; 
```
    Specified by:
    
    isContentMessage在课程 MessageAggregator<MemcacheObject,H extends MemcacheMessage,MemcacheContent,FullMemcacheMessage>
    
    异常
    
    java.lang.Exception
  - isLastContentMessage
```
protected boolean isLastContentMessage(MemcacheContent msg)
                                throws java.lang.Exception
```
    从类复制的描述： MessageAggregator
    当且仅当指定的消息是最后一个内容消息时才返回true 。通常情况下，此方法以return声明与instanceof ：
```
  return msg instanceof MyLastContentMessage; 
```
    或与instanceof和布尔字段检查：
```
  return msg instanceof MyContentMessage && msg.isLastFragment(); 
```
    Specified by:
    
    isLastContentMessage在课程 MessageAggregator<MemcacheObject,H extends MemcacheMessage,MemcacheContent,FullMemcacheMessage>
    
    异常
    
    java.lang.Exception
  - isAggregated
```
protected boolean isAggregated(MemcacheObject msg)
                        throws java.lang.Exception
```
    从类复制的描述： MessageAggregator
    
    当且仅当指定的消息已经聚合时返回true 。如果此方法返回true ，则此处理程序将仅将消息按true转发给下一个处理程序。
    
    Specified by:
    
    isAggregated在课程 MessageAggregator<MemcacheObject,H extends MemcacheMessage,MemcacheContent,FullMemcacheMessage>
    
    异常
    
    java.lang.Exception
  - isContentLengthInvalid
```
protected boolean isContentLengthInvalid(H start,
                                         int maxContentLength)
```
    从类复制的描述： MessageAggregator
    
    确定消息 start的内容长度是否已知，并且是否大于 maxContentLength 。
    
    Specified by:
    
    isContentLengthInvalid在课程 MessageAggregator<MemcacheObject,H extends MemcacheMessage,MemcacheContent,FullMemcacheMessage>
    
    参数
    
    start - 可能指示内容长度的消息。
    
    maxContentLength - 允许的最大内容长度。
    
    结果
    
    true如果消息start的内容长度已知，并且它大于maxContentLength 。否则为false 。
  - newContinueResponse
```
protected java.lang.Object newContinueResponse(H start,
                                               int maxContentLength,
                                               ChannelPipeline pipeline)
```
    从类复制的描述： MessageAggregator
    
    如有必要，返回指定开始消息的'continue response'。例如，这个方法对于处理一个HTTP 100-continue头是很有用的。
    
    Specified by:
    
    newContinueResponse在课程 MessageAggregator<MemcacheObject,H extends MemcacheMessage,MemcacheContent,FullMemcacheMessage>
    
    结果
    
    '继续回复'，或者如果没有要发送的消息，则 null
  - closeAfterContinueResponse
```
protected boolean closeAfterContinueResponse(java.lang.Object msg)
                                      throws java.lang.Exception
```
    从类复制的描述： MessageAggregator
    
    确定在写入 MessageAggregator.newContinueResponse(Object, int, ChannelPipeline)的结果后是否应关闭通道。
    
    Specified by:
    
    closeAfterContinueResponse在课程 MessageAggregator<MemcacheObject,H extends MemcacheMessage,MemcacheContent,FullMemcacheMessage>
    
    参数
    
    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<MemcacheObject,H extends MemcacheMessage,MemcacheContent,FullMemcacheMessage>
    
    参数
    
    msg -从返回值 MessageAggregator.newContinueResponse(Object, int, ChannelPipeline) 。
    
    结果
    
    true如果当前请求/响应的所有对象都应该被忽略。否则为false 。
    
    异常
    
    java.lang.Exception

Class AbstractMemcacheObjectAggregator<H extends MemcacheMessage>

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

构造方法详细信息

AbstractMemcacheObjectAggregator

方法详细信息

isContentMessage

isLastContentMessage

isAggregated

isContentLengthInvalid

newContinueResponse

closeAfterContinueResponse

ignoreContentAfterContinueResponse