Future

sealed abstract
class Future[+A]

Future is a trampolined computation producing an A that may include asynchronous steps. Like Trampoline, arbitrary monadic expressions involving map and flatMap are guaranteed to use constant stack space. But in addition, one may construct a Future from an asynchronous computation, represented as a function, listen: (A => Unit) => Unit, which registers a callback that will be invoked when the result becomes available. This makes Future useful as a concurrency primitive and as a control structure for wrapping callback-based APIs with a more straightforward, monadic API.

Unlike the Future implementation in scala 2.10, map and flatMap do NOT spawn new tasks and do not require an implicit ExecutionContext. Instead, map and flatMap merely add to the current (trampolined) continuation that will be run by the 'current' thread, unless explicitly forked via Future.fork or Future.apply. This means that Future achieves much better thread reuse than the 2.10 implementation and avoids needless thread pool submit cycles.

Future also differs from the scala 2.10 Future type in that it does not necessarily represent a running computation. Instead, we reintroduce nondeterminism explicitly using the functions of the scalaz.Nondeterminism interface. This simplifies our implementation and makes code easier to reason about, since the order of effects and the points of nondeterminism are made fully explicit and do not depend on Scala's evaluation order.

IMPORTANT NOTE: Future does not include any error handling and should generally only be used as a building block by library writers who want to build on Future's capabilities but wish to design their own error handling strategy. See scalaz.concurrent.Task for a type that extends Future with proper error handling -- it is merely a wrapper for Future[Throwable \/ A] with a number of additional convenience functions.

Companion
object
class Object
trait Matchable
class Any
class Async[A]
class BindAsync[A, B]
class BindSuspend[A, B]
class Now[A]
class Suspend[A]

Value members

Concrete methods

def after(t: Duration): Future[A]

Returns a Future that delays the execution of this Future by the duration t.

Returns a Future that delays the execution of this Future by the duration t.

def after(t: Long): Future[A]
def flatMap[B](f: A => Future[B]): Future[B]
def map[B](f: A => B): Future[B]
@tailrec
final
def step: Future[A]

Evaluate this Future to a result, or another asynchronous computation. This has the effect of stripping off any 'pure' trampolined computation at the start of this Future.

Evaluate this Future to a result, or another asynchronous computation. This has the effect of stripping off any 'pure' trampolined computation at the start of this Future.

@tailrec
final
def stepInterruptibly(cancel: AtomicBoolean): Future[A]

Like step, but may be interrupted by setting cancel to true.

Like step, but may be interrupted by setting cancel to true.

def timed(timeoutInMillis: Long)(implicit scheduler: ScheduledExecutorService): Future[Throwable \/ A]

Returns a Future which returns a TimeoutException after timeoutInMillis, and attempts to cancel the running computation. This implementation will not block the future's execution thread

Returns a Future which returns a TimeoutException after timeoutInMillis, and attempts to cancel the running computation. This implementation will not block the future's execution thread

def timed(timeout: Duration)(implicit scheduler: ScheduledExecutorService): Future[Throwable \/ A]
def unsafePerformAsync(cb: A => Unit): Unit

Run this Future, passing the result to the given callback once available. Any pure, non-asynchronous computation at the head of this Future will be forced in the calling thread. At the first Async encountered, control switches to whatever thread backs the Async and this function returns.

Run this Future, passing the result to the given callback once available. Any pure, non-asynchronous computation at the head of this Future will be forced in the calling thread. At the first Async encountered, control switches to whatever thread backs the Async and this function returns.

def unsafePerformAsyncInterruptibly(cb: A => Unit, cancel: AtomicBoolean): Unit

Run this computation to obtain an A, so long as cancel remains false. Because of trampolining, we get frequent opportunities to cancel while stepping through the trampoline, this should provide a fairly robust means of cancellation.

Run this computation to obtain an A, so long as cancel remains false. Because of trampolining, we get frequent opportunities to cancel while stepping through the trampoline, this should provide a fairly robust means of cancellation.

