Packages

object CancelableFuture extends CancelableFutureForPlatform with Serializable

Source
CancelableFuture.scala
Linear Supertypes
Serializable, CancelableFutureForPlatform, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CancelableFuture
  2. Serializable
  3. CancelableFutureForPlatform
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. def apply[A](underlying: Future[A], cancelable: Cancelable): CancelableFuture[A]

    Builder for a CancelableFuture.

    Builder for a CancelableFuture.

    underlying

    is an underlying Future reference that will respond to onComplete calls

    cancelable

    is a Cancelable that can be used to cancel the active computation

  2. def async[A](register: ((Try[A]) => Unit) => Cancelable)(implicit ec: ExecutionContext): CancelableFuture[A]

    Given a registration function that can execute an asynchronous process, executes it and builds a CancelableFuture value out of it.

    Given a registration function that can execute an asynchronous process, executes it and builds a CancelableFuture value out of it.

    The given registration function can return a Cancelable reference that can be used to cancel the executed async process. This reference can be empty.

    def delayedResult[A](f: => A)(implicit s: Scheduler): CancelableFuture[A] =
  CancelableFuture.async { complete =>
    val task = s.scheduleOnce(10.seconds) { complete(Try(f)) }

    Cancelable { () =>
      println("Cancelling!")
      task.cancel()
    }
  }

    This is much like working with Scala's Promise, only safer.

  3. def failed[A](e: Throwable): CancelableFuture[A]

    Promotes a strict Throwable to a CancelableFuture that's already complete with a failure.

    Promotes a strict Throwable to a CancelableFuture that's already complete with a failure.

    e

    is the error that's going to be signaled in the onComplete callback.

  4. def fromJavaCompletable[A](cfa: CompletableFuture[A])(implicit ec: ExecutionContext): CancelableFuture[A]

    Convert java.util.concurrent.CompletableFuture to CancelableFuture

    Convert java.util.concurrent.CompletableFuture to CancelableFuture

    If the source is cancelled, returned Future will never terminate

    Definition Classes
    CancelableFutureForPlatform
  5. def fromTry[A](value: Try[A]): CancelableFuture[A]

    Promotes a strict Try[A] to a CancelableFuture that's already complete.

    Promotes a strict Try[A] to a CancelableFuture that's already complete.

    value

    is the Try[A] value that's going to be signaled in the onComplete callback.

  6. final def never[A]: CancelableFuture[A]

    Returns a CancelableFuture instance that will never complete.

  7. def pure[A](value: A): CancelableFuture[A]

    Promotes a strict value to a CancelableFuture that's already complete.

    Promotes a strict value to a CancelableFuture that's already complete.

    Alias for successful.

    value

    is the value that's going to be signaled in the onComplete callback.

  8. def raiseError[A](e: Throwable): CancelableFuture[A]

    Promotes a strict Throwable to a CancelableFuture that's already complete with a failure.

    Promotes a strict Throwable to a CancelableFuture that's already complete with a failure.

    Alias for failed.

    e

    is the error that's going to be signaled in the onComplete callback.

  9. def successful[A](value: A): CancelableFuture[A]

    Promotes a strict value to a CancelableFuture that's already complete.

    Promotes a strict value to a CancelableFuture that's already complete.

    value

    is the value that's going to be signaled in the onComplete callback.

  10. def toJavaCompletable[A](source: CancelableFuture[A])(implicit ec: ExecutionContext): CompletableFuture[A]

    Convert CancelableFuture to java.util.concurrent.CompletableFuture.

    Convert CancelableFuture to java.util.concurrent.CompletableFuture.

    Definition Classes
    CancelableFutureForPlatform
  11. val unit: CancelableFuture[Unit]

    An already completed CancelableFuture.