final class Promise[E, A] extends AnyVal
A promise represents an asynchronous variable that can be set exactly once,
with the ability for an arbitrary number of fibers to suspend (by calling
get) and automatically resume when the variable is set.
Promises can be used for building primitive actions whose completions require the coordinated action of multiple fibers, and for building higher-level concurrent or asynchronous structures.
for { promise <- Promise.make[Nothing, Int] _ <- promise.complete(42).delay(1.second).fork value <- promise.get // Resumes when forked fiber completes promise } yield value
- Alphabetic
- By Inheritance
- Promise
- AnyVal
- Any
- Hide All
- Show All
- Public
- All
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- Any
- final def ##(): Int
- Definition Classes
- Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- final def await: IO[E, A]
Retrieves the value of the promise, suspending the fiber running the action until the result is available.
- final def done(io: IO[E, A]): UIO[Boolean]
Completes the promise with the specified result.
Completes the promise with the specified result. If the specified promise has already been completed, the method will produce false.
- final def fail(e: E): UIO[Boolean]
Fails the promise with the specified error, which will be propagated to all fibers waiting on the value of the promise.
- def getClass(): Class[_ <: AnyVal]
- Definition Classes
- AnyVal → Any
- final def interrupt: UIO[Boolean]
Completes the promise with interruption.
Completes the promise with interruption. This will interrupt all fibers waiting on the value of the promise.
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def poll: UIO[Option[IO[E, A]]]
Completes immediately this promise and returns optionally it's result.
- final def succeed(a: A): UIO[Boolean]
Completes the promise with the specified value.
- def toString(): String
- Definition Classes
- Any