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.eval is for dealing with evaluation of results, thus exposing Task and Coeval.

    monix.reactive exposes the Observable pattern:

    monix.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.

    Definition Classes
    root
  • package monix
    Definition Classes
    root
  • package execution
    Definition Classes
    monix
  • package atomic

    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[T]):

    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.

    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 internal
    Definition Classes
    execution
  • package misc
    Definition Classes
    execution
  • AsyncQueue
  • AsyncSemaphore
  • AsyncVar
  • HygieneUtilMacros
  • InlineMacros
  • ThreadLocal
  • package rstreams
    Definition Classes
    execution
  • package schedulers
    Definition Classes
    execution

package misc

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. final class AsyncQueue [T] extends Serializable

    And asynchronous queue implementation.

    And asynchronous queue implementation.

    On poll, if there are queued elements, it returns oe immediately, otherwise it returns a Future

  2. final class AsyncSemaphore extends Serializable

    The AsyncSemaphore is an asynchronous semaphore implementation that limits the parallelism on Future execution.

    The AsyncSemaphore is an asynchronous semaphore implementation that limits the parallelism on Future execution.

    The following example instantiates a semaphore with a maximum parallelism of 10:

    val semaphore = AsyncSemaphore(maxParallelism = 10)

def makeRequest(r: HttpRequest): Future[HttpResponse] = ???

// For such a task no more than 10 requests
// are allowed to be executed in parallel.
val future = semaphore.greenLight(() => makeRequest(???))
  3. final class AsyncVar [A] extends AnyRef

    Asynchronous mutable location, that is either empty or contains a value of type A.

    Asynchronous mutable location, that is either empty or contains a value of type A.

    It has 2 fundamental atomic operations:

    • put which fills the var if empty, or blocks (asynchronously) otherwise until the var is empty again
    • take which empties the var if full, returning the contained value, or blocks (asynchronously) otherwise until there is a value to pull

    The AsyncVar is appropriate for building synchronization primitives and performing simple inter-thread communications. If it helps, it's similar with a BlockingQueue(capacity = 1), except that it doesn't block any threads, all waiting being callback-based.

    Given its asynchronous, non-blocking nature, it can be used on top of Javascript as well.

    Inspired by Control.Concurrent.MVar from Haskell.

  4. trait HygieneUtilMacros extends AnyRef

    Utilities for macro-hygiene.

    Utilities for macro-hygiene.

    Annotations
    @bundle()
  5. trait InlineMacros extends AnyRef
    Annotations
    @bundle()
  6. final class ThreadLocal [A] extends AnyRef

    Cross-platform equivalent for java.lang.ThreadLocal, for specifying thread-local variables.

    Cross-platform equivalent for java.lang.ThreadLocal, for specifying thread-local variables.

    These variables differ from their normal counterparts in that each thread that accesses one (via its ThreadLocal#get or ThreadLocal#set method) has its own, independently initialized copy of the variable.

Value Members

  1. object AsyncQueue extends Serializable
  2. object AsyncSemaphore extends Serializable
  3. object AsyncVar
  4. object ThreadLocal

Ungrouped