util/concurrent/ExecutorService.java

/*
 * Written by Doug Lea with assistance from members of JCP JSR-166
 * Expert Group and released to the public domain, as explained at
 * http://creativecommons.org/licenses/publicdomain
 */

package java.util.concurrent;
import java.util.concurrent.*; // for javadoc (till 6280605 is fixed)
import java.util.List;
import java.util.Collection;
import java.security.PrivilegedAction;
import java.security.PrivilegedExceptionAction;

/**
 * An {@link Executor} that provides methods to manage termination and
 * methods that can produce a {@link Future} for tracking progress of
 * one or more asynchronous tasks.
 *
 * <p>
 * An <tt>ExecutorService</tt> can be shut down, which will cause it
 * to stop accepting new tasks.  After being shut down, the executor
 * will eventually terminate, at which point no tasks are actively
 * executing, no tasks are awaiting execution, and no new tasks can be
 * submitted.
 *
 * <p> Method <tt>submit</tt> extends base method {@link
 * Executor#execute} by creating and returning a {@link Future} that
 * can be used to cancel execution and/or wait for completion.
 * Methods <tt>invokeAny</tt> and <tt>invokeAll</tt> perform the most
 * commonly useful forms of bulk execution, executing a collection of
 * tasks and then waiting for at least one, or all, to
 * complete. (Class {@link ExecutorCompletionService} can be used to
 * write customized variants of these methods.)
 *
 * <p>The {@link Executors} class provides factory methods for the
 * executor services provided in this package.
 *
 * <h3>Usage Example</h3>
 *
 * Here is a sketch of a network service in which threads in a thread
 * pool service incoming requests. It uses the preconfigured {@link
 * Executors#newFixedThreadPool} factory method:
 *
 * <pre>
 * class NetworkService {
 *   private final ServerSocket serverSocket;
 *   private final ExecutorService pool;
 *
 *   public NetworkService(int port, int poolSize)
 *       throws IOException {
 *     serverSocket = new ServerSocket(port);
 *     pool = Executors.newFixedThreadPool(poolSize);
 *   }
 *
 *   public void serve() {
 *     try {
 *       for (;;) {
 *         pool.execute(new Handler(serverSocket.accept()));
 *       }
 *     } catch (IOException ex) {
 *       pool.shutdown();
 *     }
 *   }
 * }
 *
 * class Handler implements Runnable {
 *   private final Socket socket;
 *   Handler(Socket socket) { this.socket = socket; }
 *   public void run() {
 *     // read and service request
 *   }
 * }
 * </pre>
 * @since 1.5
 * @author Doug Lea
 */
public interface ExecutorService extends Executor {

    /**
     * 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.
     *
     * @throws SecurityException if a security manager exists and
     *         shutting down this ExecutorService may manipulate
     *         threads that the caller is not permitted to modify
     *         because it does not hold {@link
     *         java.lang.RuntimePermission}<tt>("modifyThread")</tt>,
     *         or the security manager's <tt>checkAccess</tt> method
     *         denies access.
     */
    void shutdown();

    /**
     * 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 if any
     * tasks mask or fail to respond to interrupts, they may never terminate.
     *
     * @return list of tasks that never commenced execution
     * @throws SecurityException if a security manager exists and
     *         shutting down this ExecutorService may manipulate
     *         threads that the caller is not permitted to modify
     *         because it does not hold {@link
     *         java.lang.RuntimePermission}<tt>("modifyThread")</tt>,
     *         or the security manager's <tt>checkAccess</tt> method
     *         denies access.
     */
    List<Runnable> shutdownNow();

    /**
     * Returns <tt>true</tt> if this executor has been shut down.
     *
     * @return <tt>true</tt> if this executor has been shut down
     */
    boolean isShutdown();

    /**
     * Returns <tt>true</tt> if all tasks have completed following shut down.
     * Note that <tt>isTerminated</tt> is never <tt>true</tt> unless
     * either <tt>shutdown</tt> or <tt>shutdownNow</tt> was called first.
     *
     * @return <tt>true</tt> if all tasks have completed following shut down
     */
    boolean isTerminated();

    /**
     * Blocks until all tasks have completed execution after a shutdown
     * request, or the timeout occurs, or the current thread is
     * interrupted, whichever happens first.
     *
     * @param timeout the maximum time to wait
     * @param unit the time unit of the timeout argument
     * @return <tt>true</tt> if this executor terminated and
     *         <tt>false</tt> if the timeout elapsed before termination
     * @throws InterruptedException if interrupted while waiting
     */
    boolean awaitTermination(long timeout, TimeUnit unit)
        throws InterruptedException;


