public interface java.util.concurrent
CompletionService<V>


Hide details Login
Java SE 6
  
Implemented by: ExecutorCompletionService

A service that decouples the production of new asynchronous tasks from the consumption of the results of completed tasks. Producers submit tasks for execution. Consumers take completed tasks and process their results in the order they complete. A CompletionService can for example be used to manage asynchronous IO, in which tasks that perform reads are submitted in one part of a program or system, and then acted upon in a different part of the program when the reads complete, possibly in a different order than they were requested.

Typically, a CompletionService relies on a separate Executor to actually execute the tasks, in which case the CompletionService only manages an internal completion queue. The ExecutorCompletionService class provides an implementation of this approach.

Memory consistency effects: Actions in a thread prior to submitting a task to a CompletionService happen-before actions taken by that task, which in turn happen-before actions following a successful return from the corresponding take().


Methods
public Future poll()
Retrieves and removes the Future representing the next completed task or null if none are present.
returnthe Future representing the next completed task, or null if none are present
public Future poll(long timeout, TimeUnit unit) throws InterruptedException
Retrieves and removes the Future representing the next completed task, waiting if necessary up to the specified wait time if none are yet present.
timeouthow long to wait before giving up, in units of unit
unita TimeUnit determining how to interpret the timeout parameter
returnthe Future representing the next completed task or null if the specified waiting time elapses before one is present
ThrowsInterruptedException: if interrupted while waiting
public Future submit(Callable task)
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.
taskthe task to submit
returna Future representing pending completion of the task
ThrowsRejectedExecutionException: if the task cannot be scheduled for execution
ThrowsNullPointerException: if the task is null
public Future submit(Runnable task, Object result)
Submits a Runnable task for execution and returns a Future representing that task. Upon completion, this task may be taken or polled.
taskthe task to submit
resultthe result to return upon successful completion
returna Future representing pending completion of the task, and whose get() method will return the given result value upon completion
ThrowsRejectedExecutionException: if the task cannot be scheduled for execution
ThrowsNullPointerException: if the task is null
public Future take() throws InterruptedException
Retrieves and removes the Future representing the next completed task, waiting if none are yet present.
returnthe Future representing the next completed task
ThrowsInterruptedException: if interrupted while waiting