io.netty.handler.codec.memcache.binary

Class AbstractBinaryMemcacheDecoder<M extends BinaryMemcacheMessage<H>,H extends BinaryMemcacheMessageHeader>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.handler.codec.ByteToMessageDecoder

io.netty.handler.codec.memcache.AbstractMemcacheObjectDecoder

io.netty.handler.codec.memcache.binary.AbstractBinaryMemcacheDecoder<M,H>

All Implemented Interfaces:

ChannelHandler

Direct Known Subclasses:

BinaryMemcacheRequestDecoder, BinaryMemcacheResponseDecoder

public abstract class AbstractBinaryMemcacheDecoder<M extends BinaryMemcacheMessage<H>,H extends BinaryMemcacheMessageHeader>
extends AbstractMemcacheObjectDecoder

Decoder for both BinaryMemcacheRequest and BinaryMemcacheResponse.

The difference in the protocols (header) is implemented by the subclasses.

Nested Class Summary

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

ChannelHandler.Sharable, ChannelHandler.Skip

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MAX_CHUNK_SIZE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractBinaryMemcacheDecoder() Create a new AbstractBinaryMemcacheDecoder with default settings.
protected	AbstractBinaryMemcacheDecoder(int chunkSize) Create a new AbstractBinaryMemcacheDecoder with custom settings.

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract M	buildMessage(H header, ByteBuf extras, String key) Build the complete message, based on the information decoded.
void	channelInactive(ChannelHandlerContext ctx) When the channel goes inactive, release all frames to prevent data leaks.
protected void	decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) Decode the from one ByteBuf to an other.
protected abstract H	decodeHeader(ByteBuf in) Decode and return the parsed BinaryMemcacheMessageHeader.
protected void	resetDecoder() Prepare for next decoding iteration.

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

actualReadableBytes, callDecode, channelRead, channelReadComplete, decodeLast, handlerRemoved, handlerRemoved0, internalBuffer, isSingleDecode, setSingleDecode

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

bind, channelActive, channelRegistered, channelWritabilityChanged, close, connect, disconnect, exceptionCaught, flush, handlerAdded, isSharable, read, userEventTriggered, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_MAX_CHUNK_SIZE

public static final int DEFAULT_MAX_CHUNK_SIZE

See Also:

Constant Field Values

Constructor Detail

AbstractBinaryMemcacheDecoder

protected AbstractBinaryMemcacheDecoder()

Create a new AbstractBinaryMemcacheDecoder with default settings.

AbstractBinaryMemcacheDecoder

protected AbstractBinaryMemcacheDecoder(int chunkSize)

Create a new AbstractBinaryMemcacheDecoder with custom settings.

Parameters:

chunkSize - the maximum chunk size of the payload.

Method Detail

decode

protected void decode(ChannelHandlerContext ctx,
          ByteBuf in,
          List<Object> out)
               throws Exception

Description copied from class: ByteToMessageDecoder

Decode the from one ByteBuf to an other. This method will be called till either the input ByteBuf has nothing to read anymore, till nothing was read from the input ByteBuf or till this method returns null.

Specified by:

decode in class ByteToMessageDecoder

Parameters:

ctx - the ChannelHandlerContext which this ByteToMessageDecoder belongs to

in - the ByteBuf from which to read data

out - the List to which decoded messages should be added

Throws:

Exception - is thrown if an error accour

channelInactive

public void channelInactive(ChannelHandlerContext ctx)
                     throws Exception

When the channel goes inactive, release all frames to prevent data leaks.

Specified by:

channelInactive in interface ChannelHandler

Overrides:

channelInactive in class ByteToMessageDecoder

Parameters:

ctx - handler context

Throws:

Exception

resetDecoder

protected void resetDecoder()

Prepare for next decoding iteration.

decodeHeader

protected abstract H decodeHeader(ByteBuf in)

Decode and return the parsed BinaryMemcacheMessageHeader.

Parameters:

in - the incoming buffer.

Returns:

the decoded header.

buildMessage

protected abstract M buildMessage(H header,
             ByteBuf extras,
             String key)

Build the complete message, based on the information decoded.

Parameters:

header - the header of the message.

extras - possible extras.

key - possible key.

Returns:

the decoded message.