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...).
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()
An abstraction over the ForkJoinPool
implementation,
meant to target multiple Scala versions.
This is the API documentation for the Monix library.
Package Overview
monix.execution exposes lower level primitives for dealing with asynchronous execution:
Atomic
types, as alternative tojava.util.concurrent.atomic
monix.eval is for dealing with evaluation of results, thus exposing Task and Coeval.
monix.reactive exposes the
Observable
pattern:Observable
implementationsmonix.types implements type-class shims, to be translated to type-classes provided by libraries such as Cats or Scalaz.
monix.cats is the optional integration with the Cats library, providing translations for the types described in
monix.types
.monix.scalaz is the optional integration with the Scalaz library, providing translations for the types described in
monix.types
.