io.netty.handler.codec.memcache

Class AbstractMemcacheObjectAggregator<H extends MemcacheMessage>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

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

Direct Known Subclasses:

BinaryMemcacheObjectAggregator

public abstract class AbstractMemcacheObjectAggregator<H extends MemcacheMessage>
extends 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

ChannelHandler.Sharable, ChannelHandler.Skip

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMemcacheObjectAggregator(int maxContentLength)

Method Summary

Methods

Modifier and Type	Method and Description
protected long	contentLength(H start) Retrieves the length of the whole content from the specified start message.
protected boolean	hasContentLength(H start) Returns true if and only if the specified start message already contains the information about the length of the whole content.
protected boolean	isAggregated(MemcacheObject msg) Returns true if and only if the specified message is already aggregated.
protected boolean	isContentMessage(MemcacheObject msg) Returns true if and only if the specified message is a content message.
protected boolean	isLastContentMessage(MemcacheContent msg) Returns true if and only if the specified message is the last content message.
protected Object	newContinueResponse(H start) Returns the 'continue response' for the specified start message if necessary.

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

acceptInboundMessage, aggregate, beginAggregation, channelInactive, 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.ChannelHandlerAdapter

bind, channelActive, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, exceptionCaught, flush, isSharable, read, userEventTriggered, write

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

Description copied from class: 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;
 

Specified by:

isContentMessage in class MessageAggregator<MemcacheObject,H extends MemcacheMessage,MemcacheContent,FullMemcacheMessage>

Throws:

Exception

isLastContentMessage

protected boolean isLastContentMessage(MemcacheContent msg)
                                throws Exception

Description copied from class: 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();
 

Specified by:

isLastContentMessage in class MessageAggregator<MemcacheObject,H extends MemcacheMessage,MemcacheContent,FullMemcacheMessage>

Throws:

Exception

isAggregated

protected boolean isAggregated(MemcacheObject msg)
                        throws Exception

Description copied from class: 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.

Specified by:

isAggregated in class MessageAggregator<MemcacheObject,H extends MemcacheMessage,MemcacheContent,FullMemcacheMessage>

Throws:

Exception

hasContentLength

protected boolean hasContentLength(H start)
                            throws Exception

Description copied from class: MessageAggregator

Returns true if and only if the specified start message already contains the information about the length of the whole content.

Specified by:

hasContentLength in class MessageAggregator<MemcacheObject,H extends MemcacheMessage,MemcacheContent,FullMemcacheMessage>

Throws:

Exception

contentLength

protected long contentLength(H start)
                      throws Exception

Description copied from class: MessageAggregator

Retrieves the length of the whole content from the specified start message. This method is invoked only when MessageAggregator.hasContentLength(Object) returned true.

Specified by:

contentLength in class MessageAggregator<MemcacheObject,H extends MemcacheMessage,MemcacheContent,FullMemcacheMessage>

Throws:

Exception

newContinueResponse

protected Object newContinueResponse(H start)
                              throws Exception

Description copied from class: 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.

Specified by:

newContinueResponse in class MessageAggregator<MemcacheObject,H extends MemcacheMessage,MemcacheContent,FullMemcacheMessage>

Returns:

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

Throws:

Exception