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:

ChannelHandler, ChannelInboundHandler

Direct Known Subclasses:

BinaryMemcacheObjectAggregator

@UnstableApi
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

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractMemcacheObjectAggregator(int maxContentLength)

Method Summary

Modifier and Type	Method and Description
protected boolean	closeAfterContinueResponse(Object msg) Determine if the channel should be closed after the result of MessageAggregator.newContinueResponse(Object, int, ChannelPipeline) is written.
protected boolean	ignoreContentAfterContinueResponse(Object msg) Determine if all objects for the current request/response should be ignored or not.
protected boolean	isAggregated(MemcacheObject msg) Returns true if and only if the specified message is already aggregated.
protected boolean	isContentLengthInvalid(H start, int maxContentLength) Determine if the message start's content length is known, and if it greater than maxContentLength.
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, int maxContentLength, ChannelPipeline pipeline) Returns the 'continue response' for the specified start message if necessary.

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

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

isContentLengthInvalid

protected boolean isContentLengthInvalid(H start,
                                         int maxContentLength)

Description copied from class: MessageAggregator

Determine if the message start's content length is known, and if it greater than maxContentLength.

Specified by:

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

Parameters:

start - The message which may indicate the content length.

maxContentLength - The maximum allowed content length.

Returns:

true if the message start's content length is known, and if it greater than maxContentLength. false otherwise.

newContinueResponse

protected Object newContinueResponse(H start,
                                     int maxContentLength,
                                     ChannelPipeline pipeline)

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

closeAfterContinueResponse

protected boolean closeAfterContinueResponse(Object msg)
                                      throws Exception

Description copied from class: MessageAggregator

Determine if the channel should be closed after the result of MessageAggregator.newContinueResponse(Object, int, ChannelPipeline) is written.

Specified by:

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

Parameters:

msg - The return value from MessageAggregator.newContinueResponse(Object, int, ChannelPipeline).

Returns:

true if the channel should be closed after the result of MessageAggregator.newContinueResponse(Object, int, ChannelPipeline) is written. false otherwise.

Throws:

Exception

ignoreContentAfterContinueResponse

protected boolean ignoreContentAfterContinueResponse(Object msg)
                                              throws Exception

Description copied from class: MessageAggregator

Determine if all objects for the current request/response should be ignored or not. Messages will stop being ignored the next time MessageAggregator.isContentMessage(Object) returns true.

Specified by:

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

Parameters:

msg - The return value from MessageAggregator.newContinueResponse(Object, int, ChannelPipeline).

Returns:

true if all objects for the current request/response should be ignored or not. false otherwise.

Throws:

Exception