Packages

  • package root
    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 internal
    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
  • package schedulers
    Definition Classes
    execution
  • Ack
  • AsyncQueue
  • AsyncSemaphore
  • AsyncVar
  • BufferCapacity
  • Callback
  • Cancelable
  • CancelableFuture
  • CancelablePromise
  • ChannelType
  • ExecutionModel
  • Features
  • FutureUtils
  • Scheduler
  • UncaughtExceptionReporter
  • compat

abstract class Callback[-E, -A] extends (Either[E, A]) => Unit

Represents a callback that should be called asynchronously with the result of a computation.

This is an Either[E, A] => Unit with an OOP interface that avoids extra boxing, along with overloads of apply.

The onSuccess method should be called only once, with the successful result, whereas onError should be called if the result is an error.

Obviously Callback describes unsafe side-effects, a fact that is highlighted by the usage of Unit as the return type. Obviously callbacks are unsafe to use in pure code, but are necessary for describing asynchronous processes.

THREAD-SAFETY: callback implementations are NOT thread-safe by contract, this depends on the implementation. Callbacks can be made easily thread-safe via wrapping with:

NOTE that callbacks injected in the Task async builders (e.g. Task.async) are thread-safe.

Linear Supertypes
(Either[E, A]) => Unit, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Callback
  2. Function1
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Callback()

Abstract Value Members

  1. abstract def onError(e: E): Unit

    Signals an error.

    Signals an error.

    Can be called at most once by contract. Not necessarily thread-safe, depends on implementation.

  2. abstract def onSuccess(value: A): Unit

    Signals a successful value.

    Signals a successful value.

    Can be called at most once by contract. Not necessarily thread-safe, depends on implementation.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def andThen[A](g: (Unit) => A): (Either[E, A]) => A
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  5. def apply(result: Try[A])(implicit ev: <:<[Throwable, E]): Unit

    Signals a value via Scala's Try.

    Signals a value via Scala's Try.

    Can be called at most once by contract. Not necessarily thread-safe, depends on implementation.

  6. def apply(result: Either[E, A]): Unit

    Signals a value via Scala's Either (Left is error, Right is the successful value).

    Signals a value via Scala's Either (Left is error, Right is the successful value).

    Can be called at most once by contract. Not necessarily thread-safe, depends on implementation.

    Definition Classes
    Callback → Function1
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  9. def compose[A](g: (A) => Either[E, A]): (A) => Unit
    Definition Classes
    Function1
    Annotations
    @unspecialized()
  10. def contramap[B](f: (B) => A): Callback[E, B]

    Return a new callback that will apply the supplied function before passing the result into this callback.

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  14. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  15. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    Function1 → AnyRef → Any
  22. def tryApply(result: Either[E, A]): Boolean

    Attempts to call Callback.apply.

    Attempts to call Callback.apply.

    In case the underlying callback implementation protects against protocol violations, then this method should return false in case the final result was already signaled once via onSuccess or onError.

    The default implementation relies on catching

    CallbackCalledMultipleTimesException in case of violations, which is what thread-safe implementations of onSuccess or onError are usually throwing.

    WARNING: this method is only provided as a convenience. The presence of this method does not guarantee that the underlying callback is thread-safe or that it protects against protocol violations.

  23. def tryApply(result: Try[A])(implicit ev: <:<[Throwable, E]): Boolean

    Attempts to call Callback.apply.

    Attempts to call Callback.apply.

    In case the underlying callback implementation protects against protocol violations, then this method should return false in case the final result was already signaled once via onSuccess or onError.

    The default implementation relies on catching

    CallbackCalledMultipleTimesException in case of violations, which is what thread-safe implementations of onSuccess or onError are usually throwing.

    WARNING: this method is only provided as a convenience. The presence of this method does not guarantee that the underlying callback is thread-safe or that it protects against protocol violations.

  24. def tryOnError(e: E): Boolean

    Attempts to call Callback.onError.

    Attempts to call Callback.onError.

    In case the underlying callback implementation protects against protocol violations, then this method should return false in case the final result was already signaled once via onSuccess or onError.

    The default implementation relies on catching

    CallbackCalledMultipleTimesException in case of violations, which is what thread-safe implementations of onSuccess or onError are usually throwing.

    WARNING: this method is only provided as a convenience. The presence of this method does not guarantee that the underlying callback is thread-safe or that it protects against protocol violations.

  25. def tryOnSuccess(value: A): Boolean

    Attempts to call Callback.onSuccess.

    Attempts to call Callback.onSuccess.

    In case the underlying callback implementation protects against protocol violations, then this method should return false in case the final result was already signaled once via onSuccess or onError.

    The default implementation relies on catching

    CallbackCalledMultipleTimesException in case of violations, which is what thread-safe implementations of onSuccess or onError are usually throwing.

    WARNING: this method is only provided as a convenience. The presence of this method does not guarantee that the underlying callback is thread-safe or that it protects against protocol violations.

  26. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from (Either[E, A]) => Unit

Inherited from AnyRef

Inherited from Any

Ungrouped