Await
Await is what is used to ensure proper handling of blocking forAwaitable instances.
While occasionally useful, e.g. for testing, it is recommended that you avoid Await whenever possible— instead favoring combinators and/or callbacks. Await'sresult andready methods will block the calling thread's execution until they return, which will cause performance degradation, and possibly, deadlock issues.
Attributes
- Source
- package.scala
- Graph
- Supertypes
- Self type
- Await.type
Members list
Value members
Concrete methods
Await the "completed" state of anAwaitable.
Await the "completed" state of anAwaitable.
Although this method is blocking, the internal use ofblocking ensures that the underlyingExecutionContext is given an opportunity to properly manage the blocking.
WARNING: It is strongly discouraged to supply lengthy timeouts since the progress of the calling thread will be suspended—blocked—until either theAwaitable becomes ready or the timeout expires.
Value parameters
- atMost
maximum wait time, which may be negative (no waiting is done),Duration.Inf for unbounded waiting, or a finite positive duration
- awaitable
the
Awaitableto be awaited
Attributes
- Returns
the
awaitable- Throws
IllegalArgumentExceptionif
atMostisDuration.UndefinedInterruptedException if the current thread is interrupted while waiting
TimeoutExceptionif after waiting for the specified time this
Awaitableis still not ready- Source
- package.scala
Await and return the result (of typeT) of anAwaitable.
Await and return the result (of typeT) of anAwaitable.
Although this method is blocking, the internal use ofblocking ensures that the underlyingExecutionContext is given an opportunity to properly manage the blocking.
WARNING: It is strongly discouraged to supply lengthy timeouts since the progress of the calling thread will be suspended—blocked—until either theAwaitable has a result or the timeout expires.
Value parameters
- atMost
maximum wait time, which may be negative (no waiting is done),Duration.Inf for unbounded waiting, or a finite positive duration
- awaitable
the
Awaitableto be awaited
Attributes
- Returns
the result value if
awaitableis completed within the specific maximum wait time- Throws
IllegalArgumentExceptionif
atMostisDuration.UndefinedInterruptedException if the current thread is interrupted while waiting
TimeoutExceptionif after waiting for the specified time
awaitableis still not ready- Source
- package.scala