Package io.netty.handler.codec.memcache

Class AbstractMemcacheObjectAggregator<H extends MemcacheMessage>

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:

io.netty.channel.ChannelHandler, io.netty.channel.ChannelInboundHandler

Direct Known Subclasses:

BinaryMemcacheObjectAggregator

@UnstableApi
public abstract class AbstractMemcacheObjectAggregator<H extends MemcacheMessage>
extends io.netty.handler.codec.MessageAggregator<MemcacheObject,H,MemcacheContent,FullMemcacheMessage>

A ChannelHandler that aggregates an MemcacheMessage and its following MemcacheContents into a single MemcacheMessage with no following MemcacheContents. It is useful when you don't want to take care of memcache messages where the content comes along in chunks. Insert this handler after a AbstractMemcacheObjectDecoder in the ChannelPipeline.

For example, here for the binary protocol:

 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

io.netty.channel.ChannelHandler.Sharable

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractMemcacheObjectAggregator(int maxContentLength)

Method Summary

Modifier and Type	Method	Description
protected boolean	closeAfterContinueResponse(Object msg)
protected boolean	ignoreContentAfterContinueResponse(Object msg)
protected boolean	isAggregated(MemcacheObject msg)
protected boolean	isContentLengthInvalid(H start, int maxContentLength)
protected boolean	isContentMessage(MemcacheObject msg)
protected boolean	isLastContentMessage(MemcacheContent msg)
protected Object	newContinueResponse(H start, int maxContentLength, io.netty.channel.ChannelPipeline pipeline)

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

acceptInboundMessage, aggregate, beginAggregation, channelInactive, channelReadComplete, ctx, decode, finishAggregation, handleOversizedMessage, handlerAdded, handlerRemoved, isHandlingOversizedMessage, isStartMessage, maxContentLength, maxCumulationBufferComponents, releaseCurrentMessage, 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

Constructor Detail

AbstractMemcacheObjectAggregator

protected AbstractMemcacheObjectAggregator(int maxContentLength)

Method Detail

isContentMessage

protected boolean isContentMessage(MemcacheObject msg)
                            throws Exception

Specified by:

isContentMessage in class io.netty.handler.codec.MessageAggregator<MemcacheObject,H extends MemcacheMessage,MemcacheContent,FullMemcacheMessage>

Throws:

Exception

isLastContentMessage

protected boolean isLastContentMessage(MemcacheContent msg)
                                throws Exception

Specified by:

isLastContentMessage in class io.netty.handler.codec.MessageAggregator<MemcacheObject,H extends MemcacheMessage,MemcacheContent,FullMemcacheMessage>

Throws:

Exception

isAggregated

protected boolean isAggregated(MemcacheObject msg)
                        throws Exception

Specified by:

isAggregated in class io.netty.handler.codec.MessageAggregator<MemcacheObject,H extends MemcacheMessage,MemcacheContent,FullMemcacheMessage>

Throws:

Exception

isContentLengthInvalid

protected boolean isContentLengthInvalid(H start,
                                         int maxContentLength)

Specified by:

isContentLengthInvalid in class io.netty.handler.codec.MessageAggregator<MemcacheObject,H extends MemcacheMessage,MemcacheContent,FullMemcacheMessage>

newContinueResponse

protected Object newContinueResponse(H start,
                                     int maxContentLength,
                                     io.netty.channel.ChannelPipeline pipeline)

Specified by:

newContinueResponse in class io.netty.handler.codec.MessageAggregator<MemcacheObject,H extends MemcacheMessage,MemcacheContent,FullMemcacheMessage>

closeAfterContinueResponse

protected boolean closeAfterContinueResponse(Object msg)
                                      throws Exception

Specified by:

closeAfterContinueResponse in class io.netty.handler.codec.MessageAggregator<MemcacheObject,H extends MemcacheMessage,MemcacheContent,FullMemcacheMessage>

Throws:

Exception

ignoreContentAfterContinueResponse

protected boolean ignoreContentAfterContinueResponse(Object msg)
                                              throws Exception

Specified by:

ignoreContentAfterContinueResponse in class io.netty.handler.codec.MessageAggregator<MemcacheObject,H extends MemcacheMessage,MemcacheContent,FullMemcacheMessage>

Throws:

Exception