final class CountdownLatch extends AnyRef
A synchronization aid that allows one or more fibers to wait until a set of operations being performed in other fibers completes.
A CountDownLatch
is initialized with a given count. The await
method
block until the current count reaches zero due to invocations of the
countDown
method, after which all waiting fibers are released and any
subsequent invocations of await
return immediately. This is a one-shot
phenomenon -- the count cannot be reset. If you need a version that resets
the count, consider using a CyclicBarrier.
A CountDownLatch
is a versatile synchronization tool and can be used for a
number of purposes. A CountDownLatch
initialized with a count of one serves
as a simple on/off latch, or gate: all fibers invoking await
wait at the
gate until it is opened by a fiber invoking countDown
. A CountDownLatch
initialized to N can be used to make one fiber wait until N fibers have
completed some action, or some action has been completed N times.
A useful property of a CountDownLatch
is that it doesn't require that
fibers calling countDown
wait for the count to reach zero before
proceeding, it simply prevents any fiber from proceeding past an await
until all fibers could pass.
- Alphabetic
- By Inheritance
- CountdownLatch
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- val await: UIO[Unit]
Causes the current fiber to wait until the latch has counted down to zero
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val count: UIO[Int]
Returns the current count
- val countDown: UIO[Unit]
Decrements the count of the latch, releasing all waiting fibers if the count reaches zero
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()