Packages

trait Fiber[F[_], E, A] extends Serializable

A datatype that represents a handle to a fiber and allows for waiting and cancelation against that fiber.

Source
Fiber.scala
See also

GenSpawn documentation for more detailed information on the concurrency of fibers.

Linear Supertypes
Serializable, AnyRef, Any
Known Subclasses
PureFiber
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Fiber
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def cancel: F[Unit]

    Requests the cancelation of the fiber bound to this Fiber handle and awaits its finalization.

    Requests the cancelation of the fiber bound to this Fiber handle and awaits its finalization.

    cancel semantically blocks the caller until finalization of the cancellee has completed. This means that if the cancellee is currently masked, cancel will block until it is unmasked and finalized.

    Cancelation is idempotent, so repeated calls to cancel simply block until finalization is complete. If cancel is called after finalization is complete, it will return immediately.

    cancel is uncancelable; a fiber that is canceling another fiber is masked from cancelation.

    See also

    GenSpawn documentation for more details on cancelation

  2. abstract def join: F[Outcome[F, E, A]]

    Awaits the completion of the fiber bound to this Fiber and returns its Outcome once it completes.

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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  9. final def getClass(): Class[_ <: AnyRef]
    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. def joinWith(onCancel: F[A])(implicit F: MonadCancel[F, E]): F[A]

    Awaits the completion of the bound fiber and returns its result once it completes.

    Awaits the completion of the bound fiber and returns its result once it completes.

    If the fiber completes with Outcome.Succeeded, the successful value is returned. If the fiber completes with Outcome.Errored, the error is raised. If the fiber completes with Outcome.Canceled, onCancel is run.

  13. def joinWithNever(implicit F: GenSpawn[F, E]): F[A]

    Awaits the completion of the bound fiber and returns its result once it completes.

    Awaits the completion of the bound fiber and returns its result once it completes.

    If the fiber completes with Outcome.Succeeded, the successful value is returned. If the fiber completes with Outcome.Errored, the error is raised. If the fiber completes with Outcome.Canceled, the caller is indefinitely suspended without termination.

  14. def joinWithUnit(implicit F: MonadCancel[F, E], ev: <:<[Unit, A]): F[A]

    Awaits the completion of the bound fiber and returns its result once it completes.

    Awaits the completion of the bound fiber and returns its result once it completes.

    If the fiber completes with Outcome.Succeeded, the successful value is returned. If the fiber completes with Outcome.Errored, the error is raised. If the fiber completes with Outcome.Canceled, the result is ignored.

  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  19. def toString(): String
    Definition Classes
    AnyRef → Any
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped