Scala 3/scala/scala.concurrent/Awaitable

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

Members list

Value members

Abstract methods

Await the "completed" state of this Awaitable.

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

Value parameters

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

Attributes

Returns: this Awaitable
Throws: IllegalArgumentException if atMost is Duration.Undefined

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

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

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

Value parameters

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

Attributes

Returns: the result value if the Awaitable is completed within the specific maximum wait time
Throws: IllegalArgumentException if atMost is Duration.Undefined

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

In this article

Generated with