sample/java.util.concurrent.CompletionService.txt

   1 *java.util.concurrent.CompletionService* *CompletionService* A service that deco
   2
   3 public interface interface CompletionService
   4
   5
   6 |java.util.concurrent.CompletionService_Description|
   7 |java.util.concurrent.CompletionService_Fields|
   8 |java.util.concurrent.CompletionService_Constructors|
   9 |java.util.concurrent.CompletionService_Methods|
  10
  11 ================================================================================
  12
  13 *java.util.concurrent.CompletionService_Methods*
  14 |java.util.concurrent.CompletionService.poll()|Retrieves and removes the Future
  15 |java.util.concurrent.CompletionService.poll(long,TimeUnit)|Retrieves and remov
  16 |java.util.concurrent.CompletionService.submit(Callable)|Submits a value-return
  17 |java.util.concurrent.CompletionService.submit(Runnable,V)|Submits a Runnable t
  18 |java.util.concurrent.CompletionService.take()|Retrieves and removes the Future
  19
  20 *java.util.concurrent.CompletionService_Description*
  21
  22 A service that decouples the production of new asynchronous tasks from the
  23 consumption of the results of completed tasks. Producers submit tasks for
  24 execution. Consumers take completed tasks and process their results in the
  25 order they complete. A CompletionService can for example be used to manage
  26 asynchronous IO, in which tasks that perform reads are submitted in one part of
  27 a program or system, and then acted upon in a different part of the program
  28 when the reads complete, possibly in a different order than they were
  29 requested.
  30
  31
  32
  33 Typically, a CompletionService relies on a separate
  34 (|java.util.concurrent.Executor|) to actually execute the tasks, in which case
  35 the CompletionService only manages an internal completion queue. The
  36 (|java.util.concurrent.ExecutorCompletionService|) class provides an
  37 implementation of this approach.
  38
  39
  40 *java.util.concurrent.CompletionService.poll()*
  41
  42 public |java.util.concurrent.Future| poll()
  43
  44 Retrieves and removes the Future representing the next completed task or null
  45 if none are present.
  46
  47
  48     Returns: the Future representing the next completed task, or null if none are present.
  49 *java.util.concurrent.CompletionService.poll(long,TimeUnit)*
  50
  51 public |java.util.concurrent.Future| poll(
  52   long timeout,
  53   java.util.concurrent.TimeUnit unit)
  54   throws |java.lang.InterruptedException|
  55
  56 Retrieves and removes the Future representing the next completed task, waiting
  57 if necessary up to the specified wait time if none are yet present.
  58
  59     timeout - how long to wait before giving up, in units of unit
  60     unit - a TimeUnit determining how to interpret the timeout parameter
  61
  62     Returns: the Future representing the next completed task or null if the specified
  63              waiting time elapses before one is present.
  64 *java.util.concurrent.CompletionService.submit(Callable)*
  65
  66 public |java.util.concurrent.Future| submit(java.util.concurrent.Callable task)
  67
  68 Submits a value-returning task for execution and returns a Future representing
  69 the pending results of the task. Upon completion, this task may be taken or
  70 polled.
  71
  72     task - the task to submit
  73
  74     Returns: a Future representing pending completion of the task
  75 *java.util.concurrent.CompletionService.submit(Runnable,V)*
  76
  77 public |java.util.concurrent.Future| submit(
  78   java.lang.Runnable task,
  79   java.lang.Object result)
  80
  81 Submits a Runnable task for execution and returns a Future representing that
  82 task.Upon completion, this task may be taken or polled.
  83
  84     task - the task to submit
  85     result - the result to return upon successful completion
  86
  87     Returns: a Future representing pending completion of the task, and whose get() method
  88              will return the given result value upon completion
  89 *java.util.concurrent.CompletionService.take()*
  90
  91 public |java.util.concurrent.Future| take()
  92   throws |java.lang.InterruptedException|
  93
  94 Retrieves and removes the Future representing the next completed task, waiting
  95 if none are yet present.
  96
  97
  98     Returns: the Future representing the next completed task
  99