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.execution.atomic exposes the Atomic types, as alternative to java.util.concurrent.atomic
monix.execution.cancelables contains several useful Cancelable implementations
monix.execution.schedulers contains several useful Scheduler implementations
monix.execution.rstreams contains helpers for dealing with the Reactive Streams specification
monix.execution.misc provides miscellaneous primitives useful for dealing with concurrency
monix.execution.exceptions groups some exceptions thrown by the implementation

monix.catnap exposes pure abstractions built on top of the Cats-Effect type classes:

monix.catnap.cancelables exposes pure counterparts to the cancelable data types described in monix.execution.cancelables

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

monix.reactive exposes the Observable pattern:

monix.reactive.observables groups reusable Observable implementations
monix.reactive.observers groups reusable Observer implementations
monix.reactive.subjects exposes Subject and ConcurrentSubject, which are implementations of hot observables that function both as input and output

monix.tail exposes Iterant for purely functional pull based streaming:

monix.tail.batches describes Batch and BatchCursor, the alternatives to Scala's Iterable and Iterator respectively that we are using within Iterant's encoding

You can control evaluation with type you choose - be it Task, Coeval, cats.effect.IO or your own as long as you provide correct cats-effect or cats typeclass instance.

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.

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.

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

APIContractViolationException

BufferOverflowException

CallbackCalledMultipleTimesException

CompositeException

DownstreamTimeoutException

DummyException

ExecutionRejectedException

UncaughtErrorException

UpstreamTimeoutException

package misc

Definition Classes: execution

package rstreams

Package exposing utilities for working with the Reactive Streams specification.

Definition Classes: execution

package schedulers

Definition Classes: execution

monix.execution

exceptions

package exceptions

Ordering

Alphabetic

Visibility

Public
Protected

Type Members

class APIContractViolationException extends IllegalStateException with Serializable
Generic exception thrown on API contract violations.
class BufferOverflowException extends RuntimeException with Serializable
An exception emitted on buffer overflows, like when using OverflowStrategy.Fail.
class CallbackCalledMultipleTimesException extends APIContractViolationException
Thrown when signaling is attempted multiple times for Callback or similar.
final class CompositeException extends RuntimeException with Serializable
A composite exception represents a list of exceptions that were caught while delaying errors.
class DownstreamTimeoutException extends TimeoutException with Serializable
Exception thrown whenever a downstream listener on a back-pressured data-source is taking too long to process a received event.
final case class DummyException(message: String) extends RuntimeException with Serializable with Product
Used in testing to trigger dummy exceptions.
Used in testing to trigger dummy exceptions.
Not to be used for anything except in testing, since this exception type implements structural equality.
This means that these 2 exceptions are considered equal, even if they have different stack-traces:
```
val dummy1 = DummyException("dummy")
val dummy2 = DummyException("dummy")

dummy == dummy2
//=> true
```
class ExecutionRejectedException extends RuntimeException with Serializable
Exception thrown whenever an execution attempt was rejected.
Exception thrown whenever an execution attempt was rejected.
Such execution attempts can come for example from Task or from methods returning Future references, with this exception being thrown in case the execution was rejected due to in place protections, such as a circuit breaker.
class UncaughtErrorException[E] extends RuntimeException
The UncaughtErrorException wraps uncaught, generic errors.
The UncaughtErrorException wraps uncaught, generic errors.
```
val ex: UncaughtErrorException[String] =
  UncaughtErrorException("Error!")
```
class UpstreamTimeoutException extends TimeoutException with Serializable
Exception thrown whenever a upstream listener on a back-pressured data-source is taking too long to process a received event.

Value Members

object APIContractViolationException extends AbstractFunction1[String, APIContractViolationException] with Serializable
object BufferOverflowException extends AbstractFunction1[String, BufferOverflowException] with Serializable
object CallbackCalledMultipleTimesException extends AbstractFunction1[String, CallbackCalledMultipleTimesException] with Serializable
object CompositeException extends AbstractFunction1[Seq[Throwable], CompositeException] with Serializable
object DownstreamTimeoutException extends AbstractFunction1[FiniteDuration, DownstreamTimeoutException] with Serializable
object ExecutionRejectedException extends AbstractFunction1[String, ExecutionRejectedException] with Serializable
object UncaughtErrorException extends Serializable
object UpstreamTimeoutException extends AbstractFunction1[FiniteDuration, UpstreamTimeoutException] with Serializable

Packages

Package Overview

exceptions

package exceptions

Type Members

Value Members

Ungrouped

exceptions