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

Features

Companion class Features

object Features extends Serializable

Source: Features.scala

Linear Supertypes

Serializable, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

Features
Serializable
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Type Members

abstract type Flag <: Long with FlagTag
Encodes a feature flag, stored as a Long.
Encodes a feature flag, stored as a Long.
Note that feature flags should be powers of 2, because they'll get added to the set via bitwise arithmetic.
Example:
```
val RED   = Features.flag(1)
val GREEN = Features.flag(2)
val BLUE  = Features.flag(4)
val WHITE = Features.flag(8)
```
You can wrap a Long into a Flag via flag.
trait FlagTag extends Any
Encoding for the newtype we're defining, used to make Flag and Flags type safe (instead of usage of Long), but without the boxing.
Encoding for the newtype we're defining, used to make Flag and Flags type safe (instead of usage of Long), but without the boxing.
Inspired by the alexknvl/newtypes project.
abstract type Flags <: Long with FlagsTag
Encodes a set of Flag values.
Encodes a set of Flag values.
Internally this is still a Long, but has its own type for type safety reasons.
trait FlagsTag extends Any
Encoding for the newtype we're defining, used to make Flag and Flags type safe (instead of usage of Long), but without the boxing.
Encoding for the newtype we're defining, used to make Flag and Flags type safe (instead of usage of Long), but without the boxing.
Inspired by the alexknvl/newtypes project.

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
def apply(flags: Flag*): Features
Builds a new Features instance.
Builds a new Features instance.
flags
is a list of feature flags to instantiate the value with.
final def asInstanceOf[T0]: T0
Definition Classes
Any
def clone(): AnyRef
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
val empty: Features
Reusable, empty Features reference.
final def eq(arg0: AnyRef): Boolean
Definition Classes
AnyRef
def equals(arg0: AnyRef): Boolean
Definition Classes
AnyRef → Any
def flag(value: Long): Flag
Wraps a Long value into a Flag.
Wraps a Long value into a Flag.
Annotations
@inline()
final def getClass(): Class[_ <: AnyRef]
Definition Classes
AnyRef → Any
Annotations
@native() @HotSpotIntrinsicCandidate()
def hashCode(): Int
Definition Classes
AnyRef → Any
Annotations
@native() @HotSpotIntrinsicCandidate()
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() @HotSpotIntrinsicCandidate()
final def notifyAll(): Unit
Definition Classes
AnyRef
Annotations
@native() @HotSpotIntrinsicCandidate()
final def synchronized[T0](arg0: => T0): T0
Definition Classes
AnyRef
def toString(): String
Definition Classes
AnyRef → Any
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()
final def wait(): Unit
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

def finalize(): Unit
Attributes
protected[lang]
Definition Classes
AnyRef
Annotations
@throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
Deprecated
(Since version ) see corresponding Javadoc for more information.

Packages

Package Overview

Features

Companion class Features

object Features extends Serializable

Type Members

Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Package Overview

Features

Companion class Features

object Features extends Serializable

Type Members

Value Members

Deprecated Value Members

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Features