- java.lang.Object
-
- java.util.concurrent.ExecutorCompletionService<V>
-
- All Implemented Interfaces:
- CompletionService<V>
public class ExecutorCompletionService<V> extends Object implements CompletionService<V>
ACompletionService
that uses a suppliedExecutor
to execute tasks. This class arranges that submitted tasks are, upon completion, placed on a queue accessible usingtake
. The class is lightweight enough to be suitable for transient use when processing groups of tasks.Usage Examples. Suppose you have a set of solvers for a certain problem, each returning a value of some type
Result
, and would like to run them concurrently, processing the results of each of them that return a non-null value, in some methoduse(Result r)
. You could write this as: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); } }
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); }
-
-
Constructor Summary
Constructors Constructor and Description ExecutorCompletionService(Executor executor)
Creates an ExecutorCompletionService using the supplied executor for base task execution and aLinkedBlockingQueue
as a completion queue.ExecutorCompletionService(Executor executor, BlockingQueue<Future<V>> completionQueue)
Creates an ExecutorCompletionService using the supplied executor for base task execution and the supplied queue as its completion queue.
-
Method Summary
Methods Modifier and Type Method and Description Future<V>
poll()
Retrieves and removes the Future representing the next completed task or null if none are present.Future<V>
poll(long timeout, TimeUnit unit)
Retrieves and removes the Future representing the next completed task, waiting if necessary up to the specified wait time if none are yet present.Future<V>
submit(Callable<V> task)
Submits a value-returning task for execution and returns a Future representing the pending results of the task.Future<V>
submit(Runnable task, V result)
Submits a Runnable task for execution and returns a Future representing that task.Future<V>
take()
Retrieves and removes the Future representing the next completed task, waiting if none are yet present.
-
-
-
Constructor Detail
-
ExecutorCompletionService
public ExecutorCompletionService(Executor executor)
Creates an ExecutorCompletionService using the supplied executor for base task execution and aLinkedBlockingQueue
as a completion queue.- Parameters:
executor
- the executor to use- Throws:
NullPointerException
- if executor isnull
-
ExecutorCompletionService
public ExecutorCompletionService(Executor executor, BlockingQueue<Future<V>> completionQueue)
Creates an ExecutorCompletionService using the supplied executor for base task execution and the supplied queue as its completion queue.- Parameters:
executor
- the executor to usecompletionQueue
- the queue to use as the completion queue normally one dedicated for use by this service. This queue is treated as unbounded -- failed attemptedQueue.add
operations for completed taskes cause them not to be retrievable.- Throws:
NullPointerException
- if executor or completionQueue arenull
-
-
Method Detail
-
submit
public Future<V> submit(Callable<V> task)
Description copied from interface:CompletionService
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.- Specified by:
submit
in interfaceCompletionService<V>
- Parameters:
task
- the task to submit- Returns:
- a Future representing pending completion of the task
-
submit
public Future<V> submit(Runnable task, V result)
Description copied from interface:CompletionService
Submits a Runnable task for execution and returns a Future representing that task. Upon completion, this task may be taken or polled.- Specified by:
submit
in interfaceCompletionService<V>
- Parameters:
task
- the task to submitresult
- the result to return upon successful completion- Returns:
- a Future representing pending completion of the task, and whose get() method will return the given result value upon completion
-
take
public Future<V> take() throws InterruptedException
Description copied from interface:CompletionService
Retrieves and removes the Future representing the next completed task, waiting if none are yet present.- Specified by:
take
in interfaceCompletionService<V>
- Returns:
- the Future representing the next completed task
- Throws:
InterruptedException
- if interrupted while waiting
-
poll
public Future<V> poll()
Description copied from interface:CompletionService
Retrieves and removes the Future representing the next completed task or null if none are present.- Specified by:
poll
in interfaceCompletionService<V>
- Returns:
- the Future representing the next completed task, or null if none are present
-
poll
public Future<V> poll(long timeout, TimeUnit unit) throws InterruptedException
Description copied from interface:CompletionService
Retrieves and removes the Future representing the next completed task, waiting if necessary up to the specified wait time if none are yet present.- Specified by:
poll
in interfaceCompletionService<V>
- Parameters:
timeout
- how long to wait before giving up, in units of unitunit
- a TimeUnit determining how to interpret the timeout parameter- Returns:
- the Future representing the next completed task or null if the specified waiting time elapses before one is present
- Throws:
InterruptedException
- if interrupted while waiting
-
-
Nederlandse vertaling
U hebt gevraagd om deze site in het Nederlands te bezoeken. Voor nu wordt alleen de interface vertaald, maar nog niet alle inhoud.Als je me wilt helpen met vertalingen, is je bijdrage welkom. Het enige dat u hoeft te doen, is u op de site registreren en mij een bericht sturen waarin u wordt gevraagd om u toe te voegen aan de groep vertalers, zodat u de gewenste pagina's kunt vertalen. Een link onderaan elke vertaalde pagina geeft aan dat u de vertaler bent en heeft een link naar uw profiel.
Bij voorbaat dank.
Document heeft de 11/06/2005 gemaakt, de laatste keer de 04/03/2020 gewijzigd
Bron van het afgedrukte document:https://www.gaudry.be/nl/java-api-rf-java/util/concurrent/executorcompletionservice.html
De infobrol is een persoonlijke site waarvan de inhoud uitsluitend mijn verantwoordelijkheid is. De tekst is beschikbaar onder CreativeCommons-licentie (BY-NC-SA). Meer info op de gebruiksvoorwaarden en de auteur.
Referenties
Deze verwijzingen en links verwijzen naar documenten die geraadpleegd zijn tijdens het schrijven van deze pagina, of die aanvullende informatie kunnen geven, maar de auteurs van deze bronnen kunnen niet verantwoordelijk worden gehouden voor de inhoud van deze pagina.
De auteur Deze site is als enige verantwoordelijk voor de manier waarop de verschillende concepten, en de vrijheden die met de referentiewerken worden genomen, hier worden gepresenteerd. Vergeet niet dat u meerdere broninformatie moet doorgeven om het risico op fouten te verkleinen.