Packages

class FutureTask[A] extends Promise[A] with Runnable

Linear Supertypes
Runnable, Promise[A], Updatable[Try[A]], Responder[A], Future[A], Awaitable[A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FutureTask
  2. Runnable
  3. Promise
  4. Updatable
  5. Responder
  6. Future
  7. Awaitable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FutureTask(fn: ⇒ A)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addEventListener(listener: FutureEventListener[_ >: A]): Future[A]

    Register a FutureEventListener to be invoked when the computation completes.

    Register a FutureEventListener to be invoked when the computation completes. This method is typically used by Java programs because it avoids the use of small Function objects.

    Definition Classes
    Future
    Note

    this should be used for side-effects

    See also

    transformedBy for a Java friendly way to produce a new Future from the result of a computation.

    respond for a Scala API.

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def become(other: Future[A]): Unit

    Become the other promise.

    Become the other promise. become declares an equivalence relation: this and other are the same.

    By becoming other, its waitlists are now merged into this's, and this becomes canonical. The same is true of interrupt handlers: other's interrupt handler is overwritten with the handlers installed for this.

    Note: Using become and setInterruptHandler on the same promise is not recommended. Consider the following, which demonstrates unexpected behavior related to this usage.

    val a, b = new Promise[Unit]
    a.setInterruptHandler { case _ => println("A") }
    b.become(a)
    b.setInterruptHandler { case _ => println("B") }
    a.raise(new Exception)

    This prints "B", the action in the interrupt handler for b, which is unexpected because we raised on a. In this case and others, using com.twitter.util.Future.proxyTo may be more appropriate.

    Note that this must be unsatisfied at the time of the call, and not race with any other setters. become is a form of satisfying the promise.

    This has the combined effect of compressing the other into this, effectively providing a form of tail-call elimination when used in recursion constructs. transform (and thus any other combinator) use this to compress Futures, freeing them from space leaks when used with recursive constructions.

    Note: do not use become with cyclic graphs of futures: the behavior of racing a.become(b) with b.become(a) is undefined (where a and b may resolve as such transitively).

    Definition Classes
    Promise
    See also

    com.twitter.util.Future.proxyTo

  7. def before[B](f: ⇒ Future[B])(implicit ev: <:<[FutureTask.this.type, Future[Unit]]): Future[B]

    Sequentially compose this with f.

    Sequentially compose this with f. This is as flatMap, but discards the result of this. Note that this applies only Unit-valued Futures — i.e. side-effects.

    Definition Classes
    Future
  8. def by(timer: Timer, when: Time, exc: ⇒ Throwable): Future[A]

    Returns a new Future that fails if it is not satisfied before the given time.

    Returns a new Future that fails if it is not satisfied before the given time.

    Note: On timeout, the underlying future is not interrupted.

    timer

    to run timeout on.

    when

    indicates when to stop waiting for the result to be available.

    exc

    exception to throw.

    Definition Classes
    Future
  9. def by(timer: Timer, when: Time): Future[A]

    Returns a new Future that fails if it is not satisfied before the given time.

    Returns a new Future that fails if it is not satisfied before the given time.

    Note: On timeout, the underlying future is not interrupted.

    Definition Classes
    Future
  10. def by(when: Time)(implicit timer: Timer): Future[A]

    Returns a new Future that fails if it is not satisfied before the given time.

    Returns a new Future that fails if it is not satisfied before the given time.

    Same as the other by, but with an implicit timer. Sometimes this is more convenient.

    Note: On timeout, the underlying future is not interrupted.

    Definition Classes
    Future
  11. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  12. final def compress(): Promise[A]

    Should only be called when this Promise has already been fulfilled or it is becoming another Future via become.

    Should only be called when this Promise has already been fulfilled or it is becoming another Future via become.

    Attributes
    protected
    Definition Classes
    Promise
  13. final def continue(k: K[A]): Unit
    Attributes
    protected
    Definition Classes
    PromiseResponder
    Annotations
    @tailrec()
  14. final def continueAll(wq: WaitQueue[A]): Unit
    Attributes
    protected
    Definition Classes
    Responder
  15. def delayed(howlong: Duration)(implicit timer: Timer): Future[A]

    Delay the completion of this Future for at least howlong from now.

    Delay the completion of this Future for at least howlong from now.

    Definition Classes
    Future
  16. final def depth: Short
    Attributes
    protected[com.twitter.util]
    Definition Classes
    PromiseResponder
  17. final def detach(k: K[A]): Boolean
    Attributes
    protected[com.twitter.util.Promise]
    Definition Classes
    Promise
    Annotations
    @tailrec()
  18. def ensure(f: ⇒ Unit): Future[A]

    Invoked regardless of whether the computation completed successfully or unsuccessfully.

    Invoked regardless of whether the computation completed successfully or unsuccessfully. Implemented in terms of respond so that subclasses control evaluation order. Returns a chained Future.

    The returned Future will be satisfied when this, the original future, is done.

    f

    the side-effect to apply when the computation completes.

    Definition Classes
    Future
    Note

    this should be used for side-effects.

    See also

    respond if you need the result of the computation for usage in the side-effect.

  19. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  21. def filter(p: (A) ⇒ Boolean): Future[A]
    Definition Classes
    Future
  22. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  23. def flatMap[B](f: (A) ⇒ Future[B]): Future[B]

    If this, the original future, succeeds, run f on the result.

    If this, the original future, succeeds, run f on the result.

    The returned result is a Future that is satisfied when the original future and the callback, f, are done. If the original future fails, this one will also fail, without executing f and preserving the failed computation of this.

    Definition Classes
    Future
    See also

    map

  24. def flatten[B](implicit ev: <:<[A, Future[B]]): Future[B]

    Converts a Future[Future[B]] into a Future[B].

    Converts a Future[Future[B]] into a Future[B].

    Definition Classes
    Future
  25. def foreach(k: (A) ⇒ Unit): Future[A]

    Invoke the callback only if the Future returns successfully.

    Invoke the callback only if the Future returns successfully. Useful for Scala for comprehensions. Use onSuccess instead of this method for more readable code.

    Definition Classes
    Future
    See also

    onSuccess

  26. final def forwardInterruptsTo(other: Future[_]): Unit

    Forward interrupts to another future.

    Forward interrupts to another future. If the other future is fulfilled, this is a no-op. Calling this multiple times is not recommended as the resulting state may not be as expected.

    other

    the Future to which interrupts are forwarded.

    Definition Classes
    Promise
    Annotations
    @tailrec()
  27. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. def handle[B >: A](rescueException: PartialFunction[Throwable, B]): Future[B]

    If this, the original future, results in an exceptional computation, rescueException may convert the failure into a new result.

    If this, the original future, results in an exceptional computation, rescueException may convert the failure into a new result.

    The returned result is a Future that is satisfied when the original future and the callback, rescueException, are done.

    This is the equivalent of map for failed computations.

    Definition Classes
    Future
    See also

    rescue

  29. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  30. def interruptible(): Future[A]

    Makes a derivative Future which will be satisfied with the result of the parent.

    Makes a derivative Future which will be satisfied with the result of the parent. However, if it's interrupted, it will detach from the parent Future, satisfy itself with the exception raised to it, and won't propagate the interruption back to the parent Future.

    This is useful for when a Future is shared between many contexts, where it may not be useful to discard the underlying computation if just one context is no longer interested in the result. In particular, this is different from Future.masked in that it will prevent memory leaks if the parent Future will never be satisfied, because closures that are attached to this derivative Future will not be held onto by the killer Future.

    Definition Classes
    Future
  31. def isDefined: Boolean

    Is the result of the Future available yet?

    Is the result of the Future available yet?

    Definition Classes
    PromiseFuture
  32. def isDone(implicit ev: <:<[FutureTask.this.type, Future[Unit]]): Boolean

    Checks whether a Unit-typed Future is done.

    Checks whether a Unit-typed Future is done. By convention, futures of type Future[Unit] are used for signalling.

    Definition Classes
    Future
  33. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  34. def isInterrupted: Option[Throwable]

    Returns this promise's interrupt if it is interrupted.

    Returns this promise's interrupt if it is interrupted.

    Definition Classes
    Promise
  35. def isReady(implicit permit: CanAwait): Boolean

    Is this Awaitable ready? In other words: would calling Awaitable.ready block?

    Is this Awaitable ready? In other words: would calling Awaitable.ready block?

    Definition Classes
    PromiseAwaitable
  36. def join[B](other: Future[B]): Future[(A, B)]

    Joins this future with a given other future into a Future[(A, B)] (future of a Tuple2).

    Joins this future with a given other future into a Future[(A, B)] (future of a Tuple2). If this or other future fails, the returned Future is immediately satisfied by that failure.

    Definition Classes
    Future
  37. def joinWith[B, C](other: Future[B])(fn: (A, B) ⇒ C): Future[C]

    Joins this future with a given other future and applies fn to its result.

    Joins this future with a given other future and applies fn to its result. If this or other future fails, the returned Future is immediately satisfied by that failure.

    Before (using join):

    val ab = a.join(b).map { case (a, b) => Foo(a, b) }

    After (using joinWith):

    val ab = a.joinWith(b)(Foo.apply)
    Definition Classes
    Future
  38. def liftToTry: Future[Try[A]]

    Returns the result of the computation as a Future[Try[A]].

    Returns the result of the computation as a Future[Try[A]].

    Definition Classes
    Future
  39. final def link(target: Promise[A]): Unit
    Attributes
    protected
    Definition Classes
    Promise
    Annotations
    @tailrec()
  40. def lowerFromTry[B](implicit ev: <:<[A, Try[B]]): Future[B]

    Lowers a Future[Try[T]] into a Future[T].

    Lowers a Future[Try[T]] into a Future[T].

    Definition Classes
    Future
  41. def map[B](f: (A) ⇒ B): Future[B]

    If this, the original future, succeeds, run f on the result.

    If this, the original future, succeeds, run f on the result.

    The returned result is a Future that is satisfied when the original future and the callback, f, are done. If the original future fails, this one will also fail, without executing f and preserving the failed computation of this.

    Definition Classes
    Future
    See also

    onSuccess for side-effecting chained computations.

    flatMap for computations that return Futures.

  42. def mask(pred: PartialFunction[Throwable, Boolean]): Future[A]

    Returns an identical future except that it ignores interrupts which match a predicate

    Returns an identical future except that it ignores interrupts which match a predicate

    Definition Classes
    Future
  43. def masked: Future[A]

    Returns an identical future that ignores all interrupts

    Returns an identical future that ignores all interrupts

    Definition Classes
    Future
  44. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  45. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  46. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  47. def onFailure(fn: (Throwable) ⇒ Unit): Future[A]

    Invoke the function on the error, if the computation was unsuccessful.

    Invoke the function on the error, if the computation was unsuccessful. Returns a chained Future as in respond.

    returns

    chained Future

    Definition Classes
    Future
    Note

    if fn is a PartialFunction and the input is not defined for a given Throwable, the resulting MatchError will propagate to the current Monitor. This will happen if you use a construct such as future.onFailure { case NonFatal(e) => ... } when the Throwable is "fatal".

    ,

    this should be used for side-effects.

    See also

    handle and rescue to produce a new Future from the result of the computation.

  48. def onSuccess(f: (A) ⇒ Unit): Future[A]

    Invoke the function on the result, if the computation was successful.

    Invoke the function on the result, if the computation was successful. Returns a chained Future as in respond.

    returns

    chained Future

    Definition Classes
    Future
    Note

    this should be used for side-effects.

    See also

    flatMap and map to produce a new Future from the result of the computation.

  49. def or[U >: A](other: Future[U]): Future[U]

    A synonym for select: Choose the first Future to be satisfied.

    A synonym for select: Choose the first Future to be satisfied.

    Definition Classes
    Future
  50. final def parent: Promise[A]
    Attributes
    protected
    Definition Classes
    PromiseResponder
  51. def poll: Option[Try[A]]

    Polls for an available result.

    Polls for an available result. If the Future has been satisfied, returns Some(result), otherwise None.

    Definition Classes
    PromiseFuture
  52. def proxyTo[B >: A](other: Promise[B]): Unit

    Send updates from this Future to the other.

    Send updates from this Future to the other. other must not yet be satisfied at the time of the call. After this call, nobody else should satisfy other.

    Definition Classes
    Future
    Note

    using proxyTo will mask interrupts to this future, and it's the user's responsibility to set an interrupt handler on other to raise on f. In some cases, using com.twitter.util.Promise.become may be more appropriate.

    See also

    com.twitter.util.Promise.become

  53. final def raise(intr: Throwable): Unit

    Raise the given throwable as an interrupt.

    Raise the given throwable as an interrupt. Interrupts are one-shot and latest-interrupt wins. That is, the last interrupt to have been raised is delivered exactly once to the Promise responsible for making progress on the future (multiple such promises may be involved in flatMap chains).

    Raising an interrupt does not alter the externally observable state of the Future. They are used to signal to the producer of the future's value that the result is no longer desired (for whatever reason given in the passed Throwable).

    Definition Classes
    PromiseFuture
    Annotations
    @tailrec()
  54. def raiseWithin(timer: Timer, timeout: Duration, exc: Throwable): Future[A]

    Returns a new Future that fails if this Future does not return in time.

    Returns a new Future that fails if this Future does not return in time.

    Note: On timeout, the underlying future is interrupted.

    Definition Classes
    Future
  55. def raiseWithin(timeout: Duration, exc: Throwable)(implicit timer: Timer): Future[A]

    Returns a new Future that fails if this Future does not return in time.

    Returns a new Future that fails if this Future does not return in time.

    Same as the other raiseWithin, but with an implicit timer. Sometimes this is more convenient.

    Note: On timeout, the underlying future is interrupted.

    Definition Classes
    Future
  56. def raiseWithin(timeout: Duration)(implicit timer: Timer): Future[A]

    Returns a new Future that fails if this Future does not return in time.

    Returns a new Future that fails if this Future does not return in time.

    Same as the other raiseWithin, but with an implicit timer. Sometimes this is more convenient.

    Note: On timeout, the underlying future is interrupted.

    Definition Classes
    Future
  57. def ready(timeout: Duration)(implicit permit: CanAwait): FutureTask.this.type

    Support for Await.ready.

    Support for Await.ready. The use of the implicit permit is an access control mechanism: only Await.ready may call this method.

    Definition Classes
    PromiseAwaitable
    Annotations
    @throws( classOf[TimeoutException] ) @throws( classOf[InterruptedException] )
  58. def rescue[B >: A](rescueException: PartialFunction[Throwable, Future[B]]): Future[B]

    If this, the original future, results in an exceptional computation, rescueException may convert the failure into a new result.

    If this, the original future, results in an exceptional computation, rescueException may convert the failure into a new result.

    The returned result is a Future that is satisfied when the original future and the callback, rescueException, are done.

    This is the equivalent of flatMap for failed computations.

    Definition Classes
    Future
    See also

    handle

  59. def respond(k: (Try[A]) ⇒ Unit): Future[A]

    Note: exceptions in responds are monitored.

    Note: exceptions in responds are monitored. That is, if the computation k throws a raw (ie. not encoded in a Future) exception, it is handled by the current monitor, see Monitor for details.

    Definition Classes
    Responder
  60. def result(timeout: Duration)(implicit permit: CanAwait): A

    Support for Await.result.

    Support for Await.result. The use of the implicit permit is an access control mechanism: only Await.result may call this method.

    Definition Classes
    PromiseAwaitable
    Annotations
    @throws( classOf[Exception] )
  61. def run(): Unit
    Definition Classes
    FutureTask → Runnable
  62. def select[U >: A](other: Future[U]): Future[U]

    Choose the first Future to be satisfied.

    Choose the first Future to be satisfied.

    other

    another Future

    returns

    a new Future whose result is that of the first of this and other to return

    Definition Classes
    Future
  63. def setDone()(implicit ev: <:<[FutureTask.this.type, Promise[Unit]]): Boolean

    Sets a Unit-typed future.

    Sets a Unit-typed future. By convention, futures of type Future[Unit] are used for signalling.

    Definition Classes
    Promise
  64. def setException(throwable: Throwable): Unit

    Populate the Promise with the given exception.

    Populate the Promise with the given exception.

    Definition Classes
    Promise
    Exceptions thrown

    ImmutableResult if the Promise is already populated

  65. final def setInterruptHandler(f: PartialFunction[Throwable, Unit]): Unit

    (Re)sets the interrupt handler.

    (Re)sets the interrupt handler. There is only one active interrupt handler.

    f

    the new interrupt handler

    Definition Classes
    Promise
    Annotations
    @tailrec()
  66. def setValue(result: A): Unit

    Populate the Promise with the given result.

    Populate the Promise with the given result.

    Definition Classes
    Promise
    Exceptions thrown

    ImmutableResult if the Promise is already populated

  67. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  68. def toJavaFuture: java.util.concurrent.Future[_ <: A]

    Convert a Twitter Future to a Java native Future.

    Convert a Twitter Future to a Java native Future. This should match the semantics of a Java Future as closely as possible to avoid issues with the way another API might use them. See:

    http://download.oracle.com/javase/6/docs/api/java/util/concurrent/Future.html#cancel(boolean)

    Definition Classes
    Future
  69. def toOffer: Offer[Try[A]]

    An Offer for this future.

    An Offer for this future.

    The offer is activated when the future is satisfied.

    Definition Classes
    Future
  70. def toString(): String
    Definition Classes
    Promise → AnyRef → Any
  71. def transform[B](f: (Try[A]) ⇒ Future[B]): Future[B]
    Definition Classes
    Responder
  72. def transformedBy[B](transformer: FutureTransformer[A, B]): Future[B]

    Transform the Future[A] into a Future[B] using the FutureTransformer.

    Transform the Future[A] into a Future[B] using the FutureTransformer. The FutureTransformer handles both success (Return) and failure (Throw) values by implementing map/flatMap and handle/rescue. This method is typically used by Java programs because it avoids the use of small Function objects.

    Definition Classes
    Future
    Note

    The FutureTransformer must implement either flatMap or map and may optionally implement handle. Failing to implement a method will result in a run-time error (AbstractMethodError).

    See also

    addEventListener for a Java friendly way to perform side-effects.

    transform for a Scala API.

  73. def unit: Future[Unit]

    Convert this Future[A] to a Future[Unit] by discarding the result.

    Convert this Future[A] to a Future[Unit] by discarding the result.

    Definition Classes
    Future
    Note

    failed futures will remain as is.

  74. def update(result: Try[A]): Unit

    Populate the Promise with the given Try.

    Populate the Promise with the given Try. The try can either be a value or an exception. setValue and setException are generally more readable methods to use.

    Definition Classes
    PromiseUpdatable
    Exceptions thrown

    ImmutableResult if the Promise is already populated

  75. final def updateIfEmpty(result: Try[A]): Boolean

    Populate the Promise with the given Try.

    Populate the Promise with the given Try. The Try can either be a value or an exception. setValue and setException are generally more readable methods to use.

    returns

    true only if the result is updated, false if it was already set.

    Definition Classes
    Promise
    Annotations
    @tailrec()
    Note

    Invoking updateIfEmpty without checking the boolean result is almost never the right approach. Doing so is generally unsafe unless race conditions are acceptable.

  76. def useLifoContinuations: Boolean
    Attributes
    protected
    Definition Classes
    Promise
  77. def voided: Future[Void]

    Convert this Future[A] to a Future[Void] by discarding the result.

    Convert this Future[A] to a Future[Void] by discarding the result.

    Definition Classes
    Future
    Note

    failed futures will remain as is.

  78. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  79. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  80. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  81. def willEqual[B](that: Future[B]): Future[Boolean]

    Returns a Future[Boolean] indicating whether two Futures are equivalent.

    Returns a Future[Boolean] indicating whether two Futures are equivalent.

    Note that

    Future.exception(e).willEqual(Future.exception(e)) == Future.value(true)

    .

    Future.exception(e).willEqual(Future.exception(e)) == Future.value(true) }}}

    Definition Classes
    Future
  82. def withFilter(p: (A) ⇒ Boolean): Future[A]
    Definition Classes
    Future
  83. def within(timer: Timer, timeout: Duration, exc: ⇒ Throwable): Future[A]

    Returns a new Future that fails if it is not satisfied in time.

    Returns a new Future that fails if it is not satisfied in time.

    Note: On timeout, the underlying future is not interrupted.

    timer

    to run timeout on.

    timeout

    indicates how long you are willing to wait for the result to be available.

    exc

    exception to throw.

    Definition Classes
    Future
  84. def within(timer: Timer, timeout: Duration): Future[A]

    Returns a new Future that fails if it is not satisfied in time.

    Returns a new Future that fails if it is not satisfied in time.

    Note: On timeout, the underlying future is not interrupted.

    Definition Classes
    Future
  85. def within(timeout: Duration)(implicit timer: Timer): Future[A]

    Returns a new Future that fails if it is not satisfied in time.

    Returns a new Future that fails if it is not satisfied in time.

    Same as the other within, but with an implicit timer. Sometimes this is more convenient.

    Note: On timeout, the underlying future is not interrupted.

    Definition Classes
    Future

Inherited from Runnable

Inherited from Promise[A]

Inherited from Updatable[Try[A]]

Inherited from Responder[A]

Inherited from Future[A]

Inherited from Awaitable[A]

Inherited from AnyRef

Inherited from Any

Ungrouped