/usr/share/doc/libbackport-util-concurrent-java/api/edu/emory/mathcs/backport/java/util/concurrent/ExecutorCompletionService.html is in libbackport-util-concurrent-java-doc 3.1-3build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_03) on Fri May 18 11:21:07 UTC 2012 -->
<title>ExecutorCompletionService</title>
<meta name="date" content="2012-05-18">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="ExecutorCompletionService";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Executor.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Executors.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?edu/emory/mathcs/backport/java/util/concurrent/ExecutorCompletionService.html" target="_top">Frames</a></li>
<li><a href="ExecutorCompletionService.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">edu.emory.mathcs.backport.java.util.concurrent</div>
<h2 title="Class ExecutorCompletionService" class="title">Class ExecutorCompletionService</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>edu.emory.mathcs.backport.java.util.concurrent.ExecutorCompletionService</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/CompletionService.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">CompletionService</a></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">ExecutorCompletionService</span>
extends java.lang.Object
implements <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/CompletionService.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">CompletionService</a></pre>
<div class="block">A <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/CompletionService.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><code>CompletionService</code></a> that uses a supplied <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Executor.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><code>Executor</code></a>
to execute tasks. This class arranges that submitted tasks are,
upon completion, placed on a queue accessible using <tt>take</tt>.
The class is lightweight enough to be suitable for transient use
when processing groups of tasks.
<p>
<b>Usage Examples.</b>
Suppose you have a set of solvers for a certain problem, each
returning a value of some type <tt>Result</tt>, and would like to
run them concurrently, processing the results of each of them that
return a non-null value, in some method <tt>use(Result r)</tt>. You
could write this as:
<pre>
void solve(Executor e,
Collection<Callable<Result>> solvers)
throws InterruptedException, ExecutionException {
CompletionService<Result> ecs
= new ExecutorCompletionService<Result>(e);
for (Callable<Result> s : solvers)
ecs.submit(s);
int n = solvers.size();
for (int i = 0; i < n; ++i) {
Result r = ecs.take().get();
if (r != null)
use(r);
}
}
</pre>
Suppose instead that you would like to use the first non-null result
of the set of tasks, ignoring any that encounter exceptions,
and cancelling all other tasks when the first one is ready:
<pre>
void solve(Executor e,
Collection<Callable<Result>> solvers)
throws InterruptedException {
CompletionService<Result> ecs
= new ExecutorCompletionService<Result>(e);
int n = solvers.size();
List<Future<Result>> futures
= new ArrayList<Future<Result>>(n);
Result result = null;
try {
for (Callable<Result> s : solvers)
futures.add(ecs.submit(s));
for (int i = 0; i < n; ++i) {
try {
Result r = ecs.take().get();
if (r != null) {
result = r;
break;
}
} catch (ExecutionException ignore) {}
}
}
finally {
for (Future<Result> f : futures)
f.cancel(true);
}
if (result != null)
use(result);
}
</pre></div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ExecutorCompletionService.html#ExecutorCompletionService(edu.emory.mathcs.backport.java.util.concurrent.Executor)">ExecutorCompletionService</a></strong>(<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Executor.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Executor</a> executor)</code>
<div class="block">Creates an ExecutorCompletionService using the supplied
executor for base task execution and a
<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/LinkedBlockingQueue.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><code>LinkedBlockingQueue</code></a> as a completion queue.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ExecutorCompletionService.html#ExecutorCompletionService(edu.emory.mathcs.backport.java.util.concurrent.Executor, edu.emory.mathcs.backport.java.util.concurrent.BlockingQueue)">ExecutorCompletionService</a></strong>(<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Executor.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Executor</a> executor,
<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a> completionQueue)</code>
<div class="block">Creates an ExecutorCompletionService using the supplied
executor for base task execution and the supplied queue as its
completion queue.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Future</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ExecutorCompletionService.html#poll()">poll</a></strong>()</code>
<div class="block">Retrieves and removes the Future representing the next
completed task or <tt>null</tt> if none are present.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Future</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ExecutorCompletionService.html#poll(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">poll</a></strong>(long timeout,
<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a> unit)</code>
<div class="block">Retrieves and removes the Future representing the next
completed task, waiting if necessary up to the specified wait
time if none are yet present.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Future</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ExecutorCompletionService.html#submit(edu.emory.mathcs.backport.java.util.concurrent.Callable)">submit</a></strong>(<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Callable.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Callable</a> task)</code>
<div class="block">Submits a value-returning task for execution and returns a Future
representing the pending results of the task.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Future</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ExecutorCompletionService.html#submit(java.lang.Runnable, java.lang.Object)">submit</a></strong>(java.lang.Runnable task,
java.lang.Object result)</code>
<div class="block">Submits a Runnable task for execution and returns a Future
representing that task.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Future</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/ExecutorCompletionService.html#take()">take</a></strong>()</code>
<div class="block">Retrieves and removes the Future representing the next
completed task, waiting if none are yet present.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ExecutorCompletionService(edu.emory.mathcs.backport.java.util.concurrent.Executor)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>ExecutorCompletionService</h4>
<pre>public ExecutorCompletionService(<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Executor.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Executor</a> executor)</pre>
<div class="block">Creates an ExecutorCompletionService using the supplied
executor for base task execution and a
<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/LinkedBlockingQueue.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><code>LinkedBlockingQueue</code></a> as a completion queue.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>executor</code> - the executor to use</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if executor is <tt>null</tt></dd></dl>
</li>
</ul>
<a name="ExecutorCompletionService(edu.emory.mathcs.backport.java.util.concurrent.Executor, edu.emory.mathcs.backport.java.util.concurrent.BlockingQueue)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ExecutorCompletionService</h4>
<pre>public ExecutorCompletionService(<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Executor.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Executor</a> executor,
<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/BlockingQueue.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">BlockingQueue</a> completionQueue)</pre>
<div class="block">Creates an ExecutorCompletionService using the supplied
executor for base task execution and the supplied queue as its
completion queue.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>executor</code> - the executor to use</dd><dd><code>completionQueue</code> - the queue to use as the completion queue
normally one dedicated for use by this service. This queue is
treated as unbounded -- failed attempted <tt>Queue.add</tt>
operations for completed taskes cause them not to be
retrievable.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if executor or completionQueue are <tt>null</tt></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="submit(edu.emory.mathcs.backport.java.util.concurrent.Callable)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>submit</h4>
<pre>public <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Future</a> submit(<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Callable.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Callable</a> task)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/CompletionService.html#submit(edu.emory.mathcs.backport.java.util.concurrent.Callable)">CompletionService</a></code></strong></div>
<div class="block">Submits a value-returning task for execution and returns a Future
representing the pending results of the task. Upon completion,
this task may be taken or polled.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/CompletionService.html#submit(edu.emory.mathcs.backport.java.util.concurrent.Callable)">submit</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/CompletionService.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">CompletionService</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>task</code> - the task to submit</dd>
<dt><span class="strong">Returns:</span></dt><dd>a Future representing pending completion of the task</dd></dl>
</li>
</ul>
<a name="submit(java.lang.Runnable, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>submit</h4>
<pre>public <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Future</a> submit(java.lang.Runnable task,
java.lang.Object result)</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/CompletionService.html#submit(java.lang.Runnable, java.lang.Object)">CompletionService</a></code></strong></div>
<div class="block">Submits a Runnable task for execution and returns a Future
representing that task. Upon completion, this task may be
taken or polled.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/CompletionService.html#submit(java.lang.Runnable, java.lang.Object)">submit</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/CompletionService.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">CompletionService</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>task</code> - the task to submit</dd><dd><code>result</code> - the result to return upon successful completion</dd>
<dt><span class="strong">Returns:</span></dt><dd>a Future representing pending completion of the task,
and whose <tt>get()</tt> method will return the given
result value upon completion</dd></dl>
</li>
</ul>
<a name="take()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>take</h4>
<pre>public <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Future</a> take()
throws java.lang.InterruptedException</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/CompletionService.html#take()">CompletionService</a></code></strong></div>
<div class="block">Retrieves and removes the Future representing the next
completed task, waiting if none are yet present.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/CompletionService.html#take()">take</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/CompletionService.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">CompletionService</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the Future representing the next completed task</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code> - if interrupted while waiting</dd></dl>
</li>
</ul>
<a name="poll()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>poll</h4>
<pre>public <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Future</a> poll()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/CompletionService.html#poll()">CompletionService</a></code></strong></div>
<div class="block">Retrieves and removes the Future representing the next
completed task or <tt>null</tt> if none are present.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/CompletionService.html#poll()">poll</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/CompletionService.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">CompletionService</a></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the Future representing the next completed task, or
<tt>null</tt> if none are present</dd></dl>
</li>
</ul>
<a name="poll(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>poll</h4>
<pre>public <a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Future.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">Future</a> poll(long timeout,
<a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/TimeUnit.html" title="class in edu.emory.mathcs.backport.java.util.concurrent">TimeUnit</a> unit)
throws java.lang.InterruptedException</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/CompletionService.html#poll(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">CompletionService</a></code></strong></div>
<div class="block">Retrieves and removes the Future representing the next
completed task, waiting if necessary up to the specified wait
time if none are yet present.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/CompletionService.html#poll(long, edu.emory.mathcs.backport.java.util.concurrent.TimeUnit)">poll</a></code> in interface <code><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/CompletionService.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent">CompletionService</a></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>timeout</code> - how long to wait before giving up, in units of
<tt>unit</tt></dd><dd><code>unit</code> - a <tt>TimeUnit</tt> determining how to interpret the
<tt>timeout</tt> parameter</dd>
<dt><span class="strong">Returns:</span></dt><dd>the Future representing the next completed task or
<tt>null</tt> if the specified waiting time elapses
before one is present</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.InterruptedException</code> - if interrupted while waiting</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Executor.html" title="interface in edu.emory.mathcs.backport.java.util.concurrent"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../../../edu/emory/mathcs/backport/java/util/concurrent/Executors.html" title="class in edu.emory.mathcs.backport.java.util.concurrent"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../../../index.html?edu/emory/mathcs/backport/java/util/concurrent/ExecutorCompletionService.html" target="_top">Frames</a></li>
<li><a href="ExecutorCompletionService.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
</body>
</html>
|