com.couchbase.client.deps.io.netty.handler.codec.memcache

Class AbstractMemcacheObjectEncoder<M extends MemcacheMessage>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

io.netty.handler.codec.MessageToMessageEncoder<Object>

com.couchbase.client.deps.io.netty.handler.codec.memcache.AbstractMemcacheObjectEncoder<M>

All Implemented Interfaces:

ChannelHandler, ChannelOutboundHandler

Direct Known Subclasses:

AbstractBinaryMemcacheEncoder

public abstract class AbstractMemcacheObjectEncoder<M extends MemcacheMessage>
extends MessageToMessageEncoder<Object>

A general purpose AbstractMemcacheObjectEncoder that encodes MemcacheMessages.

Note that this class is designed to be extended, especially because both the binary and ascii protocol require different treatment of their messages. Since the content chunk writing is the same for both, the encoder abstracts this right away.

Nested Class Summary

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

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and Description
AbstractMemcacheObjectEncoder()

Method Summary

Modifier and Type	Method and Description
boolean	acceptOutboundMessage(Object msg)
protected void	encode(ChannelHandlerContext ctx, Object msg, List<Object> out)
protected abstract ByteBuf	encodeMessage(ChannelHandlerContext ctx, M msg) Take the given MemcacheMessage and encode it into a writable ByteBuf.

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

write

Methods inherited from class io.netty.channel.ChannelOutboundHandlerAdapter

bind, close, connect, deregister, disconnect, flush, read

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

exceptionCaught, handlerAdded, handlerRemoved, isSharable

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.netty.channel.ChannelHandler

exceptionCaught, handlerAdded, handlerRemoved

Constructor Detail

AbstractMemcacheObjectEncoder

public AbstractMemcacheObjectEncoder()

Method Detail

encode

protected void encode(ChannelHandlerContext ctx,
                      Object msg,
                      List<Object> out)
               throws Exception

Specified by:

encode in class MessageToMessageEncoder<Object>

Throws:

Exception

acceptOutboundMessage

public boolean acceptOutboundMessage(Object msg)
                              throws Exception

Overrides:

acceptOutboundMessage in class MessageToMessageEncoder<Object>

Throws:

Exception

encodeMessage

protected abstract ByteBuf encodeMessage(ChannelHandlerContext ctx,
                                         M msg)

Take the given MemcacheMessage and encode it into a writable ByteBuf.

Parameters:

ctx - the channel handler context.

msg - the message to encode.

Returns:

the ByteBuf representation of the message.