Packages

  • package root
    Definition Classes
    root
  • package monix
    Definition Classes
    root
  • package execution
    Definition Classes
    monix
  • package annotations
  • 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...).

  • 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()
  • package exceptions
  • package misc
  • package rstreams

    Package exposing utilities for working with the Reactive Streams specification.

  • package schedulers
  • Ack
  • Cancelable
  • CancelableFuture
  • ExecutionModel
  • FutureUtils
  • Listener
  • Scheduler
  • UncaughtExceptionReporter
p

monix

execution

package execution

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. sealed abstract class Ack extends Future[Ack] with Serializable

    Represents an acknowledgement of processing that a consumer sends back upstream.

    Represents an acknowledgement of processing that a consumer sends back upstream. Useful to implement back-pressure.

  2. trait Cancelable extends Serializable

    Represents a one-time idempotent action that can be used to cancel async computations, or to release resources that active data sources are holding.

    Represents a one-time idempotent action that can be used to cancel async computations, or to release resources that active data sources are holding.

    It is equivalent to java.io.Closeable, but without the I/O focus, or to IDisposable in Microsoft .NET, or to akka.actor.Cancellable.

  3. sealed abstract class CancelableFuture[+A] extends Future[A] with Cancelable

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

  4. sealed abstract class ExecutionModel extends Product with Serializable

    Specification for run-loops, imposed by the Scheduler.

    Specification for run-loops, imposed by the Scheduler.

    When executing tasks, a run-loop can always execute tasks asynchronously (by forking logical threads), or it can always execute them synchronously (same thread and call-stack, by using an internal trampoline), or it can do a mixed mode that executes tasks in batches before forking.

    The specification is considered a recommendation for how run loops should behave, but ultimately it's up to the client to choose the best execution model. This can be related to recursive loops or to events pushed into consumers.

  5. trait Listener[-A] extends Serializable

    A simple listener interface, to be used in observer pattern implementations or for specifying asynchronous callbacks.

    A simple listener interface, to be used in observer pattern implementations or for specifying asynchronous callbacks.

    This interface does not provide any usage contract or assumptions on how the onValue(a) function gets called.

    It's a replacement for Function1[A,Unit] but it does not inherit from it, precisely because we want to attach Listener semantics to types that cannot be Function1[A,Unit].

    In particular monix.eval.Callback is a supertype of Listener, even though Callback is a Try[A] => Unit.

  6. trait Scheduler extends ExecutionContext with UncaughtExceptionReporter with Executor

    A Scheduler is an scala.concurrent.ExecutionContext that additionally can schedule the execution of units of work to run with a delay or periodically.

    A Scheduler is an scala.concurrent.ExecutionContext that additionally can schedule the execution of units of work to run with a delay or periodically.

    Annotations
    @implicitNotFound( ... )
  7. trait UncaughtExceptionReporter extends Serializable

    An exception reporter is a function that logs an uncaught error.

    An exception reporter is a function that logs an uncaught error.

    Usually taken as an implicit when executing computations that could fail, but that must not blow up the call-stack, like asynchronous tasks.

    A default implicit is provided that simply logs the error on STDERR.

    Annotations
    @implicitNotFound( ... )

Value Members

  1. object Ack extends Serializable
  2. object Cancelable extends Serializable
  3. object CancelableFuture extends Serializable
  4. object ExecutionModel extends Serializable
  5. object FutureUtils

    Utilities for Scala's standard concurrent.Future.

  6. object Listener extends Serializable
  7. object Scheduler extends SchedulerCompanionImpl with Serializable
  8. object UncaughtExceptionReporter extends Serializable

    See UncaughtExceptionReporter.

Ungrouped