Packages

  • package root

    This is the API documentation for the Monix library.

    Package Overview

    monix.execution exposes lower level primitives for dealing with asynchronous execution:

    monix.eval is for dealing with evaluation of results, thus exposing Task and Coeval.

    monix.reactive exposes the Observable pattern:

    monix.types implements type-class shims, to be translated to type-classes provided by libraries such as Cats or Scalaz.

    monix.cats is the optional integration with the Cats library, providing translations for the types described in monix.types.

    monix.scalaz is the optional integration with the Scalaz library, providing translations for the types described in monix.types.

    Definition Classes
    root
  • package monix
    Definition Classes
    root
  • package execution
    Definition Classes
    monix
  • 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[T]):

    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
    Definition Classes
    execution
  • package schedulers
    Definition Classes
    execution
  • Ack
  • Cancelable
  • CancelableFuture
  • ExecutionModel
  • FutureUtils
  • Listener
  • Macros
  • Scheduler
  • UncaughtExceptionReporter

trait CancelableFuture[+T] extends Future[T] with Cancelable

Represents an asynchronous computation that can be canceled as long as it isn't complete.

Source
CancelableFuture.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CancelableFuture
  2. Cancelable
  3. Serializable
  4. Serializable
  5. Future
  6. Awaitable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def cancel(): Unit

    Cancels the unit of work represented by this reference.

    Cancels the unit of work represented by this reference.

    Guaranteed idempotency - calling it multiple times should have the same side-effect as calling it only once. Implementations of this method should also be thread-safe.

    Definition Classes
    Cancelable
  2. abstract def isCompleted: Boolean
    Definition Classes
    Future
  3. abstract def onComplete[U](f: (Try[T]) ⇒ U)(implicit executor: ExecutionContext): Unit
    Definition Classes
    Future
  4. abstract def ready(atMost: Duration)(implicit permit: CanAwait): CancelableFuture.this.type
    Definition Classes
    Awaitable
    Annotations
    @throws( ... ) @throws( ... )
  5. abstract def result(atMost: Duration)(implicit permit: CanAwait): T
    Definition Classes
    Awaitable
    Annotations
    @throws( classOf[java.lang.Exception] )
  6. abstract def value: Option[Try[T]]
    Definition Classes
    Future

Concrete 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 andThen[U](pf: PartialFunction[Try[T], U])(implicit executor: ExecutionContext): CancelableFuture[T]
    Definition Classes
    CancelableFuture → Future
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  7. def collect[S](pf: PartialFunction[T, S])(implicit executor: ExecutionContext): CancelableFuture[S]
    Definition Classes
    CancelableFuture → Future
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def failed: CancelableFuture[Throwable]
    Definition Classes
    CancelableFuture → Future
  11. def fallbackTo[U >: T](that: Future[U]): CancelableFuture[U]
    Definition Classes
    CancelableFuture → Future
  12. def filter(p: (T) ⇒ Boolean)(implicit executor: ExecutionContext): CancelableFuture[T]
    Definition Classes
    CancelableFuture → Future
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. def flatMap[S](f: (T) ⇒ Future[S])(implicit executor: ExecutionContext): CancelableFuture[S]
    Definition Classes
    CancelableFuture → Future
  15. def flatten[S](implicit ev: <:<[T, Future[S]]): Future[S]
    Definition Classes
    Future
  16. def foreach[U](f: (T) ⇒ U)(implicit executor: ExecutionContext): Unit
    Definition Classes
    Future
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  18. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. def map[S](f: (T) ⇒ S)(implicit executor: ExecutionContext): CancelableFuture[S]
    Definition Classes
    CancelableFuture → Future
  21. def mapTo[S](implicit tag: ClassTag[S]): CancelableFuture[S]
    Definition Classes
    CancelableFuture → Future
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. final def notify(): Unit
    Definition Classes
    AnyRef
  24. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  25. def recover[U >: T](pf: PartialFunction[Throwable, U])(implicit executor: ExecutionContext): CancelableFuture[U]
    Definition Classes
    CancelableFuture → Future
  26. def recoverWith[U >: T](pf: PartialFunction[Throwable, Future[U]])(implicit executor: ExecutionContext): CancelableFuture[U]
    Definition Classes
    CancelableFuture → Future
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. def transform[S](f: (Try[T]) ⇒ Try[S])(implicit executor: ExecutionContext): CancelableFuture[S]
    Definition Classes
    CancelableFuture → Future
  30. def transform[S](s: (T) ⇒ S, f: (Throwable) ⇒ Throwable)(implicit executor: ExecutionContext): CancelableFuture[S]
    Definition Classes
    CancelableFuture → Future
  31. def transformWith[S](f: (Try[T]) ⇒ Future[S])(implicit executor: ExecutionContext): CancelableFuture[S]
    Definition Classes
    CancelableFuture → Future
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def withFilter(p: (T) ⇒ Boolean)(implicit executor: ExecutionContext): Future[T]
    Definition Classes
    Future
  36. def zip[U](that: Future[U]): CancelableFuture[(T, U)]
    Definition Classes
    CancelableFuture → Future
  37. def zipWith[U, R](that: Future[U])(f: (T, U) ⇒ R)(implicit executor: ExecutionContext): Future[R]
    Definition Classes
    Future

Deprecated Value Members

  1. def onFailure[U](pf: PartialFunction[Throwable, U])(implicit executor: ExecutionContext): Unit
    Definition Classes
    Future
    Annotations
    @deprecated
    Deprecated

    (Since version 2.12.0) use onComplete or failed.foreach instead (keep in mind that they take total rather than partial functions)

  2. def onSuccess[U](pf: PartialFunction[T, U])(implicit executor: ExecutionContext): Unit
    Definition Classes
    Future
    Annotations
    @deprecated
    Deprecated

    (Since version 2.12.0) use foreach or onComplete instead (keep in mind that they take total rather than partial functions)

Inherited from Cancelable

Inherited from Serializable

Inherited from Serializable

Inherited from Future[T]

Inherited from Awaitable[T]

Inherited from AnyRef

Inherited from Any

Ungrouped