Package

org.sincron

atomic

Permalink

package atomic

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

Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. atomic
  2. AnyRef
  3. Any
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Type Members

  1. abstract class Atomic[T] extends AnyRef

    Permalink

    Base trait of all atomic references, no matter the type.

  2. final class AtomicAny[T <: AnyRef] extends Atomic[T]

    Permalink
  3. final class AtomicBoolean extends Atomic[Boolean]

    Permalink
  4. trait AtomicBuilder[T, R <: Atomic[T]] extends AnyRef

    Permalink
  5. final class AtomicByte extends AtomicNumber[Byte]

    Permalink
  6. final class AtomicChar extends AtomicNumber[Char]

    Permalink
  7. final class AtomicDouble extends AtomicNumber[Double]

    Permalink
  8. final class AtomicFloat extends AtomicNumber[Float]

    Permalink
  9. final class AtomicInt extends AtomicNumber[Int]

    Permalink
  10. final class AtomicLong extends AtomicNumber[Long]

    Permalink
  11. abstract class AtomicNumber[T] extends Atomic[T]

    Permalink

    Represents an Atomic reference holding a number, providing helpers for easily incrementing and decrementing it.

    Represents an Atomic reference holding a number, providing helpers for easily incrementing and decrementing it.

    T

    should be something that's Numeric

  12. final class AtomicNumberAny[T <: AnyRef] extends AtomicNumber[T]

    Permalink
  13. final class AtomicShort extends AtomicNumber[Short]

    Permalink
  14. sealed trait PaddingStrategy extends AnyRef

    Permalink

    For applying padding to atomic references, in order to reduce cache contention.

    For applying padding to atomic references, in order to reduce cache contention. JEP 142 should reduce the need for this along with the @Contended annotation, however that might have security restrictions, the runtime might not act on it since it's just a recommendation, plus it's nice to provide backwards compatibility.

    See: http://mail.openjdk.java.net/pipermail/hotspot-dev/2012-November/007309.html

    The default strategy is NoPadding. In order to apply padding, you can import an implicit into scope:

    import import org.sincron.atomic.Atomic
    import org.sincron.atomic.PaddingStrategy.Right64
    
    val paddedAtomic = Atomic(10)
    See also

    PaddingStrategy.LeftRight256

    PaddingStrategy.Right128

    PaddingStrategy.Left128

    PaddingStrategy.LeftRight128

    PaddingStrategy.Right64

    PaddingStrategy.Left64

    PaddingStrategy.NoPadding

Value Members

  1. object Atomic

    Permalink
  2. object AtomicAny

    Permalink
  3. object AtomicBoolean

    Permalink
  4. object AtomicBuilder extends Level2

    Permalink
  5. object AtomicByte

    Permalink
  6. object AtomicChar

    Permalink
  7. object AtomicDouble

    Permalink
  8. object AtomicFloat

    Permalink
  9. object AtomicInt

    Permalink
  10. object AtomicLong

    Permalink
  11. object AtomicNumberAny

    Permalink
  12. object AtomicShort

    Permalink
  13. object PaddingStrategy

    Permalink

Inherited from AnyRef

Inherited from Any

Ungrouped