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

AnyRef, Any

Type Members

abstract class Atomic[T] extends Serializable

Base trait of all atomic references, no matter the type.
final class AtomicAny[T <: AnyRef] extends Atomic[T]

Atomic references wrapping AnyRef values.
final class AtomicBoolean extends Atomic[Boolean]

Atomic references wrapping Boolean values.
trait AtomicBuilder[T, R <: Atomic[T]] extends Serializable

For a given T indicates the most specific Atomic[T] reference type to use.
final class AtomicByte extends AtomicNumber[Byte]

Atomic references wrapping Byte values.
final class AtomicChar extends AtomicNumber[Char]

Atomic references wrapping Char values.
final class AtomicDouble extends AtomicNumber[Double]

Atomic references wrapping Double values.
final class AtomicFloat extends AtomicNumber[Float]

Atomic references wrapping Float values.
final class AtomicInt extends AtomicNumber[Int]

Atomic references wrapping Int values.
final class AtomicLong extends AtomicNumber[Long]

Atomic references wrapping Long values.
abstract class AtomicNumber[T] extends Atomic[T]

Represents an Atomic reference holding a number, providing helpers for easily incrementing and decrementing it.
final class AtomicNumberAny[T <: AnyRef] extends AtomicNumber[T]

Atomic references wrapping any values implementing Scala's Numeric type-class.
final class AtomicShort extends AtomicNumber[Short]

Atomic references wrapping Short values.
sealed trait PaddingStrategy extends AnyRef

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

Value Members

object Atomic extends Serializable
object AtomicAny extends Serializable
object AtomicBoolean extends Serializable
object AtomicBuilder extends Level2 with Serializable
object AtomicByte extends Serializable
object AtomicChar extends Serializable
object AtomicDouble extends Serializable
object AtomicFloat extends Serializable
object AtomicInt extends Serializable
object AtomicLong extends Serializable
object AtomicNumberAny extends Serializable
object AtomicShort extends Serializable
object PaddingStrategy

package atomic

Type Members

abstract class Atomic[T] extends Serializable

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

final class AtomicBoolean extends Atomic[Boolean]

trait AtomicBuilder[T, R <: Atomic[T]] extends Serializable

final class AtomicByte extends AtomicNumber[Byte]

final class AtomicChar extends AtomicNumber[Char]

final class AtomicDouble extends AtomicNumber[Double]

final class AtomicFloat extends AtomicNumber[Float]

final class AtomicInt extends AtomicNumber[Int]

final class AtomicLong extends AtomicNumber[Long]

abstract class AtomicNumber[T] extends Atomic[T]

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

final class AtomicShort extends AtomicNumber[Short]

sealed trait PaddingStrategy extends AnyRef

Value Members

object Atomic extends Serializable

object AtomicAny extends Serializable

object AtomicBoolean extends Serializable

object AtomicBuilder extends Level2 with Serializable

object AtomicByte extends Serializable

object AtomicChar extends Serializable

object AtomicDouble extends Serializable

object AtomicFloat extends Serializable

object AtomicInt extends Serializable

object AtomicLong extends Serializable

object AtomicNumberAny extends Serializable

object AtomicShort extends Serializable

object PaddingStrategy

Inherited from AnyRef

Inherited from Any

Ungrouped