Packages

abstract class Atomic[A] extends Serializable

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

Source
Atomic.scala
Linear Supertypes
Serializable, Serializable, AnyRef, Any
Known Subclasses
AtomicAny, AtomicBoolean, AtomicByte, AtomicChar, AtomicDouble, AtomicFloat, AtomicInt, AtomicLong, AtomicNumber, AtomicNumberAny, AtomicShort
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Atomic
  2. Serializable
  3. Serializable
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Atomic()

Abstract Value Members

  1. abstract def compareAndSet(expect: A, update: A): Boolean

    Does a compare-and-set operation on the current value.

    Does a compare-and-set operation on the current value. For more info, checkout the related Compare-and-swap Wikipedia page.

    It's an atomic, worry free operation.

    expect

    is the value you expect to be persisted when the operation happens

    update

    will be the new value, should the check for expect succeeds

    returns

    either true in case the operation succeeded or false otherwise

  2. abstract def get: A

    Get the current value persisted by this Atomic.

  3. abstract def getAndSet(update: A): A

    Sets the persisted value to update and returns the old value that was in place.

    Sets the persisted value to update and returns the old value that was in place. It's an atomic, worry free operation.

  4. abstract def lazySet(update: A): Unit

    Eventually sets to the given value.

    Eventually sets to the given value. Has weaker visibility guarantees than the normal set().

  5. abstract def set(update: A): Unit

    Updates the current value.

    Updates the current value.

    update

    will be the new value returned by get()

Concrete Value Members

  1. final macro def :=(value: A): Unit

    Alias for set.

    Alias for set. Updates the current value.

    value

    will be the new value returned by get()

  2. final macro def apply(): A

    Get the current value persisted by this Atomic, an alias for get().

  3. final macro def getAndTransform(cb: (A) ⇒ A): A

    Abstracts over compareAndSet.

    Abstracts over compareAndSet. You specify a transformation by specifying a callback to be executed, a callback that transforms the current value. This method will loop until it will succeed in replacing the current value with the one produced by the given callback.

    Note that the callback will be executed on each iteration of the loop, so it can be called multiple times - don't do destructive I/O or operations that mutate global state in it.

    cb

    is a callback that receives the current value as input and returns the update which is the new value that should be persisted

    returns

    the old value, just prior to when the successful update happened

  4. final macro def transform(cb: (A) ⇒ A): Unit

    Abstracts over compareAndSet.

    Abstracts over compareAndSet. You specify a transformation by specifying a callback to be executed, a callback that transforms the current value. This method will loop until it will succeed in replacing the current value with the one produced by the given callback.

    Note that the callback will be executed on each iteration of the loop, so it can be called multiple times - don't do destructive I/O or operations that mutate global state in it.

    cb

    is a callback that receives the current value as input and returns the update which is the new value that should be persisted

  5. final macro def transformAndExtract[U](cb: (A) ⇒ (U, A)): U

    Abstracts over compareAndSet.

    Abstracts over compareAndSet. You specify a transformation by specifying a callback to be executed, a callback that transforms the current value. This method will loop until it will succeed in replacing the current value with the one produced by your callback.

    Note that the callback will be executed on each iteration of the loop, so it can be called multiple times - don't do destructive I/O or operations that mutate global state in it.

    cb

    is a callback that receives the current value as input and returns a tuple that specifies the update + what should this method return when the operation succeeds.

    returns

    whatever was specified by your callback, once the operation succeeds

  6. final macro def transformAndGet(cb: (A) ⇒ A): A

    Abstracts over compareAndSet.

    Abstracts over compareAndSet. You specify a transformation by specifying a callback to be executed, a callback that transforms the current value. This method will loop until it will succeed in replacing the current value with the one produced by the given callback.

    Note that the callback will be executed on each iteration of the loop, so it can be called multiple times - don't do destructive I/O or operations that mutate global state in it.

    cb

    is a callback that receives the current value as input and returns the update which is the new value that should be persisted

    returns

    whatever the update is, after the operation succeeds

  7. final macro def update(value: A): Unit

    Alias for set.

    Alias for set. Updates the current value.

    value

    will be the new value returned by get()