Class BinaryMemcacheClientCodec

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.channel.CombinedChannelDuplexHandler<BinaryMemcacheResponseDecoder, BinaryMemcacheRequestEncoder>

io.netty.handler.codec.memcache.binary.BinaryMemcacheClientCodec

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

@UnstableApi
public final class BinaryMemcacheClientCodec
extends CombinedChannelDuplexHandler<BinaryMemcacheResponseDecoder, BinaryMemcacheRequestEncoder>

The client codec that combines the proper encoder and decoder.

Use this codec if you want to implement a memcache client that speaks the binary protocol. It combines both the BinaryMemcacheResponseDecoder and the BinaryMemcacheRequestEncoder.

Optionally, it counts the number of outstanding responses and raises an exception if - on connection close - the list is not 0 (this is turned off by default). You can also define a chunk size for the content, which defaults to 8192. This chunk size is the maximum, so if smaller chunks arrive they will be passed up the pipeline and not queued up to the chunk size.

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
BinaryMemcacheClientCodec()	Create a new BinaryMemcacheClientCodec with the default settings applied.
BinaryMemcacheClientCodec(int decodeChunkSize)	Create a new BinaryMemcacheClientCodec and set a custom chunk size.
BinaryMemcacheClientCodec(int decodeChunkSize, boolean failOnMissingResponse)	Create a new BinaryMemcacheClientCodec with custom settings.

Method Summary

Methods inherited from class CombinedChannelDuplexHandler

bind, channelActive, channelInactive, channelRead, channelReadComplete, channelRegistered, channelUnregistered, channelWritabilityChanged, close, connect, deregister, disconnect, exceptionCaught, flush, handlerAdded, handlerRemoved, inboundHandler, init, outboundHandler, read, removeInboundHandler, removeOutboundHandler, userEventTriggered, write

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	channelActive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelActive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelInactive(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelInactive() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRead(ChannelHandlerContext ctx, Object msg)	Calls ChannelHandlerContext.fireChannelRead(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelReadComplete(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelReadComplete() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelRegistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelRegistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelUnregistered(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelUnregistered() to forward to the next ChannelInboundHandler in the ChannelPipeline.
void	channelWritabilityChanged(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.fireChannelWritabilityChanged() to forward to the next ChannelInboundHandler 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	exceptionCaught(ChannelHandlerContext ctx, Throwable cause)	Calls ChannelHandlerContext.fireExceptionCaught(Throwable) to forward to the next ChannelHandler in the ChannelPipeline.
void	flush(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.flush() to forward to the next ChannelOutboundHandler in the ChannelPipeline.
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.
protected final BinaryMemcacheResponseDecoder	inboundHandler()
protected final void	init(BinaryMemcacheResponseDecoder inboundHandler, BinaryMemcacheRequestEncoder outboundHandler)	Initialized this handler with the specified handlers.
protected final BinaryMemcacheRequestEncoder	outboundHandler()
void	read(ChannelHandlerContext ctx)	Calls ChannelHandlerContext.read() to forward to the next ChannelOutboundHandler in the ChannelPipeline.
final void	removeInboundHandler()	Removes the ChannelInboundHandler that was combined in this CombinedChannelDuplexHandler.
final void	removeOutboundHandler()	Removes the ChannelOutboundHandler that was combined in this CombinedChannelDuplexHandler.
void	userEventTriggered(ChannelHandlerContext ctx, Object evt)	Calls ChannelHandlerContext.fireUserEventTriggered(Object) to forward to the next ChannelInboundHandler in the ChannelPipeline.
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 ChannelHandlerAdapter

ensureNotSharable, isSharable

Modifier and Type	Method	Description
protected void	ensureNotSharable()	Throws IllegalStateException if ChannelHandlerAdapter.isSharable() returns true
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

BinaryMemcacheClientCodec

public BinaryMemcacheClientCodec()

Create a new BinaryMemcacheClientCodec with the default settings applied.

BinaryMemcacheClientCodec

public BinaryMemcacheClientCodec(int decodeChunkSize)

Create a new BinaryMemcacheClientCodec and set a custom chunk size.

Parameters:

decodeChunkSize - the maximum chunk size.

BinaryMemcacheClientCodec

public BinaryMemcacheClientCodec(int decodeChunkSize,
 boolean failOnMissingResponse)

Create a new BinaryMemcacheClientCodec with custom settings.

Parameters:

decodeChunkSize - the maximum chunk size.

failOnMissingResponse - report if after close there are outstanding requests.