Класс CountDownLatch

Справочный инструмент синхронизации, позволяющий одной или нескольким потокам ожидать завершения набора операций, выполняемых в других потоках.

Объект CountDownLatch инициализируется заданным значением count. Методы await блокируют выполнение, пока текущее значение count не достигнет нуля в результате вызовов метода countDown(). После этого все ожидающие потоки освобождаются, и последующие вызовы await возвращаются немедленно. Это одноразовое явление — значение count не может быть сброшено. Если вам нужна версия, которая сбрасывает значение count, рассмотрите использование CyclicBarrier.

Объект CountDownLatch — это универсальный инструмент синхронизации, который можно использовать для различных целей. Объект CountDownLatch с инициализированным значением count равным единице служит простым замком или воротами включения/выключения: все потоки, вызывающие await, ожидают в воротах, пока они не откроются потоком, вызывающим countDown(). Объект CountDownLatch с инициализированным значением N может использоваться для того, чтобы один поток ожидал завершения N потоков, выполнивших некоторое действие, или же пока данное действие было выполнено N раз.

Полезное свойство объекта CountDownLatch заключается в том, что потоки, вызывающие countDown , не требуют ожидания, пока значение count достигнет нуля для продолжения работы; он просто не позволяет ни одному потоку пройти дальше вызова await, пока все потоки не смогут пройти.

Пример использования: Ниже представлены два класса, в которых группа потоков-работников использует два объекта CountDownLatch:

• Первый — это сигнал старта, который не позволяет ни одному работнику продолжить работу, пока драйвер не подготовится к их запуску;
• Второй — это сигнал завершения, который позволяет драйверу ожидать завершения работы всех работников.

class Driver { // ...
   void main() throws InterruptedException {
     CountDownLatch startSignal = new CountDownLatch(1);
     CountDownLatch doneSignal = new CountDownLatch(N);

     for (int i = 0; i < N; ++i) // create and start threads
       new Thread(new Worker(startSignal, doneSignal)).start();

     doSomethingElse();            // don't let run yet
     startSignal.countDown();      // let all threads proceed
     doSomethingElse();
     doneSignal.await();           // wait for all to finish
   }
 }

 class Worker implements Runnable {
   private final CountDownLatch startSignal;
   private final CountDownLatch doneSignal;
   Worker(CountDownLatch startSignal, CountDownLatch doneSignal) {
     this.startSignal = startSignal;
     this.doneSignal = doneSignal;
   }
   public void run() {
     try {
       startSignal.await();
       doWork();
       doneSignal.countDown();
     } catch (InterruptedException ex) {} // return;
   }

   void doWork() { ... }
 }

Другим распространенным случаем использования является разделение задачи на N частей, описание каждой части с помощью Runnable, который выполняет эту часть и уменьшает значение счётчика на этом замке, и помещение всех Runnable в Executor. Когда все подзадачи будут завершены, координирующий поток сможет пройти через await. (Когда потоки должны многократно уменьшать счётчик таким образом, используйте CyclicBarrier.)

class Driver2 { // ...
   void main() throws InterruptedException {
     CountDownLatch doneSignal = new CountDownLatch(N);
     Executor e = ...

     for (int i = 0; i < N; ++i) // create and start threads
       e.execute(new WorkerRunnable(doneSignal, i));

     doneSignal.await();           // wait for all to finish
   }
 }

 class WorkerRunnable implements Runnable {
   private final CountDownLatch doneSignal;
   private final int i;
   WorkerRunnable(CountDownLatch doneSignal, int i) {
     this.doneSignal = doneSignal;
     this.i = i;
   }
   public void run() {
     try {
       doWork(i);
       doneSignal.countDown();
     } catch (InterruptedException ex) {} // return;
   }

   void doWork() { ... }
 }

Влияние согласованности памяти: до тех пор, пока значение счетчика не достигнет нуля, действия в потоке до вызова countDown() предшествуют действиям после успешного возвращения из соответствующего await() в другом потоке.

Подробное описание конструкторов

CountDownLatch

public CountDownLatch(int count)

Создаёт объект CountDownLatch с заданным значением count.

Параметры:

count - количество вызовов countDown(), необходимое для того, чтобы потоки могли пройти через await()

Исключения:

IllegalArgumentException - если count отрицательно

Подробное описание методов

await

public void await()
           throws InterruptedException

Исключения:

InterruptedException - если текущий поток прерывается во время ожидания

await

public boolean await(long timeout,
                     TimeUnit unit)
              throws InterruptedException

Параметры:

timeout - максимальное время ожидания

unit - единица измерения времени для аргумента timeout

Возвращает:

true если счётчик достиг нуля, и false если время ожидания истекло до достижения нуля

Исключения:

InterruptedException - если текущий поток прерывается во время ожидания

countDown

public void countDown()

getCount

public long getCount()

Возвращает:

текущее значение счётчика

toString

public String toString()

Возвращает строку, идентифицирующую этот замок, а также его состояние. Состояние, в скобках, включает строку "Count =" и текущее значение счётчика.

Переопределяет:

toString в классе Object

Возвращает:

строку, идентифицирующую этот замок, а также его состояние