Class AbstractBinaryMemcacheEncoder<M extends BinaryMemcacheMessage>

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelOutboundHandlerAdapter

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

io.netty.handler.codec.memcache.AbstractMemcacheObjectEncoder<M>

io.netty.handler.codec.memcache.binary.AbstractBinaryMemcacheEncoder<M>

All Implemented Interfaces:

ChannelHandler, ChannelOutboundHandler

Direct Known Subclasses:

BinaryMemcacheRequestEncoder, BinaryMemcacheResponseEncoder

@UnstableApi
public abstract class AbstractBinaryMemcacheEncoder<M extends BinaryMemcacheMessage>
extends AbstractMemcacheObjectEncoder<M>

A MessageToByteEncoder that encodes binary memcache messages into bytes.

Nested Class Summary

Nested classes/interfaces inherited from interface ChannelHandler

ChannelHandler.Sharable

Modifier and Type	Interface	Description
static @interface	ChannelHandler.Sharable	Indicates that the same instance of the annotated ChannelHandler can be added to one or more ChannelPipelines multiple times without a race condition.

Constructor Summary

Constructors

Constructor	Description
AbstractBinaryMemcacheEncoder()

Method Summary

Modifier and Type	Method	Description
protected abstract void	encodeHeader(ByteBuf buf, M msg)	Encode the header.
protected ByteBuf	encodeMessage(ChannelHandlerContext ctx, M msg)	Take the given MemcacheMessage and encode it into a writable ByteBuf.

Methods inherited from class AbstractMemcacheObjectEncoder

acceptOutboundMessage, encode

Modifier and Type	Method	Description
boolean	acceptOutboundMessage(Object msg)	Returns true if the given message should be handled.
protected void	encode(ChannelHandlerContext ctx, Object msg, List<Object> out)	Encode from one message to an other.

Methods inherited from class MessageToMessageEncoder

write

Modifier and Type	Method	Description
void	write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise)	Calls ChannelOutboundInvoker.write(Object, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.

Methods inherited from class ChannelOutboundHandlerAdapter

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

Modifier and Type	Method	Description
void	bind(ChannelHandlerContext ctx, SocketAddress localAddress, ChannelPromise promise)	Calls ChannelOutboundInvoker.bind(SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	close(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.close(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	connect(ChannelHandlerContext ctx, SocketAddress remoteAddress, SocketAddress localAddress, ChannelPromise promise)	Calls ChannelOutboundInvoker.connect(SocketAddress, SocketAddress, ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	deregister(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.deregister(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	disconnect(ChannelHandlerContext ctx, ChannelPromise promise)	Calls ChannelOutboundInvoker.disconnect(ChannelPromise) to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	flush(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.flush() to forward to the next ChannelOutboundHandler in the ChannelPipeline.
void	read(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.read() to forward to the next ChannelOutboundHandler in the ChannelPipeline.

Methods inherited from class ChannelHandlerAdapter

ensureNotSharable, exceptionCaught, handlerAdded, handlerRemoved, isSharable

Modifier and Type	Method	Description
protected void	ensureNotSharable()	Throws IllegalStateException if ChannelHandlerAdapter.isSharable() returns true
void	exceptionCaught(ChannelHandlerContext ctx, Throwable cause)	Deprecated. is part of ChannelInboundHandler
void	handlerAdded(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
void	handlerRemoved(ChannelHandlerContext ctx)	Do nothing by default, sub-classes may override this method.
boolean	isSharable()	Return true if the implementation is ChannelHandler.Sharable and so can be added to different ChannelPipelines.

Methods inherited from class Object

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

Constructor Details

AbstractBinaryMemcacheEncoder

public AbstractBinaryMemcacheEncoder()

Method Details

encodeMessage

protected ByteBuf encodeMessage(ChannelHandlerContext ctx,
 M msg)

Description copied from class: AbstractMemcacheObjectEncoder

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

Specified by:

encodeMessage in class AbstractMemcacheObjectEncoder<M extends BinaryMemcacheMessage>

Parameters:

ctx - the channel handler context.

msg - the message to encode.

Returns:

the ByteBuf representation of the message.

encodeHeader

protected abstract void encodeHeader(ByteBuf buf,
 M msg)

Encode the header.

This methods needs to be implemented by a sub class because the header is different for both requests and responses.

Parameters:

buf - the ByteBuf to write into.

msg - the message to encode.