    /**
     * 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);

    /**
     * Executes the given tasks, returning a list of Futures holding
     * their status and results when all complete.
     * {@link Future#isDone} is <tt>true</tt> for each
     * element of the returned list.
     * Note that a <em>completed</em> 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.
     *
     * @param tasks the collection of tasks
     * @return 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.
     * @throws NullPointerException if tasks or any of its elements are <tt>null</tt>
     * @throws RejectedExecutionException if any task cannot be
     *         scheduled for execution
     */
    <T> List<Future<T>> invokeAll(Collection<Callable<T>> tasks)
        throws InterruptedException;

    /**
     * Executes the given tasks, returning a list of Futures holding
     * their status and results
     * when all complete or the timeout expires, whichever happens first.
     * {@link Future#isDone} is <tt>true</tt> for each
     * element of the returned list.
     * Upon return, tasks that have not completed are cancelled.
     * Note that a <em>completed</em> 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.
     *
     * @param tasks the collection of tasks
     * @param timeout the maximum time to wait
     * @param unit the time unit of the timeout argument
     * @return 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
     * @throws NullPointerException if tasks, any of its elements, or
     *         unit are <tt>null</tt>
     * @throws RejectedExecutionException if any task cannot be scheduled
     *         for execution
     */
    <T> List<Future<T>> invokeAll(Collection<Callable<T>> tasks,
                                  long timeout, TimeUnit unit)
        throws InterruptedException;

    /**
     * Executes the given tasks, returning the result
     * of one that has completed successfully (i.e., without throwing
     * an exception), if any do. Upon normal or exceptional return,
     * tasks that have not completed are cancelled.
     * The results of this method are undefined if the given
     * collection is modified while this operation is in progress.
     *
     * @param tasks the collection of tasks
     * @return the result returned by one of the tasks
     * @throws InterruptedException if interrupted while waiting
     * @throws NullPointerException if tasks or any of its elements
     *         are <tt>null</tt>
     * @throws IllegalArgumentException if tasks is empty
     * @throws ExecutionException if no task successfully completes
     * @throws RejectedExecutionException if tasks cannot be scheduled
     *         for execution
     */
    <T> T invokeAny(Collection<Callable<T>> tasks)
        throws InterruptedException, ExecutionException;

