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

Linear Supertypes

AnyRef, Any

Type Members

trait Atomic[T] extends Any

Base trait of all atomic references, no matter the type.
final class AtomicAny[T <: AnyRef] extends Atomic[T]
final class AtomicBoolean extends Atomic[Boolean]
trait AtomicBuilder[T, R <: Atomic[T]] extends AnyRef
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]
trait AtomicNumber[T] extends Atomic[T]

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
final class AtomicNumberAny[T <: AnyRef] extends AtomicNumber[T]
final class AtomicShort extends AtomicNumber[Short]
sealed trait PaddingStrategy extends AnyRef

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

Value Members

object Atomic
object AtomicAny
object AtomicBoolean
object AtomicBuilder extends Level2
object AtomicByte
object AtomicChar
object AtomicDouble
object AtomicFloat
object AtomicInt
object AtomicLong
object AtomicNumberAny
object AtomicShort
object PaddingStrategy
package boxes
package inline

package atomic

Type Members

trait Atomic[T] extends Any

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

final class AtomicBoolean extends Atomic[Boolean]

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

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]

trait 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

object AtomicAny

object AtomicBoolean

object AtomicBuilder extends Level2

object AtomicByte

object AtomicChar

object AtomicDouble

object AtomicFloat

object AtomicInt

object AtomicLong

object AtomicNumberAny

object AtomicShort

object PaddingStrategy

package boxes

package inline

Inherited from AnyRef

Inherited from Any

Ungrouped