Packages

trait Fiber[A] extends cats.effect.Fiber[Task, A]

Fiber represents the (pure) result of a Task being started concurrently and that can be either joined or cancelled.

You can think of fibers as being lightweight threads, a fiber being a concurrency primitive for doing cooperative multi-tasking.

For example a Fiber value is the result of evaluating Task.start:

val task = Task.evalAsync(println("Hello!"))

val forked: Task[Fiber[Unit]] = task.start

Usage example:

val launchMissiles = Task(println("Missiles launched!"))
val runToBunker = Task(println("Run Lola run!"))

for {
  fiber <- launchMissiles.start
  _ <- runToBunker.onErrorHandleWith { error =>
    // Retreat failed, cancel launch (maybe we should
    // have retreated to our bunker before the launch?)
    fiber.cancel.flatMap(_ => Task.raiseError(error))
  }
  aftermath <- fiber.join
} yield {
  aftermath
}
Source
Fiber.scala
Linear Supertypes
cats.effect.Fiber[Task, A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Fiber
  2. Fiber
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def cancel: CancelToken[Task]

    Triggers the cancellation of the fiber.

    Triggers the cancellation of the fiber.

    Returns a new task that will complete when the cancellation is sent (but not when it is observed or acted upon).

    Note that if the background process that's evaluating the result of the underlying fiber is already complete, then there's nothing to cancel.

    Definition Classes
    Fiber → Fiber
  2. abstract def join: Task[A]

    Returns a new task that will await for the completion of the underlying fiber, (asynchronously) blocking the current run-loop until that result is available.

    Returns a new task that will await for the completion of the underlying fiber, (asynchronously) blocking the current run-loop until that result is available.

    Definition Classes
    Fiber → Fiber

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  14. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  15. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  16. def toString(): String
    Definition Classes
    AnyRef → Any
  17. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  18. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  19. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from cats.effect.Fiber[Task, A]

Inherited from AnyRef

Inherited from Any

Ungrouped