Fiber

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
}

Linear Supertypes

cats.effect.Fiber[Task, A], AnyRef, Any

Abstract Value Members

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
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

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[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
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( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object Fiber | package eval

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

Abstract Value Members

abstract def cancel: CancelToken[Task]

abstract def join: Task[A]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

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

Inherited from AnyRef

Inherited from Any

Ungrouped