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

  monix.reactive exposes the Observable pattern:

  • monix.reactive.exceptions groups some exceptions thrown by the implementation
  • 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.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 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

•  object AssignableCancelable extends Serializable

  Definition Classes

  cancelables

• Bool
• Multi

monix.execution.cancelables.AssignableCancelable

Multi 