Package com.j_spaces.kernel.threadpool.monitor

Class TimeoutObserverExecutorService

java.lang.Object
com.j_spaces.kernel.threadpool.monitor.TimeoutObserverExecutorService
All Implemented Interfaces:
FutureExecutorService
public class TimeoutObserverExecutorService extends Object implements FutureExecutorService
A timeout mechanism on top of an executor service. Can be used for tasks that may be interrupted if an execution time has elapsed. Much like a Future.get(long, TimeUnit) but done by a background thread.
Since:
7.0.2
Author:
Moran Avigdor

  • Constructor Summary

    Constructors
    Constructor
    Description
    TimeoutObserverExecutorService(ExecutorService executorService, long timeout)
    Constructs a timeout observer on top of an ExecutorService, exposing only executions of Futures.

  • Method Summary

    Modifier and Type
    Method
    Description
    <T> List<Future<T>>
    invokeAll(Collection<Callable<T>> tasks)
    Executes the given tasks, returning a list of Futures holding their status and results when all complete.
    <T> List<Future<T>>
    invokeAll(Collection<Callable<T>> tasks, long timeout, TimeUnit unit)
    Executes the given tasks, returning a list of Futures holding their status and results when all complete or the timeout expires, whichever happens first.
    void
    shutdown()
    Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted.
    List<Runnable>
    shutdownNow()
    Attempts to stop all actively executing tasks, halts the processing of waiting tasks, and returns a list of the tasks that were awaiting execution.
    Future<?>
    submit(Runnable task)
    Submits a Runnable task for execution and returns a Future representing that task.
    <T> Future<T>
    submit(Runnable task, T result)
    Submits a Runnable task for execution and returns a Future representing that task that will upon completion return the given result
    <T> Future<T>
    submit(Callable<T> task)
    Submits a value-returning task for execution and returns a Future representing the pending results of the task.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • TimeoutObserverExecutorService

      public TimeoutObserverExecutorService(ExecutorService executorService, long timeout)
      Constructs a timeout observer on top of an ExecutorService, exposing only executions of Futures.
      Parameters:
      executorService - The underlying executor service
      timeout - time in milliseconds to wait before interrupting a threads execution

  • Method Details

    • invokeAll

      public <T> List<Future<T>> invokeAll(Collection<Callable<T>> tasks) throws InterruptedException
      Description copied from interface: FutureExecutorService
      Executes the given tasks, returning a list of Futures holding their status and results when all complete. Future.isDone() is true for each element of the returned list. Note that a completed task could have terminated either normally or by throwing an exception. The results of this method are undefined if the given collection is modified while this operation is in progress.
      Specified by:
      invokeAll in interface FutureExecutorService
      Parameters:
      tasks - the collection of tasks
      Returns:
      A list of Futures representing the tasks, in the same sequential order as produced by the iterator for the given task list, each of which has completed.
      Throws:
      InterruptedException - if interrupted while waiting, in which case unfinished tasks are cancelled.

    • invokeAll

      public <T> List<Future<T>> invokeAll(Collection<Callable<T>> tasks, long timeout, TimeUnit unit) throws InterruptedException
      Description copied from interface: FutureExecutorService
      Executes the given tasks, returning a list of Futures holding their status and results when all complete or the timeout expires, whichever happens first. Future.isDone() is true for each element of the returned list. Upon return, tasks that have not completed are cancelled. Note that a completed task could have terminated either normally or by throwing an exception. The results of this method are undefined if the given collection is modified while this operation is in progress.
      Specified by:
      invokeAll in interface FutureExecutorService
      Parameters:
      tasks - the collection of tasks
      timeout - the maximum time to wait
      unit - the time unit of the timeout argument
      Returns:
      A list of Futures representing the tasks, in the same sequential order as produced by the iterator for the given task list. If the operation did not time out, each task will have completed. If it did time out, some of these tasks will not have completed.
      Throws:
      InterruptedException - if interrupted while waiting, in which case unfinished tasks are cancelled.

    • shutdown

      public void shutdown()
      Description copied from interface: FutureExecutorService
      Initiates an orderly shutdown in which previously submitted tasks are executed, but no new tasks will be accepted. Invocation has no additional effect if already shut down.
      Specified by:
      shutdown in interface FutureExecutorService

    • shutdownNow

      public List<Runnable> shutdownNow()
      Description copied from interface: FutureExecutorService
      Attempts to stop all actively executing tasks, halts the processing of waiting tasks, and returns a list of the tasks that were awaiting execution.

      There are no guarantees beyond best-effort attempts to stop processing actively executing tasks. For example, typical implementations will cancel via Thread.interrupt(), so if any tasks mask or fail to respond to interrupts, they may never terminate.

      Specified by:
      shutdownNow in interface FutureExecutorService
      Returns:
      list of tasks that never commenced execution

    • submit

      public <T> Future<T> submit(Callable<T> task)
      Description copied from interface: FutureExecutorService
      Submits a value-returning task for execution and returns a Future representing the pending results of the task.

      If you would like to immediately block waiting for a task, you can use constructions of the form result = exec.submit(aCallable).get();

      Note: The Executors class includes a set of methods that can convert some other common closure-like objects, for example, PrivilegedAction to Callable form so they can be submitted.

      Specified by:
      submit in interface FutureExecutorService
      Parameters:
      task - the task to submit
      Returns:
      a Future representing pending completion of the task

    • submit

      public <T> Future<T> submit(Runnable task, T result)
      Description copied from interface: FutureExecutorService
      Submits a Runnable task for execution and returns a Future representing that task that will upon completion return the given result
      Specified by:
      submit in interface FutureExecutorService
      Parameters:
      task - the task to submit
      result - the result to return
      Returns:
      a Future representing pending completion of the task, and whose get() method will return the given result upon completion.

    • submit

      public Future<?> submit(Runnable task)
      Description copied from interface: FutureExecutorService
      Submits a Runnable task for execution and returns a Future representing that task.
      Specified by:
      submit in interface FutureExecutorService
      Parameters:
      task - the task to submit
      Returns:
      a Future representing pending completion of the task, and whose get() method will return null upon completion.