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

Unsafe

UnsafeBecauseBlocking

UnsafeBecauseImpure

UnsafeProtocol

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

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

annotations

package annotations

Type Members

class Unsafe extends Annotation with StaticAnnotation
An annotation meant to warn users on unsafe functions.
An annotation meant to warn users on unsafe functions.
"Unsafe" can include behavior such as:
- breaking of referential transparency, see UnsafeBecauseImpure
- blocking the underlying thread, see UnsafeBecauseBlocking
- exposing a protocol of communication that has to be used as specified or otherwise the behavior can be undefined, see UnsafeProtocol
class UnsafeBecauseBlocking extends Unsafe
An annotation meant to warn users on functions that are triggering blocking operations.
An annotation meant to warn users on functions that are triggering blocking operations.
Blocking threads is unsafe because:
- the user has to be aware of the configuration of the underlying thread-pool, which should be preferably unbounded, or otherwise it can suffer from thread starvation
- it's not supported on top of JavaScript
Prefer to avoid blocking operations.
class UnsafeBecauseImpure extends Unsafe
An annotation meant to warn users on functions that are breaking referential transparency.
An annotation meant to warn users on functions that are breaking referential transparency.
Such operations are unsafe in a context where purity is expected. Note however that most data types defined in monix.execution are impure.
class UnsafeProtocol extends Unsafe
An annotation meant to warn users on functions that are using an error prone protocol.
An annotation meant to warn users on functions that are using an error prone protocol.
An example of such a protocol is the one defined at reactive-streams.org, being unsafe because its safe usage requires deep knowledge of it, having lots of cases in which the compiler does not and cannot help, leading to undefined behavior if not careful.
Only use such functions if familiar with the underlying protocol.

Packages

Package Overview

annotations

package annotations

Type Members

Ungrouped

annotations