CyclicBarrier

cats.effect.std.CyclicBarrier
See theCyclicBarrier companion object
abstract class CyclicBarrier[F[_]]

A synchronization abstraction that allows a set of fibers to wait until they all reach a certain point.

A cyclic barrier is initialized with a positive integer capacity n and a fiber waits by calling await, at which point it is semantically blocked until a total of n fibers are blocked on the same cyclic barrier.

At this point all the fibers are unblocked and the cyclic barrier is reset, allowing it to be used again.

Attributes

Companion:
object
Source:
CyclicBarrier.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type

Members list

Concise view

Value members

Abstract methods

def await: F[Unit]

Possibly semantically block until the cyclic barrier is full

Possibly semantically block until the cyclic barrier is full

Attributes

Source:
CyclicBarrier.scala

Concrete methods

def mapK[G[_]](f: FunctionK[F, G]): CyclicBarrier[G]

Modifies the context in which this cyclic barrier is executed using the natural transformation f.

Modifies the context in which this cyclic barrier is executed using the natural transformation f.

Attributes

Returns:

a cyclic barrier in the new context obtained by mapping the current one using the natural transformation f

Source:
CyclicBarrier.scala