akka.dispatch

CompletableFuture

trait CompletableFuture [T] extends Future[T]

Essentially this is the Promise (or write-side) of a Future (read-side).

Linear Supertypes
Future[T], Future[T], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. CompletableFuture
  2. Future
  3. Future
  4. AnyRef
  5. Any
Visibility
  1. Public
  2. All

Abstract Value Members

  1. def await (atMost: Duration): Future[T]

    Blocks the current thread until the Future has been completed or the timeout has expired, additionally bounding the waiting period according to the atMost parameter.

    Blocks the current thread until the Future has been completed or the timeout has expired, additionally bounding the waiting period according to the atMost parameter. The timeout will be the lesser value of 'atMost' and the timeout supplied at the constructuion of this Future. In the case of the timeout expiring a FutureTimeoutException will be thrown. Other callers of this method are not affected by the additional bound imposed by atMost.

    Attributes
    abstract
    Definition Classes
    Future
  2. def await : Future[T]

    Blocks the current thread until the Future has been completed or the timeout has expired.

    Blocks the current thread until the Future has been completed or the timeout has expired. In the case of the timeout expiring a FutureTimeoutException will be thrown.

    Attributes
    abstract
    Definition Classes
    Future
  3. def complete (value: Either[Throwable, T]): CompletableFuture.this.type

    Completes this Future with the specified result, if not already completed.

    Completes this Future with the specified result, if not already completed.

    returns

    this

    Attributes
    abstract
  4. implicit def dispatcher : MessageDispatcher

    Attributes
    implicit abstract
    Definition Classes
    Future
  5. def isExpired : Boolean

    Tests whether this Future's timeout has expired.

    Tests whether this Future's timeout has expired.

    Note that an expired Future may still contain a value, or it may be completed with a value.

    Attributes
    abstract
    Definition Classes
    Future
  6. def onComplete (func: (Future[T]) ⇒ Unit): CompletableFuture.this.type

    When this Future is completed, apply the provided function to the Future.

    When this Future is completed, apply the provided function to the Future. If the Future has already been completed, this will apply immediately. Will not be called in case of a timeout, which also holds if corresponding Promise is attempted to complete after expiry. Multiple callbacks may be registered; there is no guarantee that they will be executed in a particular order.

    Attributes
    abstract
    Definition Classes
    Future
  7. def onTimeout (func: (Future[T]) ⇒ Unit): CompletableFuture.this.type

    Registers a function that will be executed when this Future times out.

    Registers a function that will be executed when this Future times out.

       future onTimeout {
         f => doSomethingOnTimeout(f)
       }
    

    Attributes
    abstract
    Definition Classes
    Future
  8. def timeoutInNanos : Long

    This Future's timeout in nanoseconds.

    This Future's timeout in nanoseconds.

    Attributes
    abstract
    Definition Classes
    Future
  9. def value : Option[Either[Throwable, T]]

    The contained value of this Future.

    The contained value of this Future. Before this Future is completed the value will be None. After completion the value will be Some(Right(t)) if it contains a valid result, or Some(Left(error)) if it contains an exception.

    Attributes
    abstract
    Definition Classes
    Future

