monifu

concurrent

package concurrent

Visibility
  1. Public
  2. All

Type Members

  1. trait Cancelable extends AnyRef

    Represents an asynchronous computation whose execution can be canceled.

    Represents an asynchronous computation whose execution can be canceled. Used by monifu.concurrent.Scheduler giving you the ability to cancel scheduled units of work.

    It is equivalent to java.io.Closeable, but without the I/O focus, or to IDisposable in Microsoft .NET, or to akka.actor.Cancellable.

  2. trait Scheduler extends ExecutionContext with UncaughtExceptionReporter

    A Scheduler is an scala.concurrent.ExecutionContext that additionally can schedule the execution of units of work to run with a delay or periodically.

    A Scheduler is an scala.concurrent.ExecutionContext that additionally can schedule the execution of units of work to run with a delay or periodically.

    Annotations
    @implicitNotFound( ... )
  3. trait UncaughtExceptionReporter extends AnyRef

    An exception reporter is a function that logs an uncaught error.

    An exception reporter is a function that logs an uncaught error.

    Usually taken as an implicit when executing computations that could fail, but that must not blow up the call-stack, like asynchronous tasks.

    A default implicit is provided that simply logs the error on STDERR.

    Annotations
    @implicitNotFound( ... )

Value Members

  1. object Cancelable

  2. object FutureUtils

  3. object Implicits

    Defines implicit values that can be used by importing in the current context.

    Defines implicit values that can be used by importing in the current context.

    Example:

    import monifu.concurrent.Implicits.globalScheduler
  4. object Scheduler

  5. object UncaughtExceptionReporter

    See UncaughtExceptionReporter.

  6. package async

  7. 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 good reasons, as Atomic references are still useful in non-multi-threaded environments).

    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. They also support weak operations, defined in WeakAtomic[T], such as (e.g. weakCompareAndSet, lazySet) or operations that block the current thread through spin-locking, until a condition happens (e.g. waitForCompareAndSet), methods exposed by BlockingAtomic[T].

    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

    In comparison with java.util.concurrent.AtomicReference, these references implement common interfaces that you can use generically (i.e. Atomic[T], AtomicNumber[T], BlockableAtomic[T], WeakAtomic[T]). And also provide useful helpers for atomically mutating of values (i.e. transform, transformAndGet, getAndTransform, etc...) or of numbers of any kind (incrementAndGet, getAndAdd, etc...).

    A high-level documentation describing the rationale for these can be found here: Atomic Reference

  8. 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 monifu.concurrent.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, {
      println("Hello")
    })
    
    // later, cancels the scheduling ...
    task.cancel()
  9. object extensions

  10. package schedulers

Ungrouped