java.util.concurrent

Class ExecutorCompletionService<V- >

Table des matières
  • All Implemented Interfaces:
    CompletionService<V>

    public class ExecutorCompletionService<V>
extends Object
implements CompletionService<V>
    A CompletionService that uses a supplied Executor to execute tasks. This class arranges that submitted tasks are, upon completion, placed on a queue accessible using take. 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 method use(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);
     }
 }
    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: 
     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);
 }

    • 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 a LinkedBlockingQueue as a completion queue.
        Parameters:
        executor - the executor to use
        Throws:
        NullPointerException - if executor is null

      • 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 use
        completionQueue - the queue to use as the completion queue normally one dedicated for use by this service. This queue is treated as unbounded -- failed attempted Queue.add operations for completed taskes cause them not to be retrievable.
        Throws:
        NullPointerException - if executor or completionQueue are null

    • 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 interface CompletionService<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 interface CompletionService<V>
        Parameters:
        task - the task to submit
        result - 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

      • 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 interface CompletionService<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 interface CompletionService<V>
        Parameters:
        timeout - how long to wait before giving up, in units of unit
        unit - 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

Traduction non disponible

Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.

Version en cache

22/11/2024 03:42:09 Cette version de la page est en cache (à la date du 22/11/2024 03:42:09) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.

Document créé le 07/12/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-java/util/concurrent/ExecutorCompletionService.html

L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.

Références

  1. Consulter le document html Langue du document :fr Manuel PHP : https://docs.oracle.com, ExecutorCompletionService

Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.

Table des matières Haut