com.couchbase.client.core.endpoint.dcp

Class DCPHandler

java.lang.Object

io.netty.channel.ChannelHandlerAdapter

io.netty.channel.ChannelInboundHandlerAdapter

io.netty.channel.ChannelDuplexHandler

io.netty.handler.codec.MessageToMessageCodec<RESPONSE,REQUEST>

com.couchbase.client.core.endpoint.AbstractGenericHandler<FullBinaryMemcacheResponse,BinaryMemcacheRequest,DCPRequest>

com.couchbase.client.core.endpoint.dcp.DCPHandler

All Implemented Interfaces:

ChannelHandler, ChannelInboundHandler, ChannelOutboundHandler

public class DCPHandler
extends AbstractGenericHandler<FullBinaryMemcacheResponse,BinaryMemcacheRequest,DCPRequest>

Since:

1.1.0

Author:

Sergey Avseyev

Nested Class Summary

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

ChannelHandler.Sharable

Field Summary

Fields

Modifier and Type	Field and Description
static byte	OP_BUFFER_ACK
static byte	OP_CONTROL
static byte	OP_GET_FAILOVER_LOG
static byte	OP_MUTATION
static byte	OP_OPEN_CONNECTION
static byte	OP_REMOVE
static byte	OP_SNAPSHOT_MARKER
static byte	OP_STREAM_END
static byte	OP_STREAM_REQUEST

Fields inherited from class com.couchbase.client.core.endpoint.AbstractGenericHandler

CHARSET

Constructor Summary

Constructors

Constructor and Description
DCPHandler(AbstractEndpoint endpoint, com.lmax.disruptor.EventSink<ResponseEvent> responseBuffer, boolean isTransient) Creates a new DCPHandler with the default queue for requests.
DCPHandler(AbstractEndpoint endpoint, com.lmax.disruptor.EventSink<ResponseEvent> responseBuffer, Queue<DCPRequest> queue, boolean isTransient) Creates a new DCPHandler with a custom queue for requests (suitable for tests).

Method Summary

Modifier and Type	Method and Description
protected CouchbaseResponse	decodeResponse(ChannelHandlerContext ctx, FullBinaryMemcacheResponse msg) Decodes the incoming response and transforms it into a CouchbaseResponse.
protected BinaryMemcacheRequest	encodeRequest(ChannelHandlerContext ctx, DCPRequest msg) Encode the outgoing request and return it in encoded format.
void	handlerRemoved(ChannelHandlerContext ctx)
protected ServiceType	serviceType() Returns the ServiceType associated with this handler.

Methods inherited from class com.couchbase.client.core.endpoint.AbstractGenericHandler

channelActive, channelInactive, channelWritabilityChanged, connect, createKeepAliveRequest, currentRequest, currentRequest, decode, encode, endpoint, env, exceptionCaught, finishedDecoding, logIdent, onKeepAliveFired, onKeepAliveResponse, publishResponse, remoteHostname, sideEffectRequestToCancel, userEventTriggered

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

acceptInboundMessage, acceptOutboundMessage, channelRead, write

Methods inherited from class io.netty.channel.ChannelDuplexHandler

bind, close, deregister, disconnect, flush, read

Methods inherited from class io.netty.channel.ChannelInboundHandlerAdapter

channelReadComplete, channelRegistered, channelUnregistered

Methods inherited from class io.netty.channel.ChannelHandlerAdapter

handlerAdded, 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

handlerAdded

Field Detail

OP_OPEN_CONNECTION

public static final byte OP_OPEN_CONNECTION

See Also:

Constant Field Values

OP_STREAM_REQUEST

public static final byte OP_STREAM_REQUEST

See Also:

Constant Field Values

OP_STREAM_END

public static final byte OP_STREAM_END

See Also:

Constant Field Values

OP_SNAPSHOT_MARKER

public static final byte OP_SNAPSHOT_MARKER

See Also:

Constant Field Values

OP_MUTATION

public static final byte OP_MUTATION

See Also:

Constant Field Values

OP_REMOVE

public static final byte OP_REMOVE

See Also:

Constant Field Values

OP_CONTROL

public static final byte OP_CONTROL

See Also:

Constant Field Values

OP_BUFFER_ACK

public static final byte OP_BUFFER_ACK

See Also:

Constant Field Values

OP_GET_FAILOVER_LOG

public static final byte OP_GET_FAILOVER_LOG

See Also:

Constant Field Values

Constructor Detail

DCPHandler

public DCPHandler(AbstractEndpoint endpoint,
                  com.lmax.disruptor.EventSink<ResponseEvent> responseBuffer,
                  boolean isTransient)

Creates a new DCPHandler with the default queue for requests.

Parameters:

endpoint - the AbstractEndpoint to coordinate with.

responseBuffer - the EventSink to push responses into.

DCPHandler

public DCPHandler(AbstractEndpoint endpoint,
                  com.lmax.disruptor.EventSink<ResponseEvent> responseBuffer,
                  Queue<DCPRequest> queue,
                  boolean isTransient)

Creates a new DCPHandler with a custom queue for requests (suitable for tests).

Parameters:

endpoint - the AbstractEndpoint to coordinate with.

responseBuffer - the EventSink to push responses into.

queue - the queue which holds all outstanding open requests.

Method Detail

encodeRequest

protected BinaryMemcacheRequest encodeRequest(ChannelHandlerContext ctx,
                                              DCPRequest msg)
                                       throws Exception

Description copied from class: AbstractGenericHandler

Encode the outgoing request and return it in encoded format.

This method needs to be implemented by the child handler and is responsible for the actual conversion.

Specified by:

encodeRequest in class AbstractGenericHandler<FullBinaryMemcacheResponse,BinaryMemcacheRequest,DCPRequest>

Parameters:

ctx - the context passed in.

msg - the outgoing message.

Returns:

the encoded request.

Throws:

Exception - as a generic error.

decodeResponse

protected CouchbaseResponse decodeResponse(ChannelHandlerContext ctx,
                                           FullBinaryMemcacheResponse msg)
                                    throws Exception

Description copied from class: AbstractGenericHandler

Decodes the incoming response and transforms it into a CouchbaseResponse.

Note that the actual notification is handled by this generic handler, the implementing class only is concerned about the conversion itself.

Specified by:

decodeResponse in class AbstractGenericHandler<FullBinaryMemcacheResponse,BinaryMemcacheRequest,DCPRequest>

Parameters:

ctx - the context passed in.

msg - the incoming message.

Returns:

a response or null if nothing should be returned.

Throws:

Exception - as a generic error. It will be bubbled up to the user (wrapped in a CouchbaseException) in the onError of the request’s Observable.

handlerRemoved

public void handlerRemoved(ChannelHandlerContext ctx)
                    throws Exception

Specified by:

handlerRemoved in interface ChannelHandler

Overrides:

handlerRemoved in class AbstractGenericHandler<FullBinaryMemcacheResponse,BinaryMemcacheRequest,DCPRequest>

Throws:

Exception

serviceType

protected ServiceType serviceType()

Description copied from class: AbstractGenericHandler

Returns the ServiceType associated with this handler.

Specified by:

serviceType in class AbstractGenericHandler<FullBinaryMemcacheResponse,BinaryMemcacheRequest,DCPRequest>

Returns:

the service type.