Packages

  • package root
    Definition Classes
    root
  • package monix
    Definition Classes
    root
  • package execution
    Definition Classes
    monix
  • package annotations
    Definition Classes
    execution
  • package atomic

    A small toolkit of classes that support compare-and-swap semantics for safe mutation of variables.

    A small toolkit of classes that support compare-and-swap semantics for safe mutation of variables.

    On top of the JVM, this means dealing with lock-free thread-safe programming. Also works on top of Javascript, with Scala.js, for API compatibility purposes and because it's a useful way to box a value.

    The backbone of Atomic references is this method:

    def compareAndSet(expect: T, update: T): Boolean

    This method atomically sets a variable to the update value if it currently holds the expect value, reporting true on success or false on failure. The classes in this package also contain methods to get and unconditionally set values.

    Building a reference is easy with the provided constructor, which will automatically return the most specific type needed (in the following sample, that's an AtomicDouble, inheriting from AtomicNumber[A]):

    val atomicNumber = Atomic(12.2)
    
    atomicNumber.incrementAndGet()
    // => 13.2

    These also provide useful helpers for atomically mutating of values (i.e. transform, transformAndGet, getAndTransform, etc...) or of numbers of any kind (incrementAndGet, getAndAdd, etc...).

    Definition Classes
    execution
  • package cancelables

    Cancelables represent asynchronous units of work or other things scheduled for execution and whose execution can be canceled.

    Cancelables represent asynchronous units of work or other things scheduled for execution and whose execution can be canceled.

    One use-case is the scheduling done by monix.execution.Scheduler, in which the scheduling methods return a Cancelable, allowing the canceling of the scheduling.

    Example:

    val s = ConcurrentScheduler()
    val task = s.scheduleRepeated(10.seconds, 50.seconds, {
      doSomething()
    })
    
    // later, cancels the scheduling ...
    task.cancel()
    Definition Classes
    execution
  • package exceptions
    Definition Classes
    execution
  • package internal
    Definition Classes
    execution
  • package misc
    Definition Classes
    execution
  • package rstreams

    Package exposing utilities for working with the Reactive Streams specification.

    Package exposing utilities for working with the Reactive Streams specification.

    Definition Classes
    execution
  • package schedulers
    Definition Classes
    execution
  • Ack
  • AsyncQueue
  • AsyncSemaphore
  • AsyncVar
  • BufferCapacity
  • Callback
  • Cancelable
  • CancelableFuture
  • CancelablePromise
  • ChannelType
  • ExecutionModel
  • FutureUtils
  • Scheduler
  • UncaughtExceptionReporter
  • compat

object CancelableFuture extends CancelableFutureForPlatform with Serializable

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

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

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. 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.

  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. 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.

  11. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  12. 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
  13. 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.

  14. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def never[A]: CancelableFuture[A]

    Returns a CancelableFuture instance that will never complete.

  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. 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.

  22. 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.

  23. 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.

  24. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  25. 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
  26. def toString(): String
    Definition Classes
    AnyRef → Any
  27. val unit: CancelableFuture[Unit]

    An already completed CancelableFuture.

  28. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from CancelableFutureForPlatform

Inherited from AnyRef

Inherited from Any

Ungrouped