trait Supervisor[F[_]] extends AnyRef
A fiber-based supervisor that monitors the lifecycle of all fibers that are started via its interface. The lifecycles of all these spawned fibers are bound to the lifecycle of the Supervisor itself.
Whereas cats.effect.kernel.GenSpawn.background links the lifecycle of the spawned fiber to the calling fiber, starting a fiber via a Supervisor links the lifecycle of the spawned fiber to the supervisor fiber. This is useful when the scope of some fiber must survive the spawner, but should still be confined within some "larger" scope.
The fibers started via the supervisor are guaranteed to be terminated when the supervisor is terminated. When a supervisor is finalized, all active and queued fibers will be safely finalized before finalization of the supervisor is complete.
The following diagrams illustrate the lifecycle of a fiber spawned via cats.effect.kernel.GenSpawn.start, cats.effect.kernel.GenSpawn.background, and Supervisor. In each example, some fiber A is spawning another fiber B. Each box represents the lifecycle of a fiber. If a box is enclosed within another box, it means that the lifecycle of the former is confined within the lifecycle of the latter. In other words, if an outer fiber terminates, the inner fibers are guaranteed to be terminated as well.
start:
Fiber A lifecycle +---------------------+ | | | +-----------------|---+ | |A starts B Fiber B lifecycle | +-----------------|---+ | + | +---------------------+
background:
Fiber A lifecycle +------------------------+ | | | | Fiber B lifecycle |A starts B | +------------------|-+ | | | | | | | +--------------------+ | +------------------------+
Supervisor:
Supervisor lifecycle +---------------------+ | Fiber B lifecycle | | +-----------------+ | | | + | | | +---------------|-+ | +-----------------|---+ | | A starts B Fiber A lifecycle | +-----------------|---+ | | | +---------------------+
Supervisor should be used when fire-and-forget semantics are desired.
- Source
- Supervisor.scala
- Alphabetic
- By Inheritance
- Supervisor
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def supervise[A](fa: F[A]): F[kernel.Fiber[F, Throwable, A]]
Starts the supplied effect
fa
on the supervisor.Starts the supplied effect
fa
on the supervisor.Trying to start an effect with this method on an already finalized supervisor results in an error (inside
F
).- returns
a cats.effect.kernel.Fiber that represents a handle to the started fiber.
Concrete 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
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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()