Concrete Value Members

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

    Attributes
    final
    Definition Classes
    AnyRef
  2. def != (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  3. def ## (): Int

    Attributes
    final
    Definition Classes
    AnyRef → Any
  4. def << (other: Future[T]): akka.dispatch.Future[T] @util.continuations.package.cps[akka.dispatch.Future[Any]]

    Attributes
    final
  5. def << (value: T): akka.dispatch.Future[T] @util.continuations.package.cps[akka.dispatch.Future[Any]]

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

    Attributes
    final
    Definition Classes
    AnyRef
  7. def == (arg0: Any): Boolean

    Attributes
    final
    Definition Classes
    Any
  8. def apply [A >: T] (): A @util.continuations.package.cps[akka.dispatch.Future[Any]]

    For use only within a Future.

    For use only within a Future.flow block or another compatible Delimited Continuations reset block.

    Returns the result of this Future without blocking, by suspending execution and storing it as a continuation until the result is available.

    If this Future is untyped (a Future[Nothing]), a type parameter must be explicitly provided or execution will fail. The normal result of getting a Future from an ActorRef using ? will return an untyped Future.

    Definition Classes
    Future
  9. def as [A] (implicit m: Manifest[A]): Option[A]

    Await completion of this Future and return its value if it conforms to A's erased type.

    Await completion of this Future and return its value if it conforms to A's erased type. Will throw a ClassCastException if the value does not conform, or any exception the Future was completed with. Will return None in case of a timeout.

    Definition Classes
    Future
  10. def asInstanceOf [T0] : T0

    Attributes
    final
    Definition Classes
    Any
  11. def asSilently [A] (implicit m: Manifest[A]): Option[A]

    Await completion of this Future and return its value if it conforms to A's erased type, None otherwise.

    Await completion of this Future and return its value if it conforms to A's erased type, None otherwise. Will throw any exception the Future was completed with. Will return None in case of a timeout.

    Definition Classes
    Future
  12. def clone (): AnyRef

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  13. def completeWith (other: Future[T]): CompletableFuture.this.type

    Completes this Future with the specified other Future, when that Future is completed, unless this Future has already been completed.

    Completes this Future with the specified other Future, when that Future is completed, unless this Future has already been completed.

    returns

    this.

    Attributes
    final
  14. def completeWithException (exception: Throwable): CompletableFuture.this.type

    Completes this Future with the specified exception, if not already completed.

    Completes this Future with the specified exception, if not already completed.

    returns

    this

    Attributes
    final
  15. def completeWithResult (result: T): CompletableFuture.this.type

    Completes this Future with the specified result, if not already completed.

    Completes this Future with the specified result, if not already completed.

    returns

    this

    Attributes
    final
  16. def eq (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  17. def equals (arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  18. def exception : Option[Throwable]

    Returns the contained exception of this Future if it exists.

    Returns the contained exception of this Future if it exists.

    Attributes
    final
    Definition Classes
    Future
  19. def filter (p: (Any) ⇒ Boolean): Future[Any]

    Attributes
    final
    Definition Classes
    Future
  20. def finalize (): Unit

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
  21. def flatMap [A] (f: (T) ⇒ Future[A]): Future[A]

    Creates a new Future by applying a function to the successful result of this Future, and returns the result of the function as the new Future.

    Creates a new Future by applying a function to the successful result of this Future, and returns the result of the function as the new Future. If this Future is completed with an exception then the new Future will also contain this exception. Example:

    val future1 = for {
      a: Int    <- actor ? "Hello" // returns 5
      b: String <- actor ? a       // returns "10"
      c: String <- actor ? 7       // returns "14"
    } yield b + "-" + c
    

    Attributes
    final
    Definition Classes
    Future
  22. def foreach (f: (T) ⇒ Unit): Unit

    Attributes
    final
    Definition Classes
    Future
  23. def get : T

    Blocks awaiting completion of this Future, then returns the resulting value, or throws the completed exception

    Blocks awaiting completion of this Future, then returns the resulting value, or throws the completed exception

    Scala & Java API

    throws FutureTimeoutException if this Future times out when waiting for completion

    Definition Classes
    Future
  24. def getClass (): java.lang.Class[_]

    Attributes
    final
    Definition Classes
    AnyRef → Any
  25. def hashCode (): Int

    Definition Classes
    AnyRef → Any
  26. def isCompleted : Boolean

    Tests whether this Future has been completed.

    Tests whether this Future has been completed.

    Attributes
    final
    Definition Classes
    Future
  27. def isInstanceOf [T0] : Boolean

    Attributes
    final
    Definition Classes
    Any
  28. def map [A] (f: (T) ⇒ A): Future[A]

    Creates a new Future by applying a function to the successful result of this Future.

    Creates a new Future by applying a function to the successful result of this Future. If this Future is completed with an exception then the new Future will also contain this exception. Example:

    val future1 = for {
      a: Int    <- actor ? "Hello" // returns 5
      b: String <- actor ? a       // returns "10"
      c: String <- actor ? 7       // returns "14"
    } yield b + "-" + c
    

    Attributes
    final
    Definition Classes
    Future
  29. def mapTo [A] (implicit m: Manifest[A]): Future[A]

    Creates a new Future[A] which is completed with this Future's result if that conforms to A's erased type or a ClassCastException otherwise.

    Creates a new Future[A] which is completed with this Future's result if that conforms to A's erased type or a ClassCastException otherwise.

    Attributes
    final
    Definition Classes
    Future
  30. def ne (arg0: AnyRef): Boolean

    Attributes
    final
    Definition Classes
    AnyRef
  31. def notify (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  32. def notifyAll (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
  33. def onException (pf: PartialFunction[Throwable, Unit]): CompletableFuture.this.type

    When the future is completed with an exception, apply the provided PartialFunction to the exception.

    When the future is completed with an exception, apply the provided PartialFunction to the exception. See onComplete for more details.

      future onException {
        case NumberFormatException ⇒ target ! "wrong format"
      }
    

    Attributes
    final
    Definition Classes
    Future
  34. def onResult (pf: PartialFunction[T, Unit]): CompletableFuture.this.type

    When the future is completed with a valid result, apply the provided PartialFunction to the result.

    When the future is completed with a valid result, apply the provided PartialFunction to the result. See onComplete for more details.

      future onResult {
        case Foo ⇒ target ! "foo"
        case Bar ⇒ target ! "bar"
      }
    

    Attributes
    final
    Definition Classes
    Future
  35. def recover [A >: T] (pf: PartialFunction[Throwable, A]): Future[A]

    Creates a new Future that will handle any matching Throwable that this Future might contain.

    Creates a new Future that will handle any matching Throwable that this Future might contain. If there is no match, or if this Future contains a valid result then the new Future will contain the same. Example:

    Future(6 / 0) failure { case e: ArithmeticException ⇒ 0 } // result: 0
    Future(6 / 0) failure { case e: NotFoundException   ⇒ 0 } // result: exception
    Future(6 / 2) failure { case e: ArithmeticException ⇒ 0 } // result: 3
    

    Attributes
    final
    Definition Classes
    Future
  36. def result : Option[T]

    Returns the successful result of this Future if it exists.

    Returns the successful result of this Future if it exists.

    Attributes
    final
    Definition Classes
    Future
  37. def resultOrException : Option[T]

    Returns the current result, throws the exception is one has been raised, else returns None

    Returns the current result, throws the exception is one has been raised, else returns None

    Attributes
    final
    Definition Classes
    Future
  38. def synchronized [T0] (arg0: ⇒ T0): T0

    Attributes
    final
    Definition Classes
    AnyRef
  39. def toString (): String

    Definition Classes
    AnyRef → Any
  40. def wait (): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  41. def wait (arg0: Long, arg1: Int): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()
  42. def wait (arg0: Long): Unit

    Attributes
    final
    Definition Classes
    AnyRef
    Annotations
    @throws()

Deprecated Value Members

  1. def collect [A] (pf: PartialFunction[T, A]): Future[A]

    Creates a new Future by applying a PartialFunction to the successful result of this Future if a match is found, or else return a MatchError.

    Creates a new Future by applying a PartialFunction to the successful result of this Future if a match is found, or else return a MatchError. If this Future is completed with an exception then the new Future will also contain this exception. Example:

    val future1 = for {
      a <- actor ? Req("Hello") collect { case Res(x: Int)    ⇒ x }
      b <- actor ? Req(a)       collect { case Res(x: String) ⇒ x }
      c <- actor ? Req(7)       collect { case Res(x: String) ⇒ x }
    } yield b + "-" + c
    

    Attributes
    final
    Definition Classes
    Future
    Annotations
    @deprecated
    Deprecated

    No longer needed, use 'map' instead. Removed in 2.0

  2. def failure [A >: T] (pf: PartialFunction[Throwable, A]): Future[A]

    Creates a new Future that will handle any matching Throwable that this Future might contain.

    Creates a new Future that will handle any matching Throwable that this Future might contain. If there is no match, or if this Future contains a valid result then the new Future will contain the same. Example:

    Future(6 / 0) failure { case e: ArithmeticException ⇒ 0 } // result: 0
    Future(6 / 0) failure { case e: NotFoundException   ⇒ 0 } // result: exception
    Future(6 / 2) failure { case e: ArithmeticException ⇒ 0 } // result: 3
    

    Attributes
    final
    Definition Classes
    Future
    Annotations
    @deprecated
    Deprecated

    will be replaced by recover

  3. def receive (pf: PartialFunction[Any, Unit]): CompletableFuture.this.type

    When the future is completed with a valid result, apply the provided PartialFunction to the result.

    When the future is completed with a valid result, apply the provided PartialFunction to the result. See onComplete for more details.

      future receive {
        case Foo ⇒ target ! "foo"
        case Bar ⇒ target ! "bar"
      }
    

    Attributes
    final
    Definition Classes
    Future
    Annotations
    @deprecated
    Deprecated

    Use onResult instead, will be removed in the future

Inherited from Future[T]

Inherited from Future[T]

Inherited from AnyRef

Inherited from Any