Promise

gears.async.Future.Promise
See thePromise companion object
trait Promise[T] extends Future[T]

A promise is a Future that is be completed manually via the complete method.

Attributes

See also

Promise$.apply to create a new, empty promise.

Future.withResolver to create a passive Future from callback-style asynchronous calls.

Companion
object
Graph
Supertypes
trait Future[T]
trait Cancellable
class OriginalSource[Try[T]]
trait Source[Try[T]]
class Object
trait Matchable
class Any
Show all

Members list

Value members

Abstract methods

def complete(result: Try[T]): Unit

Define the result value of future.

Define the result value of future.

Attributes

Concrete methods

inline def asFuture: Future[T]

Inherited methods

final def awaitResult(using ac: Async): Try[T]

Waits for an item to arrive from the source. Suspends until an item returns.

Waits for an item to arrive from the source. Suspends until an item returns.

This is an utility method for direct waiting with Async, instead of going through listeners.

Attributes

Inherited from:
Source
def onComplete(k: Listener[Try[T]]): Unit

Once data is available, pass it to the listener k. onComplete is always non-blocking.

Once data is available, pass it to the listener k. onComplete is always non-blocking.

Note that k's methods will be executed on the same thread as the Source, usually in sequence. It is hence important that the listener itself does not perform expensive operations.

Attributes

Inherited from:
OriginalSource
def poll(): Option[Try[T]]

Similar to poll, but instead of passing in a listener, directly return the value T if it is available.

Similar to poll, but instead of passing in a listener, directly return the value T if it is available.

Attributes

Inherited from:
Source

Inherited and Abstract methods

protected def addListener(k: Listener[Try[T]]): Unit

Add k to the listener set of this source.

Add k to the listener set of this source.

Attributes

Inherited from:
OriginalSource
def cancel(): Unit

Issue a cancel request

Issue a cancel request

Attributes

Inherited from:
Cancellable
def dropListener(k: Listener[Try[T]]): Unit

Signal that listener k is dead (i.e. will always fail to acquire locks from now on), and should be removed from onComplete queues.

Signal that listener k is dead (i.e. will always fail to acquire locks from now on), and should be removed from onComplete queues.

This permits original, (i.e. non-derived) sources like futures or channels to drop the listener from their waiting sets.

Attributes

Inherited from:
Source
def poll(k: Listener[Try[T]]): Boolean

Checks whether data is available at present and pass it to k if so. Calls to poll are always synchronous and non-blocking.

Checks whether data is available at present and pass it to k if so. Calls to poll are always synchronous and non-blocking.

The process is as follows:

  • If no data is immediately available, return false immediately.
  • If there is data available, attempt to lock k.
    • If k is no longer available, true is returned to signal this source's general availability.
    • If locking k succeeds:
      • If data is still available, complete k and return true.
      • Otherwise, unlock k and return false.

Note that in all cases, a return value of false indicates that k should be put into onComplete to receive data in a later point in time.

Attributes

Returns

Whether poll was able to pass data to k. Note that this is regardless of k being available to receive the data. In most cases, one should pass k into Source!.onComplete if poll returns false.

Inherited from:
Source