def unsafePerformListen(cb: A => Trampoline[Unit]): Unit

Run this computation to obtain an A, then invoke the given callback. Also see unsafePerformAsync.

Run this computation to obtain an A, then invoke the given callback. Also see unsafePerformAsync.

def unsafePerformListenInterruptibly(cb: A => Trampoline[Unit], cancel: AtomicBoolean): Unit

Run this computation to obtain an A, so long as cancel remains false. Because of trampolining, we get frequent opportunities to cancel while stepping through the trampoline, so this should provide a fairly robust means of cancellation.

Run this computation to obtain an A, so long as cancel remains false. Because of trampolining, we get frequent opportunities to cancel while stepping through the trampoline, so this should provide a fairly robust means of cancellation.

Run this Future and block awaiting its result.

Run this Future and block awaiting its result.

def unsafePerformSyncAttemptFor(timeoutInMillis: Long): Throwable \/ A

Like unsafePerformSyncFor, but returns TimeoutException as left value. Will not report any other exceptions that may be raised during computation of A

Like unsafePerformSyncFor, but returns TimeoutException as left value. Will not report any other exceptions that may be raised during computation of A

def unsafePerformSyncAttemptFor(timeout: Duration): Throwable \/ A
def unsafePerformSyncFor(timeoutInMillis: Long): A

Run this Future and block until its result is available, or until timeoutInMillis milliseconds have elapsed, at which point a TimeoutException will be thrown and the Future will attempt to be canceled.

Run this Future and block until its result is available, or until timeoutInMillis milliseconds have elapsed, at which point a TimeoutException will be thrown and the Future will attempt to be canceled.

def unsafePerformSyncFor(timeout: Duration): A

Begins running this Future and returns a new future that blocks waiting for the result. Note that this will start executing side effects immediately, and is thus morally equivalent to unsafePerformIO. The resulting Future cannot be rerun to repeat the effects.

Begins running this Future and returns a new future that blocks waiting for the result. Note that this will start executing side effects immediately, and is thus morally equivalent to unsafePerformIO. The resulting Future cannot be rerun to repeat the effects.

Use with care.

Deprecated methods

@deprecated("use unsafePerformSyncAttemptFor", "7.2")
def attemptRunFor(timeoutInMillis: Long): Throwable \/ A
Deprecated
@deprecated("use unsafePerformSyncAttemptFor", "7.2")
def attemptRunFor(timeout: Duration): Throwable \/ A
Deprecated
@deprecated("use unsafePerformListen", "7.2")
def listen(cb: A => Trampoline[Unit]): Unit
Deprecated
@deprecated("use unsafePerformListenInterruptibly", "7.2")
def listenInterruptibly(cb: A => Trampoline[Unit], cancel: AtomicBoolean): Unit
Deprecated
@deprecated("use unsafePerformSync", "7.2")
def run: A
Deprecated
@deprecated("use unsafePerformAsync", "7.2")
def runAsync(cb: A => Unit): Unit
Deprecated
@deprecated("use unsafePerformAsyncInterruptibly", "7.2")
def runAsyncInterruptibly(cb: A => Unit, cancel: AtomicBoolean): Unit
Deprecated
@deprecated("use unsafePerformSyncFor", "7.2")
def runFor(timeoutInMillis: Long): A
Deprecated
@deprecated("use unsafePerformSyncFor", "7.2")
def runFor(timeout: Duration): A
Deprecated
@deprecated("use unsafeStart", "7.2")
def start: Future[A]
Deprecated
@deprecated("use timed", "7.2")
def unsafePerformTimed(timeout: Duration)(implicit scheduler: ScheduledExecutorService): Future[Throwable \/ A]
Deprecated
@deprecated("use timed", "7.2")
def unsafePerformTimed(timeoutInMillis: Long)(implicit scheduler: ScheduledExecutorService): Future[Throwable \/ A]
Deprecated