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.catnap exposes pure abstractions built on top of the Cats-Effect type classes:

    monix.eval is for dealing with evaluation of results, thus exposing Task and Coeval.

    monix.reactive exposes the Observable pattern:

    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.

    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.

    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.

    Package exposing utilities for working with the Reactive Streams specification.

    Definition Classes
    execution
  • ReactivePullStrategy
  • SingleAssignSubscription
  • Subscription
  • package schedulers
    Definition Classes
    execution
p

monix.execution

rstreams

package rstreams

Package exposing utilities for working with the Reactive Streams specification.

Source
package.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. rstreams
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed abstract class ReactivePullStrategy extends Product with Serializable

    Describes a strategy of buffering data when converting a Publisher into other data types like monix.tail.Iterant.

    Describes a strategy of buffering data when converting a Publisher into other data types like monix.tail.Iterant.

    To override a strategy, provide it as an implicit:

    implicit val pullStrategy: ReactivePullStrategy = ReactivePullStrategy.Batched(256)
    
    // The call will use strategy defined above
    Iterant[Task].fromReactivePublisher(publisher)
  2. final class SingleAssignSubscription extends Subscription

    Represents a org.reactivestreams.Subscription that can be assigned only once to another subscription reference.

    Represents a org.reactivestreams.Subscription that can be assigned only once to another subscription reference.

    If the assignment happens after this subscription has been canceled, then on assignment the reference will get canceled too. If the assignment after request(n) has been called on this subscription, then request(n) will get called immediately on the assigned reference as well.

    Useful in case you need a thread-safe forward reference.

  3. trait Subscription extends org.reactivestreams.Subscription with Cancelable

    The Subscription represents a cross between the Monix Cancelable and org.reactivestreams.Subcription.

    The Subscription represents a cross between the Monix Cancelable and org.reactivestreams.Subcription.

    Represents a one-to-one lifecycle of a Subscriber subscribing to a Publisher and mirrors the Subscription interface from the Reactive Streams specification.

    It can be used only once by a single Subscriber. It is used for both signaling demand for data and for canceling demand (and allow resource cleanup).

  4. type SingleAssignmentSubscription = SingleAssignSubscription

    DEPRECATED — renamed to SingleAssignSubscription.

    DEPRECATED — renamed to SingleAssignSubscription.

    Annotations
    @deprecated
    Deprecated

    (Since version 3.0.0) Renamed to SingleAssignSubscription

Deprecated Value Members

  1. val SingleAssignmentSubscription: SingleAssignSubscription.type

    DEPRECATED — renamed to SingleAssignSubscription.

    DEPRECATED — renamed to SingleAssignSubscription.

    Annotations
    @deprecated
    Deprecated

    (Since version 3.0.0) Renamed to SingleAssignSubscription

Inherited from AnyRef

Inherited from Any

Ungrouped