ExecutorCompletionService? Why do need one if we have invokeAll?

Using a ExecutorCompletionService.poll/take, you are receiving the Futures as they finish, in completion order (more or less). Using ExecutorService.invokeAll, you do not have this power; you either block until are all completed, or you specify a timeout after which the incomplete are cancelled.

static class SleepingCallable implements Callable<String> {  final String name;  final long period;  SleepingCallable(final String name, final long period) {    this.name = name;    this.period = period;  }  public String call() {    try {      Thread.sleep(period);    } catch (InterruptedException ex) { }    return name;  }}

Now, below I will demonstrate how invokeAll works:

final ExecutorService pool = Executors.newFixedThreadPool(2);final List<? extends Callable<String>> callables = Arrays.asList(    new SleepingCallable("quick", 500),    new SleepingCallable("slow", 5000));try {  for (final Future<String> future : pool.invokeAll(callables)) {    System.out.println(future.get());  }} catch (ExecutionException | InterruptedException ex) { }pool.shutdown();

This produces the following output:

C:\dev\scrap>java CompletionExample... after 5 s ...quickslow

Using CompletionService, we see a different output:

final ExecutorService pool = Executors.newFixedThreadPool(2);final CompletionService<String> service = new ExecutorCompletionService<String>(pool);final List<? extends Callable<String>> callables = Arrays.asList(    new SleepingCallable("slow", 5000),    new SleepingCallable("quick", 500));for (final Callable<String> callable : callables) {  service.submit(callable);}pool.shutdown();try {  while (!pool.isTerminated()) {    final Future<String> future = service.take();    System.out.println(future.get());  }} catch (ExecutionException | InterruptedException ex) { }

This produces the following output:

C:\dev\scrap>java CompletionExample... after 500 ms ...quick... after 5 s ...slow

Note the times are relative to program start, not the previous message.

You can find full code on both here.

So why are there 2 different ways to submit a series of tasks? Am I correct that performance wise they are equivalent? Is there a case that one is more suitable than the other? I can't think of one.

By using an ExecutorCompletionService, you can get immediately notified when each of your jobs completes. In comparison, ExecutorService.invokeAll(...) waits for all of your jobs to complete before returning the collection of Futures. This means that (for example), if all but one job completes in 10 minutes but 1 job takes 30 minutes, you will get no results for 30 minutes.

// this waits until _all_ of the jobs completeList<Future<Object>> futures = threadPool.invokeAll(...);

Instead, when you use a ExecutorCompletionService, you will be able to get the jobs as soon as each of them completes which allows you to (for example) send them on for processing into another thread pool, log results immediately, etc..

ExecutorService threadPool = Executors.newFixedThreadPool(2);ExecutorCompletionService<Result> compService      = new ExecutorCompletionService<Result>(threadPool);for (MyJob job : jobs) {    compService.submit(job);}// shutdown the pool but the jobs submitted continue to runthreadPool.shutdown();while (true) {    Future<Result> future;    // if pool has terminated (all jobs finished after shutdown) then poll() else take()    if (threadPool.isTerminated()) {        future = compService.poll();        if (future == null) {            break;        }    } else {        // the take() blocks until any of the jobs complete        // this joins with the jobs in the order they _finish_        future = compService.take();    }    // this get() won't block    Result result = future.get();    // you can then put the result in some other thread pool or something    // to immediately start processing it    someOtherThreadPool.submit(new SomeNewJob(result));}

I haven't ever actually used ExecutorCompletionService, but I think the case where this could be more useful than "normal" ExecutorService would be when you want to receive the Futures of completed tasks in completion order. With invokeAll, you just get a list that can contain a mix of incomplete and completed tasks at any given time.