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