scala.concurrent

Awaitable

trait Awaitable[+T] extends AnyRef

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.

Source
Awaitable.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
Future
Type Hierarchy Learn more about scaladoc diagrams
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Awaitable
  2. AnyRef
  3. Any
Implicitly
  1. by StringAdd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract 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.

    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

    Annotations
    @throws( clazz = classOf[TimeoutException] ) @throws( clazz = classOf[InterruptedException] )
    Exceptions thrown
    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

  2. abstract 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.

    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

    Annotations
    @throws( clazz = classOf[Exception] )
    Exceptions thrown
    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

Concrete Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Awaitable[T] to StringAdd[Awaitable[T]] performed by method StringAdd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (Awaitable[T], B)

    Implicit information
    This member is added by an implicit conversion from Awaitable[T] to ArrowAssoc[Awaitable[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. def ensuring(cond: (Awaitable[T]) ⇒ Boolean, msg: ⇒ Any): Awaitable[T]

    Implicit information
    This member is added by an implicit conversion from Awaitable[T] to Ensuring[Awaitable[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: (Awaitable[T]) ⇒ Boolean): Awaitable[T]

    Implicit information
    This member is added by an implicit conversion from Awaitable[T] to Ensuring[Awaitable[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean, msg: ⇒ Any): Awaitable[T]

    Implicit information
    This member is added by an implicit conversion from Awaitable[T] to Ensuring[Awaitable[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean): Awaitable[T]

    Implicit information
    This member is added by an implicit conversion from Awaitable[T] to Ensuring[Awaitable[T]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  17. def formatted(fmtstr: String): String

    Returns string formatted according to given format string.

    Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).

    Implicit information
    This member is added by an implicit conversion from Awaitable[T] to StringFormat[Awaitable[T]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  18. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any

  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  21. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  24. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef

  25. def toString(): String

    Definition Classes
    AnyRef → Any

  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. def →[B](y: B): (Awaitable[T], B)

    Implicit information
    This member is added by an implicit conversion from Awaitable[T] to ArrowAssoc[Awaitable[T]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion StringAdd from Awaitable[T] to StringAdd[Awaitable[T]]

Inherited by implicit conversion StringFormat from Awaitable[T] to StringFormat[Awaitable[T]]

Inherited by implicit conversion Ensuring from Awaitable[T] to Ensuring[Awaitable[T]]

Inherited by implicit conversion ArrowAssoc from Awaitable[T] to ArrowAssoc[Awaitable[T]]

Ungrouped