public class QueryHandler extends AbstractGenericHandler<HttpObject,HttpRequest,QueryRequest>
The QueryHandler
is responsible for encoding QueryRequest
s into lower level HttpRequest
s as well as decoding HttpObject
s into CouchbaseResponse
s.
Modifier and Type | Class and Description |
---|---|
protected static class |
QueryHandler.KeepAliveRequest |
protected static class |
QueryHandler.KeepAliveResponse |
ChannelHandler.Sharable
Modifier and Type | Field and Description |
---|---|
static int |
MINIMUM_WINDOW_FOR_CLIENTID_TOKEN
This is a window of characters allowing to detect the clientContextID token (including room for JSON separators, etc…).
|
CHARSET
Constructor and Description |
---|
QueryHandler(AbstractEndpoint endpoint,
com.lmax.disruptor.RingBuffer<ResponseEvent> responseBuffer,
boolean isTransient)
Creates a new
QueryHandler with the default queue for requests. |
Modifier and Type | Method and Description |
---|---|
protected CouchbaseRequest |
createKeepAliveRequest()
Override to return a non-null request to be fired in the pipeline in case a keep alive is triggered.
|
protected CouchbaseResponse |
decodeResponse(ChannelHandlerContext ctx,
HttpObject msg)
Decodes the incoming response and transforms it into a
CouchbaseResponse . |
protected HttpRequest |
encodeRequest(ChannelHandlerContext ctx,
QueryRequest 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. |
channelActive, channelInactive, channelWritabilityChanged, connect, currentRequest, currentRequest, decode, encode, endpoint, env, exceptionCaught, finishedDecoding, logIdent, onKeepAliveFired, onKeepAliveResponse, publishResponse, remoteHostname, sideEffectRequestToCancel, userEventTriggered
acceptInboundMessage, acceptOutboundMessage, channelRead, write
bind, close, deregister, disconnect, flush, read
channelReadComplete, channelRegistered, channelUnregistered
handlerAdded, isSharable
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
handlerAdded
public static final int MINIMUM_WINDOW_FOR_CLIENTID_TOKEN
This is a window of characters allowing to detect the clientContextID token (including room for JSON separators, etc…).
public QueryHandler(AbstractEndpoint endpoint, com.lmax.disruptor.RingBuffer<ResponseEvent> responseBuffer, boolean isTransient)
Creates a new QueryHandler
with the default queue for requests.
endpoint
- the AbstractEndpoint
to coordinate with.responseBuffer
- the RingBuffer
to push responses into.protected HttpRequest encodeRequest(ChannelHandlerContext ctx, QueryRequest msg) throws Exception
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.
encodeRequest
in class AbstractGenericHandler<HttpObject,HttpRequest,QueryRequest>
ctx
- the context passed in.msg
- the outgoing message.Exception
- as a generic error.protected CouchbaseResponse decodeResponse(ChannelHandlerContext ctx, HttpObject msg) throws Exception
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.
decodeResponse
in class AbstractGenericHandler<HttpObject,HttpRequest,QueryRequest>
ctx
- the context passed in.msg
- the incoming message.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.public void handlerRemoved(ChannelHandlerContext ctx) throws Exception
handlerRemoved
in interface ChannelHandler
handlerRemoved
in class AbstractGenericHandler<HttpObject,HttpRequest,QueryRequest>
Exception
protected CouchbaseRequest createKeepAliveRequest()
AbstractGenericHandler
Override to return a non-null request to be fired in the pipeline in case a keep alive is triggered.
createKeepAliveRequest
in class AbstractGenericHandler<HttpObject,HttpRequest,QueryRequest>
protected ServiceType serviceType()
AbstractGenericHandler
Returns the ServiceType
associated with this handler.
serviceType
in class AbstractGenericHandler<HttpObject,HttpRequest,QueryRequest>
Copyright © 2015 Couchbase, Inc.. All rights reserved.