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

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

Ack

CancelableFutureCatsInstances

UncaughtExceptionReporter

compat

monix.execution

ExecutionModel

Companion object ExecutionModel

sealed abstract class ExecutionModel extends Product with Serializable

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.

Source: ExecutionModel.scala

Linear Supertypes

Serializable, Product, Equals, AnyRef, Any

Known Subclasses

AlwaysAsyncExecution, BatchedExecution, SynchronousExecution

Ordering

Alphabetic
By Inheritance

Inherited

ExecutionModel
Serializable
Product
Equals
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Abstract Value Members

abstract val batchedExecutionModulus: Int
Always equal to recommendedBatchSize-1.
Always equal to recommendedBatchSize-1.
Provided for convenience.
abstract def canEqual(that: Any): Boolean
Definition Classes
Equals
abstract def nextFrameIndex(current: Int): Int
Returns the next frame index in the run-loop.
Returns the next frame index in the run-loop.
If the returned integer is zero, then the next cycle in the run-loop should execute asynchronously.
abstract def productArity: Int
Definition Classes
Product
abstract def productElement(n: Int): Any
Definition Classes
Product
abstract val recommendedBatchSize: Int
Recommended batch size used for breaking synchronous loops in asynchronous batches.
Recommended batch size used for breaking synchronous loops in asynchronous batches. When streaming value from a producer to a synchronous consumer it's recommended to break the streaming in batches as to not hold the current thread or run-loop indefinitely.
This is rounded to the next power of 2, because then for applying the modulo operation we can just do:
```
val modulus = recommendedBatchSize - 1
// ...
nr = (nr + 1) & modulus
```
For the JVM the default value can be adjusted with:
```
  java -Dmonix.environment.batchSize=2048 \
       ...
```

Concrete Value Members

final def !=(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def ##(): Int
Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean
Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native()
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def finalize(): Unit
Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable])
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean
Definition Classes
Any
final def ne(arg0: AnyRef): Boolean
Definition Classes
AnyRef
final def notify(): Unit
Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native()
def productElementName(n: Int): String
Definition Classes
Product
def productElementNames: Iterator[String]
Definition Classes
Product
def productIterator: Iterator[Any]
Definition Classes
Product
def productPrefix: String
Definition Classes
Product
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException]) @native()

Packages

Package Overview

ExecutionModel

Companion object ExecutionModel

sealed abstract class ExecutionModel extends Product with Serializable

Abstract Value Members

Concrete Value Members

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Package Overview

ExecutionModel

Companion object ExecutionModel

sealed abstract class ExecutionModel extends Product with Serializable

Abstract Value Members

Concrete Value Members

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped

ExecutionModel