    /**
     * Executes the given tasks, returning the result
     * of one that has completed successfully (i.e., without throwing
     * an exception), if any do before the given timeout elapses.
     * Upon normal or exceptional return, tasks that have not
     * completed are cancelled.
     * The results of this method are undefined if the given
     * collection is modified while this operation is in progress.
     *
     * @param tasks the collection of tasks
     * @param timeout the maximum time to wait
     * @param unit the time unit of the timeout argument
     * @return the result returned by one of the tasks.
     * @throws InterruptedException if interrupted while waiting
     * @throws NullPointerException if tasks, any of its elements, or
     *         unit are <tt>null</tt>
     * @throws TimeoutException if the given timeout elapses before
     *         any task successfully completes
     * @throws ExecutionException if no task successfully completes
     * @throws RejectedExecutionException if tasks cannot be scheduled
     *         for execution
     */
    <T> T invokeAny(Collection<Callable<T>> tasks,
                    long timeout, TimeUnit unit)
        throws InterruptedException, ExecutionException, TimeoutException;
}
Revision:	1.37
Committed:	Thu Aug 25 05:31:40 2005 UTC (18 years, 9 months ago) by jsr166
Branch:	MAIN
Changes since 1.36:	+77 -69 lines
Log Message:	doc fixes
#	User	Rev	Content
1	dl	1.1	/*
2			* Written by Doug Lea with assistance from members of JCP JSR-166
3	dl	1.22	* Expert Group and released to the public domain, as explained at
4			* http://creativecommons.org/licenses/publicdomain
5	dl	1.1	*/
6
7			package java.util.concurrent;
8	jsr166	1.37	import java.util.concurrent.*; // for javadoc (till 6280605 is fixed)
9	dl	1.1	import java.util.List;
10	dl	1.15	import java.util.Collection;
11	tim	1.8	import java.security.PrivilegedAction;
12			import java.security.PrivilegedExceptionAction;
13	dl	1.1
14			/**
15	dl	1.25	* An {@link Executor} that provides methods to manage termination and
16	dl	1.20	* methods that can produce a {@link Future} for tracking progress of
17	jsr166	1.33	* one or more asynchronous tasks.
18	dl	1.17	*
19	dl	1.25	* <p>
20	dl	1.7	* An <tt>ExecutorService</tt> can be shut down, which will cause it
21			* to stop accepting new tasks. After being shut down, the executor
22			* will eventually terminate, at which point no tasks are actively
23	dl	1.1	* executing, no tasks are awaiting execution, and no new tasks can be
24			* submitted.
25			*
26	dl	1.20	* <p> Method <tt>submit</tt> extends base method {@link
27			* Executor#execute} by creating and returning a {@link Future} that
28			* can be used to cancel execution and/or wait for completion.
29			* Methods <tt>invokeAny</tt> and <tt>invokeAll</tt> perform the most
30			* commonly useful forms of bulk execution, executing a collection of
31			* tasks and then waiting for at least one, or all, to
32			* complete. (Class {@link ExecutorCompletionService} can be used to
33			* write customized variants of these methods.)
34	dl	1.17	*
35	dl	1.7	* <p>The {@link Executors} class provides factory methods for the
36			* executor services provided in this package.
37	dl	1.1	*
38	dl	1.23	* <h3>Usage Example</h3>
39			*
40			* Here is a sketch of a network service in which threads in a thread
41			* pool service incoming requests. It uses the preconfigured {@link
42			* Executors#newFixedThreadPool} factory method:
43			*
44			* <pre>
45			* class NetworkService {
46	jsr166	1.37	* private final ServerSocket serverSocket;
47			* private final ExecutorService pool;
48	dl	1.23	*
49	jsr166	1.37	* public NetworkService(int port, int poolSize)
50			* throws IOException {
51			* serverSocket = new ServerSocket(port);
52			* pool = Executors.newFixedThreadPool(poolSize);
53			* }
54	jsr166	1.33	*
55	jsr166	1.37	* public void serve() {
56			* try {
57			* for (;;) {
58			* pool.execute(new Handler(serverSocket.accept()));
59			* }
60			* } catch (IOException ex) {
61			* pool.shutdown();
62			* }
63			* }
64			* }
65	dl	1.23	*
66	jsr166	1.37	* class Handler implements Runnable {
67			* private final Socket socket;
68			* Handler(Socket socket) { this.socket = socket; }
69			* public void run() {
70			* // read and service request
71			* }
72	dl	1.23	* }
73			* </pre>
74	dl	1.1	* @since 1.5
75	dl	1.5	* @author Doug Lea
76	dl	1.1	*/
77			public interface ExecutorService extends Executor {
78	tim	1.8
79	dl	1.17	/**
80			* Initiates an orderly shutdown in which previously submitted
81	jsr166	1.37	* tasks are executed, but no new tasks will be accepted.
82			* Invocation has no additional effect if already shut down.
83			*
84	dl	1.17	* @throws SecurityException if a security manager exists and
85	jsr166	1.37	* shutting down this ExecutorService may manipulate
86			* threads that the caller is not permitted to modify
87			* because it does not hold {@link
88			* java.lang.RuntimePermission}<tt>("modifyThread")</tt>,
89			* or the security manager's <tt>checkAccess</tt> method
90			* denies access.
91	dl	1.17	*/
92			void shutdown();
93
94			/**
95			* Attempts to stop all actively executing tasks, halts the
96			* processing of waiting tasks, and returns a list of the tasks that were
97	jsr166	1.33	* awaiting execution.
98			*
99	dl	1.17	* <p>There are no guarantees beyond best-effort attempts to stop
100			* processing actively executing tasks. For example, typical
101			* implementations will cancel via {@link Thread#interrupt}, so if any
102			* tasks mask or fail to respond to interrupts, they may never terminate.
103			*
104			* @return list of tasks that never commenced execution
105			* @throws SecurityException if a security manager exists and
106	jsr166	1.37	* shutting down this ExecutorService may manipulate
107			* threads that the caller is not permitted to modify
108			* because it does not hold {@link
109			* java.lang.RuntimePermission}<tt>("modifyThread")</tt>,
110			* or the security manager's <tt>checkAccess</tt> method
111			* denies access.
112	dl	1.17	*/
113			List<Runnable> shutdownNow();
114
115			/**
116			* Returns <tt>true</tt> if this executor has been shut down.
117			*
118			* @return <tt>true</tt> if this executor has been shut down
119			*/
120			boolean isShutdown();
121
122			/**
123			* Returns <tt>true</tt> if all tasks have completed following shut down.
124			* Note that <tt>isTerminated</tt> is never <tt>true</tt> unless
125			* either <tt>shutdown</tt> or <tt>shutdownNow</tt> was called first.
126			*
127			* @return <tt>true</tt> if all tasks have completed following shut down
128			*/
129			boolean isTerminated();
130
131			/**
132			* Blocks until all tasks have completed execution after a shutdown
133			* request, or the timeout occurs, or the current thread is
134	jsr166	1.36	* interrupted, whichever happens first.
135	dl	1.17	*
136			* @param timeout the maximum time to wait
137			* @param unit the time unit of the timeout argument
138	jsr166	1.37	* @return <tt>true</tt> if this executor terminated and
139			* <tt>false</tt> if the timeout elapsed before termination
140	dl	1.17	* @throws InterruptedException if interrupted while waiting
141			*/
142			boolean awaitTermination(long timeout, TimeUnit unit)
143			throws InterruptedException;
144
145
146	tim	1.8	/**
147	dl	1.30	* Submits a value-returning task for execution and returns a
148	dl	1.31	* Future representing the pending results of the task. The
149	dl	1.32	* Future's <tt>get</tt> method will return the task's result upon
150	jsr166	1.37	* successful completion.
151	tim	1.8	*
152	dl	1.19	* <p>
153	dl	1.20	* If you would like to immediately block waiting
154	dl	1.19	* for a task, you can use constructions of the form
155			* <tt>result = exec.submit(aCallable).get();</tt>
156	dl	1.20	*
157			* <p> Note: The {@link Executors} class includes a set of methods
158			* that can convert some other common closure-like objects,
159			* for example, {@link java.security.PrivilegedAction} to
160			* {@link Callable} form so they can be submitted.
161			*
162	tim	1.8	* @param task the task to submit
163			* @return a Future representing pending completion of the task
164	jsr166	1.37	* @throws RejectedExecutionException if the task cannot be
165			* scheduled for execution
166			* @throws NullPointerException if the task is null
167	tim	1.8	*/
168			<T> Future<T> submit(Callable<T> task);
169
170			/**
171	dl	1.30	* Submits a Runnable task for execution and returns a Future
172	jsr166	1.33	* representing that task. The Future's <tt>get</tt> method will
173	dl	1.31	* return the given result upon successful completion.
174	dl	1.20	*
175			* @param task the task to submit
176			* @param result the result to return
177	dl	1.31	* @return a Future representing pending completion of the task
178	jsr166	1.37	* @throws RejectedExecutionException if the task cannot be
179			* scheduled for execution
180			* @throws NullPointerException if the task is null
181	dl	1.20	*/
182			<T> Future<T> submit(Runnable task, T result);
183
184			/**
185	jsr166	1.33	* Submits a Runnable task for execution and returns a Future
186			* representing that task. The Future's <tt>get</tt> method will
187	jsr166	1.37	* return <tt>null</tt> upon <em>successful</em> completion.
188	dl	1.1	*
189	dl	1.17	* @param task the task to submit
190	dl	1.31	* @return a Future representing pending completion of the task
191	jsr166	1.37	* @throws RejectedExecutionException if the task cannot be
192			* scheduled for execution
193			* @throws NullPointerException if the task is null
194	dl	1.1	*/
195	dl	1.18	Future<?> submit(Runnable task);
196	dl	1.15
197	dl	1.11	/**
198	dl	1.27	* Executes the given tasks, returning a list of Futures holding
199	jsr166	1.33	* their status and results when all complete.
200			* {@link Future#isDone} is <tt>true</tt> for each
201	dl	1.27	* element of the returned list.
202	dl	1.12	* Note that a <em>completed</em> task could have
203			* terminated either normally or by throwing an exception.
204	dl	1.21	* The results of this method are undefined if the given
205			* collection is modified while this operation is in progress.
206	jsr166	1.37	*
207	dl	1.11	* @param tasks the collection of tasks
208	dl	1.13	* @return A list of Futures representing the tasks, in the same
209	jsr166	1.37	* sequential order as produced by the iterator for the
210			* given task list, each of which has completed.
211	dl	1.11	* @throws InterruptedException if interrupted while waiting, in
212	jsr166	1.37	* which case unfinished tasks are cancelled.
213	dl	1.13	* @throws NullPointerException if tasks or any of its elements are <tt>null</tt>
214	jsr166	1.37	* @throws RejectedExecutionException if any task cannot be
215			* scheduled for execution
216	dl	1.11	*/
217	dl	1.16	<T> List<Future<T>> invokeAll(Collection<Callable<T>> tasks)
218	dl	1.11	throws InterruptedException;
219
220			/**
221	dl	1.27	* Executes the given tasks, returning a list of Futures holding
222	jsr166	1.33	* their status and results
223	dl	1.15	* when all complete or the timeout expires, whichever happens first.
224	jsr166	1.33	* {@link Future#isDone} is <tt>true</tt> for each
225	dl	1.27	* element of the returned list.
226	dl	1.11	* Upon return, tasks that have not completed are cancelled.
227	dl	1.12	* Note that a <em>completed</em> task could have
228			* terminated either normally or by throwing an exception.
229	dl	1.21	* The results of this method are undefined if the given
230			* collection is modified while this operation is in progress.
231	jsr166	1.37	*
232	dl	1.11	* @param tasks the collection of tasks
233			* @param timeout the maximum time to wait
234	dl	1.15	* @param unit the time unit of the timeout argument
235	jsr166	1.37	* @return a list of Futures representing the tasks, in the same
236			* sequential order as produced by the iterator for the
237			* given task list. If the operation did not time out,
238			* each task will have completed. If it did time out, some
239			* of these tasks will not have completed.
240	dl	1.11	* @throws InterruptedException if interrupted while waiting, in
241	jsr166	1.37	* which case unfinished tasks are cancelled
242	dl	1.17	* @throws NullPointerException if tasks, any of its elements, or
243	jsr166	1.37	* unit are <tt>null</tt>
244	dl	1.13	* @throws RejectedExecutionException if any task cannot be scheduled
245	jsr166	1.37	* for execution
246	dl	1.11	*/
247	jsr166	1.33	<T> List<Future<T>> invokeAll(Collection<Callable<T>> tasks,
248			long timeout, TimeUnit unit)
249	dl	1.11	throws InterruptedException;
250
251			/**
252	dl	1.17	* Executes the given tasks, returning the result
253	dl	1.15	* of one that has completed successfully (i.e., without throwing
254			* an exception), if any do. Upon normal or exceptional return,
255			* tasks that have not completed are cancelled.
256	dl	1.21	* The results of this method are undefined if the given
257			* collection is modified while this operation is in progress.
258	jsr166	1.37	*
259	dl	1.11	* @param tasks the collection of tasks
260	jsr166	1.37	* @return the result returned by one of the tasks
261	dl	1.15	* @throws InterruptedException if interrupted while waiting
262			* @throws NullPointerException if tasks or any of its elements
263	jsr166	1.37	* are <tt>null</tt>
264			* @throws IllegalArgumentException if tasks is empty
265	dl	1.15	* @throws ExecutionException if no task successfully completes
266			* @throws RejectedExecutionException if tasks cannot be scheduled
267	jsr166	1.37	* for execution
268	dl	1.11	*/
269	dl	1.15	<T> T invokeAny(Collection<Callable<T>> tasks)
270			throws InterruptedException, ExecutionException;
271	dl	1.11
272			/**
273	dl	1.17	* Executes the given tasks, returning the result
274	dl	1.15	* of one that has completed successfully (i.e., without throwing
275			* an exception), if any do before the given timeout elapses.
276			* Upon normal or exceptional return, tasks that have not
277			* completed are cancelled.
278	dl	1.21	* The results of this method are undefined if the given
279			* collection is modified while this operation is in progress.
280	jsr166	1.37	*
281	dl	1.11	* @param tasks the collection of tasks
282			* @param timeout the maximum time to wait
283			* @param unit the time unit of the timeout argument
284	jsr166	1.37	* @return the result returned by one of the tasks.
285	dl	1.15	* @throws InterruptedException if interrupted while waiting
286	dl	1.17	* @throws NullPointerException if tasks, any of its elements, or
287	jsr166	1.37	* unit are <tt>null</tt>
288	dl	1.15	* @throws TimeoutException if the given timeout elapses before
289	jsr166	1.37	* any task successfully completes
290	dl	1.15	* @throws ExecutionException if no task successfully completes
291			* @throws RejectedExecutionException if tasks cannot be scheduled
292	jsr166	1.37	* for execution
293	dl	1.11	*/
294	jsr166	1.33	<T> T invokeAny(Collection<Callable<T>> tasks,
295			long timeout, TimeUnit unit)
296	dl	1.15	throws InterruptedException, ExecutionException, TimeoutException;
297	dl	1.1	}