final def !=(arg0: Any): Boolean

Definition Classes: AnyRef → Any

final def ##(): Int

Definition Classes: AnyRef → Any

final def ==(arg0: Any): Boolean

Definition Classes: AnyRef → Any

def addEventListener(listener: FutureEventListener[_ >: String]): Future[String]

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: respond for a Scala API.
transformedBy for a Java friendly way to produce a new Future from the result of a computation.

final def asInstanceOf[T0]: T0

Definition Classes: Any

def become(other: Future[String]): 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

def before[B](f: ⇒ Future[B])(implicit ev: <:<[StringCallbackPromise.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

def by(timer: Timer, when: Time, exc: ⇒ Throwable): Future[String]

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

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

Note: Interrupting a returned future would not prevent it from being satisfied with a given exception (when the time comes).

timer: to run timeout on.
when: indicates when to stop waiting for the result to be available.
exc: exception to throw.

Definition Classes: Future

def by(timer: Timer, when: Time): Future[String]

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

def by(when: Time)(implicit timer: Timer): Future[String]

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

def clone(): AnyRef

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

final def compress(): Promise[String]

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

Attributes: protected
Definition Classes: Promise

final def continue(k: K[String]): Unit

Attributes: protected
Definition Classes: Promise → Responder
Annotations: @tailrec()

final def continueAll(wq: WaitQueue[String]): Unit

Attributes: protected
Definition Classes: Responder

def delayed(howlong: Duration)(implicit timer: Timer): Future[String]

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

Note: Interrupting a returned future would not prevent it from becoming this future (when the time comes).

Definition Classes: Future

final def detach(k: K[String]): Boolean

Attributes: protected[com.twitter.util.Promise]
Definition Classes: Promise
Annotations: @tailrec()

def ensure(f: ⇒ Unit): Future[String]

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.

final def eq(arg0: AnyRef): Boolean

Definition Classes: AnyRef

def equals(arg0: Any): Boolean

Definition Classes: AnyRef → Any

def filter(p: (String) ⇒ Boolean): Future[String]

Definition Classes: Future

def finalize(): Unit

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

def flatMap[B](f: (String) ⇒ Future[B]): Future[B]

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

def flatten[B](implicit ev: <:<[String, Future[B]]): Future[B]

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

Definition Classes: Future

def foreach(k: (String) ⇒ Unit): Future[String]

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

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()

final def getClass(): Class[_]

Definition Classes: AnyRef → Any
Annotations: @native()

def handle[B >: String](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.

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

def hashCode(): Int

Definition Classes: AnyRef → Any
Annotations: @native()

def interruptible(): Future[String]

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
See also: raise
mask
masked

def isDefined: Boolean

Is the result of the Future available yet?

Definition Classes: Promise → Future

def isDone(implicit ev: <:<[StringCallbackPromise.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

final def isInstanceOf[T0]: Boolean

Definition Classes: Any

def isInterrupted: Option[Throwable]

Returns this promise's interrupt if it is interrupted.

Definition Classes: Promise

def isReady(implicit permit: CanAwait): Boolean

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

Definition Classes: Promise → Awaitable

def join[B](other: Future[B]): Future[(String, 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

def joinWith[B, C](other: Future[B])(fn: (String, 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

def liftToTry: Future[Try[String]]

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

Definition Classes: Future

final def link(target: Promise[String]): Unit

Attributes: protected
Definition Classes: Promise
Annotations: @tailrec()

def lowerFromTry[B](implicit ev: <:<[String, Try[B]]): Future[B]

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

Definition Classes: Future

def map[B](f: (String) ⇒ B): Future[B]

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: flatMap for computations that return Futures.
onSuccess for side-effecting chained computations.

def mask(pred: PartialFunction[Throwable, Boolean]): Future[String]

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

This means that a Promise's interrupt handler will not execute on calls to Future.raise for inputs to pred that evaluate to true. Also, raise will not be forwarded to chained Futures.

For example:

val p = new Promise[Int]()
p.setInterruptHandler { case x => println(s"interrupt handler for ${x.getClass}") }
val f1: Future[Int] = p.mask {
  case _: IllegalArgumentException => true
}
f1.raise(new IllegalArgumentException("ignored!")) // nothing will be printed
f1.map(_ + 1).raise(new IllegalArgumentException("ignored!")) // nothing will be printed

val f2: Future[Int] = p.mask {
  case _: IllegalArgumentException => true
}
f2.raise(new Exception("fire!")) // will print "interrupt handler for class java.lang.Exception"

Definition Classes: Future
See also: raise
masked
interruptible()

def masked: Future[String]

Returns an identical Future that ignores all interrupts.

This means that a Promise's interrupt handler will not execute for any call to Future.raise. Also, raise will not be forwarded to chained Futures.

For example:

import com.twitter.util.{Future, Promise}
val p = new Promise[Int]()
p.setInterruptHandler { case _ => println("interrupt handler") }

val f: Future[Int] = p.masked
f.raise(new Exception("ignored!")) // nothing will be printed
f1.map(_ + 1).raise(new Exception("ignored!")) // nothing will be printed

Definition Classes: Future
See also: raise
mask
interruptible()

final def ne(arg0: AnyRef): Boolean

Definition Classes: AnyRef

final def notify(): Unit

Definition Classes: AnyRef
Annotations: @native()

final def notifyAll(): Unit

Definition Classes: AnyRef
Annotations: @native()

def onFailure(fn: (Throwable) ⇒ Unit): Future[String]

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: this should be used for side-effects.
,
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".
See also: handle and rescue to produce a new Future from the result of the computation.

def onSuccess(f: (String) ⇒ Unit): Future[String]

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.

def or[U >: String](other: Future[U]): Future[U]

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

Definition Classes: Future

def poll: Option[Try[String]]

Polls for an available result.

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

Definition Classes: Promise → Future

def process(rc: Int, path: String)(result: ⇒ String): Unit

Process result iff rc is OK; otherwise throw a KeeperException.

Attributes: protected
Definition Classes: AsyncCallbackPromise

def processResult(rc: Int, path: String, ctx: AnyRef, name: String): Unit

Definition Classes: StringCallbackPromise → StringCallback

def proxyTo[B >: String](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

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). For example:

import com.twitter.util.Promise
val p = new Promise[Unit]()
p.setInterruptHandler { case _ => println("interrupt handler fired") }
p.poll // is `None`
p.raise(new Exception("raised!"))
p.poll // is still `None`

In the context of a Future created via composition (e.g. flatMap/onSuccess/transform), raise-ing on that Future will call raise on the head of the chain which created this Future. For example:

import com.twitter.util.Promise
val p = new Promise[Int]()
p.setInterruptHandler { case _ => println("interrupt handler fired") }
val f = p.map(_ + 1)

f.raise(new Exception("fire!"))

The call to f.raise will call p.raise and print "interrupt handler fired".

When the head of that chain of Futures is satisfied, the next Future in the chain created by composition will have raise called. For example:

import com.twitter.util.Promise
val p1, p2 = new Promise[Int]()
p1.setInterruptHandler { case _ => println("p1 interrupt handler") }
p2.setInterruptHandler { case _ => println("p2 interrupt handler") }
val f = p1.flatMap { _ => p2 }

f.raise(new Exception("fire!")) // will print "p1 interrupt handler"
p1.setValue(1) // will print "p2 interrupt handler"

Definition Classes: Promise → Future
Annotations: @tailrec()
See also: Promise.setInterruptHandler

def raiseWithin(timer: Timer, timeout: Duration, exc: Throwable): Future[String]

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

def raiseWithin(timeout: Duration, exc: Throwable)(implicit timer: Timer): Future[String]

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

def raiseWithin(timeout: Duration)(implicit timer: Timer): Future[String]

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

def ready(timeout: Duration)(implicit permit: CanAwait): StringCallbackPromise.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: Promise → Awaitable
Annotations: @throws( classOf[TimeoutException] ) @throws( classOf[InterruptedException] )

def rescue[B >: String](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.

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

def respond(k: (Try[String]) ⇒ Unit): Future[String]

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

def result(timeout: Duration)(implicit permit: CanAwait): String

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: Promise → Awaitable
Annotations: @throws( classOf[Exception] )

def select[U >: String](other: Future[U]): Future[U]

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

def setDone()(implicit ev: <:<[StringCallbackPromise.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

def setException(throwable: Throwable): Unit

Populate the Promise with the given exception.

Definition Classes: Promise
Exceptions thrown: ImmutableResult if the Promise is already populated

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()

def setValue(result: String): Unit

Populate the Promise with the given result.

Definition Classes: Promise
Exceptions thrown: ImmutableResult if the Promise is already populated

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

Definition Classes: AnyRef

def toJavaFuture: Future[_ <: String]

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

def toOffer: Offer[Try[String]]

An Offer for this future.

The offer is activated when the future is satisfied.

Definition Classes: Future

def toString(): String

Definition Classes: Promise → AnyRef → Any

def transform[B](f: (Try[String]) ⇒ Future[B]): Future[B]

Definition Classes: Responder

def transformedBy[B](transformer: FutureTransformer[String, 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: transform for a Scala API.
addEventListener for a Java friendly way to perform side-effects.

def unit: Future[Unit]

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

Definition Classes: Future
Note: failed futures will remain as is.

def update(result: Try[String]): 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: Promise → Updatable
Exceptions thrown: ImmutableResult if the Promise is already populated

final def updateIfEmpty(result: Try[String]): 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.

def voided: Future[Void]

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

Definition Classes: Future
Note: failed futures will remain as is.

final def wait(): Unit

Definition Classes: AnyRef
Annotations: @throws( ... )

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

Definition Classes: AnyRef
Annotations: @throws( ... )

final def wait(arg0: Long): Unit

Definition Classes: AnyRef
Annotations: @native() @throws( ... )

def willEqual[B](that: Future[B]): Future[Boolean]

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

def withFilter(p: (String) ⇒ Boolean): Future[String]

Definition Classes: Future

def within(timer: Timer, timeout: Duration, exc: ⇒ Throwable): Future[String]

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

def within(timer: Timer, timeout: Duration): Future[String]

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

def within(timeout: Duration)(implicit timer: Timer): Future[String]

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

Packages

StringCallbackPromise

class StringCallbackPromise extends Promise[String] with AsyncCallbackPromise[String] with StringCallback

Instance Constructors

Value Members

Inherited from StringCallback

Inherited from AsyncCallback

Inherited from AsyncCallbackPromise[String]

Inherited from Promise[String]

Inherited from Updatable[Try[String]]

Inherited from Responder[String]

Inherited from Future[String]

Inherited from Awaitable[String]

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

StringCallbackPromise 

class StringCallbackPromise extends Promise[String] with AsyncCallbackPromise[String] with StringCallback

Instance Constructors

Value Members

Inherited from StringCallback

Inherited from AsyncCallback

Inherited from AsyncCallbackPromise[String]

Inherited from Promise[String]

Inherited from Updatable[Try[String]]

Inherited from Responder[String]

Inherited from Future[String]

Inherited from Awaitable[String]

Inherited from AnyRef

Inherited from Any

Ungrouped

StringCallbackPromise