io.netty.handler.codec.memcache.binary

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 io.netty.channel.ChannelHandler

ChannelHandler.Sharable

Constructor Summary

Constructors

Constructor and 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 io.netty.channel.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

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

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.