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
o

monix.execution

FutureUtils

object FutureUtils

Utilities for Scala's standard concurrent.Future.

Source
FutureUtils.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FutureUtils
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. def delayedResult[T](delay: FiniteDuration)(result: ⇒ T)(implicit s: Scheduler): Future[T]

    Creates a future that completes with the specified result, but only after the specified delay.

  2. def dematerialize[T](source: Future[Try[T]])(implicit ec: ExecutionContext): Future[T]

    Utility that transforms a Future[Try[T]] into a Future[T], hiding errors, being the opposite of materialize.

  3. def materialize[T](source: Future[T])(implicit ec: ExecutionContext): Future[Try[T]]

    Utility that lifts a Future[T] into a Future[Try[T]], exposing error explicitly.

  4. def timeout[T](source: Future[T], atMost: FiniteDuration)(implicit s: Scheduler): Future[T]

    Utility that returns a new Future that either completes with the original Future's result or with a TimeoutException in case the maximum wait time was exceeded.

    Utility that returns a new Future that either completes with the original Future's result or with a TimeoutException in case the maximum wait time was exceeded.

    atMost

    specifies the maximum wait time until the future is terminated with a TimeoutException

    s

    is the Scheduler, needed for completing our internal promise

    returns

    a new future that will either complete with the result of our source or fail in case the timeout is reached.

  5. def timeoutTo[T](source: Future[T], atMost: FiniteDuration, fallback: ⇒ Future[T])(implicit s: Scheduler): Future[T]

    Utility that returns a new Future that either completes with the original Future's result or after the timeout specified by atMost it tries to complete with the given fallback.

    Utility that returns a new Future that either completes with the original Future's result or after the timeout specified by atMost it tries to complete with the given fallback. Whatever Future finishes first after the timeout, will win.

    atMost

    specifies the maximum wait time until the future is terminated with a TimeoutException

    fallback

    the fallback future that gets triggered after timeout

    s

    is the Scheduler, needed for completing our internal promise

    returns

    a new future that will either complete with the result of our source or with the fallback in case the timeout is reached

  6. def transform[T, S](source: Future[T], f: (Try[T]) ⇒ Try[S])(implicit ec: ExecutionContext): Future[S]

    Given a mapping functions that operates on successful results as well as errors, transforms the source by applying it.

    Given a mapping functions that operates on successful results as well as errors, transforms the source by applying it.

    Similar to Future.transform from Scala 2.12.

  7. def transformWith[T, S](source: Future[T], f: (Try[T]) ⇒ Future[S])(implicit ec: ExecutionContext): Future[S]

    Given a mapping functions that operates on successful results as well as errors, transforms the source by applying it.

    Given a mapping functions that operates on successful results as well as errors, transforms the source by applying it.

    Similar to Future.transformWith from Scala 2.12.

  8. object extensions

    Provides extension methods for Future.