Packages

object AtomicAny extends Serializable

Source
AtomicAny.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AtomicAny
  2. Serializable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. def apply[A <: AnyRef](initialValue: A): AtomicAny[A]

    Builds an AtomicAny reference.

    Builds an AtomicAny reference.

    initialValue

    is the initial value with which to initialize the atomic

  2. def create[A <: AnyRef](initialValue: A, padding: PaddingStrategy, allowPlatformIntrinsics: Boolean): AtomicAny[A]

    Constructs an AtomicAny reference, allowing for fine-tuning of the created instance.

    Constructs an AtomicAny reference, allowing for fine-tuning of the created instance.

    A PaddingStrategy can be provided in order to counter the "false sharing" problem.

    Note that for Scala.js we aren't applying any padding, as it doesn't make much sense, since Javascript execution is single threaded, but this builder is provided for syntax compatibility anyway across the JVM and Javascript and we never know how Javascript engines will evolve.

    Also this builder on top Java 8 also allows for turning off the Java 8 intrinsics, thus forcing usage of CAS-loops for getAndSet and for getAndAdd.

    initialValue

    is the initial value with which to initialize the atomic

    padding

    is the PaddingStrategy to apply

    allowPlatformIntrinsics

    is a boolean parameter that specifies whether the instance is allowed to use the Java 8 optimized operations for getAndSet and for getAndAdd

  3. def safe[A <: AnyRef](initialValue: A, padding: PaddingStrategy): AtomicAny[A]

    Constructs an AtomicAny reference, allowing for fine-tuning of the created instance.

    Constructs an AtomicAny reference, allowing for fine-tuning of the created instance.

    A PaddingStrategy can be provided in order to counter the "false sharing" problem.

    Note that for Scala.js we aren't applying any padding, as it doesn't make much sense, since Javascript execution is single threaded, but this builder is provided for syntax compatibility anyway across the JVM and Javascript and we never know how Javascript engines will evolve.

    This builder guarantees to construct a safe atomic reference that does not make use of sun.misc.Unsafe. On top of platforms that don't support it, notably some versions of Android or on top of the upcoming Java 9, this might be desirable.

    NOTE that explicit usage of this builder is not usually necessary because create can auto-detect whether the underlying platform supports sun.misc.Unsafe and if it does, then its usage is recommended, because the "safe" atomic instances have overhead.

    initialValue

    is the initial value with which to initialize the atomic

    padding

    is the PaddingStrategy to apply

  4. def withPadding[A <: AnyRef](initialValue: A, padding: PaddingStrategy): AtomicAny[A]

    Constructs an AtomicAny reference, allowing for fine-tuning of the created instance.

    Constructs an AtomicAny reference, allowing for fine-tuning of the created instance.

    A PaddingStrategy can be provided in order to counter the "false sharing" problem.

    Note that for Scala.js we aren't applying any padding, as it doesn't make much sense, since Javascript execution is single threaded, but this builder is provided for syntax compatibility anyway across the JVM and Javascript and we never know how Javascript engines will evolve.

    initialValue

    is the initial value with which to initialize the atomic

    padding

    is the PaddingStrategy to apply