Awaitable

scala.concurrent.Awaitable
trait Awaitable[+T]

An object that may eventually be completed with a result value of type T which may be awaited using blocking methods.

The Await object provides methods that allow accessing the result of an Awaitable by blocking the current thread until the Awaitable has been completed or a timeout has occurred.

Attributes

Source:
Awaitable.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Future[T]
object never.type

Members list

Concise view

Value members

Abstract methods

def ready(atMost: Duration)(implicit permit: CanAwait): Awaitable.this.type

Await the "completed" state of this Awaitable.

Await the "completed" state of this Awaitable.

This method should not be called directly; use Await.ready instead.

Attributes

atMost

maximum wait time, which may be negative (no waiting is done), Duration.Inf for unbounded waiting, or a finite positive duration

Returns:

this Awaitable

Throws:

InterruptedException if the current thread is interrupted while waiting

TimeoutException if after waiting for the specified time this Awaitable is still not ready

Source:
Awaitable.scala
def result(atMost: Duration)(implicit permit: CanAwait): T

Await and return the result (of type T) of this Awaitable.

Await and return the result (of type T) of this Awaitable.

This method should not be called directly; use Await.result instead.

Attributes

atMost

maximum wait time, which may be negative (no waiting is done), Duration.Inf for unbounded waiting, or a finite positive duration

Returns:

the result value if the Awaitable is completed within the specific maximum wait time

Throws:

InterruptedException if the current thread is interrupted while waiting

TimeoutException if after waiting for the specified time this Awaitable is still not ready

Source:
Awaitable.scala