relax the ThreadPool interface
This commit is contained in:
parent
650eb19622
commit
57071d7ad4
|
@ -21,24 +21,177 @@ package org.elasticsearch.threadpool;
|
||||||
|
|
||||||
import org.elasticsearch.util.TimeValue;
|
import org.elasticsearch.util.TimeValue;
|
||||||
|
|
||||||
import java.util.concurrent.Callable;
|
import java.util.concurrent.*;
|
||||||
import java.util.concurrent.Future;
|
|
||||||
import java.util.concurrent.ScheduledExecutorService;
|
|
||||||
import java.util.concurrent.ScheduledFuture;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @author kimchy (Shay Banon)
|
* @author kimchy (shay.banon)
|
||||||
*/
|
*/
|
||||||
public interface ThreadPool extends ScheduledExecutorService {
|
public interface ThreadPool {
|
||||||
|
|
||||||
boolean isStarted();
|
boolean isStarted();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Attempts to stop all actively executing tasks, halts the
|
||||||
|
* processing of waiting tasks, and returns a list of the tasks that were
|
||||||
|
* awaiting execution.
|
||||||
|
*
|
||||||
|
* <p>There are no guarantees beyond best-effort attempts to stop
|
||||||
|
* processing actively executing tasks. For example, typical
|
||||||
|
* implementations will cancel via {@link Thread#interrupt}, so any
|
||||||
|
* task that fails to respond to interrupts may never terminate.
|
||||||
|
*/
|
||||||
|
void shutdownNow();
|
||||||
|
|
||||||
|
/**
|
||||||
|
* 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.
|
||||||
|
*/
|
||||||
|
void shutdown();
|
||||||
|
|
||||||
|
boolean awaitTermination(long timeout, TimeUnit unit) throws InterruptedException;
|
||||||
|
|
||||||
|
void execute(Runnable command);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Submits a value-returning task for execution and returns a
|
||||||
|
* Future representing the pending results of the task. The
|
||||||
|
* Future's <tt>get</tt> method will return the task's result upon
|
||||||
|
* successful completion.
|
||||||
|
*
|
||||||
|
* <p>
|
||||||
|
* If you would like to immediately block waiting
|
||||||
|
* for a task, you can use constructions of the form
|
||||||
|
* <tt>result = exec.submit(aCallable).get();</tt>
|
||||||
|
*
|
||||||
|
* <p> Note: The {@link Executors} class includes a set of methods
|
||||||
|
* that can convert some other common closure-like objects,
|
||||||
|
* for example, {@link java.security.PrivilegedAction} to
|
||||||
|
* {@link Callable} form so they can be submitted.
|
||||||
|
*
|
||||||
|
* @param task the task to submit
|
||||||
|
* @return a Future representing pending completion of the task
|
||||||
|
* @throws RejectedExecutionException if the task cannot be
|
||||||
|
* scheduled for execution
|
||||||
|
* @throws NullPointerException if the task is null
|
||||||
|
*/
|
||||||
|
<T> Future<T> submit(Callable<T> task);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Submits a Runnable task for execution and returns a Future
|
||||||
|
* representing that task. The Future's <tt>get</tt> method will
|
||||||
|
* return the given result upon successful completion.
|
||||||
|
*
|
||||||
|
* @param task the task to submit
|
||||||
|
* @param result the result to return
|
||||||
|
* @return a Future representing pending completion of the task
|
||||||
|
* @throws RejectedExecutionException if the task cannot be
|
||||||
|
* scheduled for execution
|
||||||
|
* @throws NullPointerException if the task is null
|
||||||
|
*/
|
||||||
|
<T> Future<T> submit(Runnable task, T result);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Submits a Runnable task for execution and returns a Future
|
||||||
|
* representing that task. The Future's <tt>get</tt> method will
|
||||||
|
* return <tt>null</tt> upon <em>successful</em> completion.
|
||||||
|
*
|
||||||
|
* @param task the task to submit
|
||||||
|
* @return a Future representing pending completion of the task
|
||||||
|
* @throws RejectedExecutionException if the task cannot be
|
||||||
|
* scheduled for execution
|
||||||
|
* @throws NullPointerException if the task is null
|
||||||
|
*/
|
||||||
|
Future<?> submit(Runnable task);
|
||||||
|
|
||||||
<T> Future<T> submit(Callable<T> task, FutureListener<T> listener);
|
<T> Future<T> submit(Callable<T> task, FutureListener<T> listener);
|
||||||
|
|
||||||
<T> Future<T> submit(Runnable task, T result, FutureListener<T> listener);
|
<T> Future<T> submit(Runnable task, T result, FutureListener<T> listener);
|
||||||
|
|
||||||
Future<?> submit(Runnable task, FutureListener<?> listener);
|
Future<?> submit(Runnable task, FutureListener<?> listener);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates and executes a one-shot action that becomes enabled
|
||||||
|
* after the given delay.
|
||||||
|
*
|
||||||
|
* @param command the task to execute
|
||||||
|
* @param delay the time from now to delay execution
|
||||||
|
* @param unit the time unit of the delay parameter
|
||||||
|
* @return a ScheduledFuture representing pending completion of
|
||||||
|
* the task and whose <tt>get()</tt> method will return
|
||||||
|
* <tt>null</tt> upon completion
|
||||||
|
* @throws java.util.concurrent.RejectedExecutionException
|
||||||
|
* if the task cannot be
|
||||||
|
* scheduled for execution
|
||||||
|
* @throws NullPointerException if command is null
|
||||||
|
*/
|
||||||
|
public ScheduledFuture<?> schedule(Runnable command, long delay, TimeUnit unit);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates and executes a ScheduledFuture that becomes enabled after the
|
||||||
|
* given delay.
|
||||||
|
*
|
||||||
|
* @param callable the function to execute
|
||||||
|
* @param delay the time from now to delay execution
|
||||||
|
* @param unit the time unit of the delay parameter
|
||||||
|
* @return a ScheduledFuture that can be used to extract result or cancel
|
||||||
|
* @throws RejectedExecutionException if the task cannot be
|
||||||
|
* scheduled for execution
|
||||||
|
* @throws NullPointerException if callable is null
|
||||||
|
*/
|
||||||
|
public <V> ScheduledFuture<V> schedule(Callable<V> callable, long delay, TimeUnit unit);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates and executes a periodic action that becomes enabled first
|
||||||
|
* after the given initial delay, and subsequently with the given
|
||||||
|
* period; that is executions will commence after
|
||||||
|
* <tt>initialDelay</tt> then <tt>initialDelay+period</tt>, then
|
||||||
|
* <tt>initialDelay + 2 * period</tt>, and so on.
|
||||||
|
* If any execution of the task
|
||||||
|
* encounters an exception, subsequent executions are suppressed.
|
||||||
|
* Otherwise, the task will only terminate via cancellation or
|
||||||
|
* termination of the executor. If any execution of this task
|
||||||
|
* takes longer than its period, then subsequent executions
|
||||||
|
* may start late, but will not concurrently execute.
|
||||||
|
*
|
||||||
|
* @param command the task to execute
|
||||||
|
* @param initialDelay the time to delay first execution
|
||||||
|
* @param period the period between successive executions
|
||||||
|
* @param unit the time unit of the initialDelay and period parameters
|
||||||
|
* @return a ScheduledFuture representing pending completion of
|
||||||
|
* the task, and whose <tt>get()</tt> method will throw an
|
||||||
|
* exception upon cancellation
|
||||||
|
* @throws RejectedExecutionException if the task cannot be
|
||||||
|
* scheduled for execution
|
||||||
|
* @throws NullPointerException if command is null
|
||||||
|
* @throws IllegalArgumentException if period less than or equal to zero
|
||||||
|
*/
|
||||||
|
public ScheduledFuture<?> scheduleAtFixedRate(Runnable command, long initialDelay, long period, TimeUnit unit);
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Creates and executes a periodic action that becomes enabled first
|
||||||
|
* after the given initial delay, and subsequently with the
|
||||||
|
* given delay between the termination of one execution and the
|
||||||
|
* commencement of the next. If any execution of the task
|
||||||
|
* encounters an exception, subsequent executions are suppressed.
|
||||||
|
* Otherwise, the task will only terminate via cancellation or
|
||||||
|
* termination of the executor.
|
||||||
|
*
|
||||||
|
* @param command the task to execute
|
||||||
|
* @param initialDelay the time to delay first execution
|
||||||
|
* @param delay the delay between the termination of one
|
||||||
|
* execution and the commencement of the next
|
||||||
|
* @param unit the time unit of the initialDelay and delay parameters
|
||||||
|
* @return a ScheduledFuture representing pending completion of
|
||||||
|
* the task, and whose <tt>get()</tt> method will throw an
|
||||||
|
* exception upon cancellation
|
||||||
|
* @throws RejectedExecutionException if the task cannot be
|
||||||
|
* scheduled for execution
|
||||||
|
* @throws NullPointerException if command is null
|
||||||
|
* @throws IllegalArgumentException if delay less than or equal to zero
|
||||||
|
*/
|
||||||
|
public ScheduledFuture<?> scheduleWithFixedDelay(Runnable command, long initialDelay, long delay, TimeUnit unit);
|
||||||
|
|
||||||
public ScheduledFuture<?> schedule(Runnable command, TimeValue delay);
|
public ScheduledFuture<?> schedule(Runnable command, TimeValue delay);
|
||||||
|
|
||||||
ScheduledFuture<?> scheduleWithFixedDelay(Runnable command, TimeValue interval);
|
ScheduledFuture<?> scheduleWithFixedDelay(Runnable command, TimeValue interval);
|
||||||
|
|
|
@ -25,9 +25,6 @@ import org.elasticsearch.util.TimeValue;
|
||||||
import org.elasticsearch.util.component.AbstractComponent;
|
import org.elasticsearch.util.component.AbstractComponent;
|
||||||
import org.elasticsearch.util.settings.Settings;
|
import org.elasticsearch.util.settings.Settings;
|
||||||
|
|
||||||
import java.util.ArrayList;
|
|
||||||
import java.util.Collection;
|
|
||||||
import java.util.List;
|
|
||||||
import java.util.concurrent.*;
|
import java.util.concurrent.*;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@ -74,20 +71,10 @@ public abstract class AbstractThreadPool extends AbstractComponent implements Th
|
||||||
scheduledExecutorService.shutdown();
|
scheduledExecutorService.shutdown();
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override public List<Runnable> shutdownNow() {
|
@Override public void shutdownNow() {
|
||||||
started = false;
|
started = false;
|
||||||
List<Runnable> result = new ArrayList<Runnable>();
|
executorService.shutdownNow();
|
||||||
result.addAll(executorService.shutdownNow());
|
scheduledExecutorService.shutdownNow();
|
||||||
result.addAll(scheduledExecutorService.shutdownNow());
|
|
||||||
return result;
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override public boolean isShutdown() {
|
|
||||||
return executorService.isShutdown() || scheduledExecutorService.isShutdown();
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override public boolean isTerminated() {
|
|
||||||
return executorService.isTerminated() || scheduledExecutorService.isTerminated();
|
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override public boolean awaitTermination(long timeout, TimeUnit unit) throws InterruptedException {
|
@Override public boolean awaitTermination(long timeout, TimeUnit unit) throws InterruptedException {
|
||||||
|
@ -128,22 +115,6 @@ public abstract class AbstractThreadPool extends AbstractComponent implements Th
|
||||||
return scheduleWithFixedDelay(command, interval.millis(), interval.millis(), TimeUnit.MILLISECONDS);
|
return scheduleWithFixedDelay(command, interval.millis(), interval.millis(), TimeUnit.MILLISECONDS);
|
||||||
}
|
}
|
||||||
|
|
||||||
@Override public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks) throws InterruptedException {
|
|
||||||
return executorService.invokeAll(tasks);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override public <T> List<Future<T>> invokeAll(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit) throws InterruptedException {
|
|
||||||
return executorService.invokeAll(tasks, timeout, unit);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override public <T> T invokeAny(Collection<? extends Callable<T>> tasks) throws InterruptedException, ExecutionException {
|
|
||||||
return executorService.invokeAny(tasks);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override public <T> T invokeAny(Collection<? extends Callable<T>> tasks, long timeout, TimeUnit unit) throws InterruptedException, ExecutionException, TimeoutException {
|
|
||||||
return executorService.invokeAny(tasks, timeout, unit);
|
|
||||||
}
|
|
||||||
|
|
||||||
@Override public void execute(Runnable command) {
|
@Override public void execute(Runnable command) {
|
||||||
executorService.execute(command);
|
executorService.execute(command);
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue