Class ListenerTimeouts

java.lang.Object
org.elasticsearch.action.support.ListenerTimeouts

public class ListenerTimeouts
extends java.lang.Object
  • Constructor Summary

    Constructors 
    Constructor Description
    ListenerTimeouts()  
  • Method Summary

    Modifier and Type Method Description
    static <Response> ActionListener<Response> wrapWithTimeout​(ThreadPool threadPool, ActionListener<Response> listener, TimeValue timeout, java.lang.String executor, java.lang.String listenerName)
    Wraps a listener with a listener that can timeout.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Constructor Details

  • Method Details

    • wrapWithTimeout

      public static <Response> ActionListener<Response> wrapWithTimeout​(ThreadPool threadPool, ActionListener<Response> listener, TimeValue timeout, java.lang.String executor, java.lang.String listenerName)
      Wraps a listener with a listener that can timeout. After the timeout period the ActionListener.onFailure(Exception) will be called with a ElasticsearchTimeoutException if the listener has not already been completed.
      Parameters:
      threadPool - used to schedule the timeout
      listener - to that can timeout
      timeout - period before listener failed
      executor - to use for scheduling timeout
      listenerName - name of the listener for timeout exception
      Returns:
      the wrapped listener that will timeout