Module org.elasticsearch.server

Package org.elasticsearch.action

Class ActionListenerResponseHandler<Response extends TransportResponse>

java.lang.Object

org.elasticsearch.action.ActionListenerResponseHandler<Response>

All Implemented Interfaces:

Writeable.Reader<Response>, TransportResponseHandler<Response>

Direct Known Subclasses:

CleanableResponseHandler

public class ActionListenerResponseHandler<Response extends TransportResponse>
extends Object
implements TransportResponseHandler<Response>

An adapter for handling transport responses using an ActionListener.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.transport.TransportResponseHandler

TransportResponseHandler.Empty

Field Summary

Fields

Modifier and Type	Field	Description
protected final ActionListener<? super Response>	listener

Fields inherited from interface org.elasticsearch.transport.TransportResponseHandler

TRANSPORT_WORKER

Constructor Summary

Constructors

Constructor	Description
ActionListenerResponseHandler(ActionListener<? super Response> listener, Writeable.Reader<Response> reader, Executor executor)

Method Summary

Modifier and Type	Method	Description
Executor	executor()
void	handleException(TransportException e)
void	handleResponse(Response response)
Response	read(StreamInput in)	Read V-type value from a stream.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

listener

protected final ActionListener<? super Response extends TransportResponse> listener

Constructor Details

ActionListenerResponseHandler

public ActionListenerResponseHandler(ActionListener<? super Response> listener,
 Writeable.Reader<Response> reader,
 Executor executor)

Parameters:

listener - The listener to notify with the transport response received.

reader - Used to deserialize the response.

executor - The executor to use to deserialize the response and notify the listener. You must only use EsExecutors.DIRECT_EXECUTOR_SERVICE (or equivalently TransportResponseHandler.TRANSPORT_WORKER) for very performance-critical actions, and even then only if the deserialization and handling work is very cheap, because this executor will perform all the work for responses from remote nodes on the receiving transport worker itself.

Method Details

handleResponse

public void handleResponse(Response response)

Specified by:

handleResponse in interface TransportResponseHandler<Response extends TransportResponse>

handleException

public void handleException(TransportException e)

Specified by:

handleException in interface TransportResponseHandler<Response extends TransportResponse>

executor

public Executor executor()

Specified by:

executor in interface TransportResponseHandler<Response extends TransportResponse>

Returns:

the executor to use to deserialize the response and notify the listener. You must only use EsExecutors.DIRECT_EXECUTOR_SERVICE (or equivalently TransportResponseHandler.TRANSPORT_WORKER) for very performance-critical actions, and even then only if the deserialization and handling work is very cheap, because this executor will perform all the work for responses from remote nodes on the receiving transport worker itself.

read

public Response read(StreamInput in)
              throws IOException

Description copied from interface: Writeable.Reader

Read V-type value from a stream.

Specified by:

read in interface Writeable.Reader<Response extends TransportResponse>

Parameters:

in - Input to read the value from

Throws:

IOException

toString

public String toString()

Overrides:

toString in class Object