kotlin-stdlib/kotlin.concurrent.atomics/AtomicReference

AtomicReference

An object reference that may be updated atomically.

Platform-specific implementation details:

When targeting the Native backend, AtomicReference stores a volatile variable of type T and atomically updates it. For additional details about atomicity guarantees for reads and writes see kotlin.concurrent.Volatile.

When targeting the JVM, instances of AtomicReference are represented by java.util.concurrent.atomic.AtomicReference. For details about guarantees of volatile accesses and updates of atomics refer to The Java Language Specification (17.4 Memory Model).

For JS and Wasm AtomicReference is implemented trivially and is not thread-safe since these platforms do not support multi-threading.

Since Kotlin

2.1

@ExperimentalAtomicApi

actual class AtomicReference<T>(source)

An object reference that may be updated atomically.

Since the JS platform does not support multi-threading, the implementation is trivial and has no atomic synchronizations.

Since Kotlin

2.1

@ExperimentalAtomicApi

actual class AtomicReference<T>(source)

An object reference that may be updated atomically.

Instances of AtomicReference are represented by java.util.concurrent.atomic.AtomicReference and provide the the same atomicity guarantees.

Since Kotlin

2.1

@ExperimentalAtomicApi

actual class AtomicReference<T>(source)

An object reference that may be updated atomically.

Read operation load has the same memory effects as reading a Volatile property; Write operation store has the same memory effects as writing a Volatile property; Read-modify-write operations, like exchange, compareAndSet, compareAndExchange, have the same memory effects as reading and writing a Volatile property.

For additional details about atomicity guarantees for reads and writes see kotlin.concurrent.Volatile.

Since Kotlin

2.1

@ExperimentalAtomicApi

actual class AtomicReference<T>(source)

An object reference that may be updated atomically.

Since the Wasm platform does not support multi-threading, the implementation is trivial and has no atomic synchronizations.

Since Kotlin

2.1

@ExperimentalAtomicApi

actual class AtomicReference<T>(source)

An object reference that may be updated atomically.

Since the Wasm platform does not support multi-threading, the implementation is trivial and has no atomic synchronizations.

Since Kotlin

2.1

Constructors

AtomicReference

expect constructor(value: T)

actual constructor(value: T)

constructor(value: T)

actual constructor(value: T)

Properties

value

@Volatile

var value: T

Since Kotlin 2.1

Functions

asJavaAtomic

@ExperimentalAtomicApi

fun <T> AtomicReference<T>.asJavaAtomic(): AtomicReference<T>

Casts the given AtomicReference instance to java.util.concurrent.atomic.AtomicReference.

Since Kotlin 2.1

compareAndExchange

expect fun compareAndExchange(expectedValue: T, newValue: T): T

Atomically stores the given new value into this AtomicReference if the current value equals the expected value and returns the old value in any case.

Since Kotlin 2.1

actual fun compareAndExchange(expectedValue: T, newValue: T): T

Atomically stores the given new value into this AtomicReference if the current value equals the expected value and returns the old value in any case.

Since Kotlin 2.1

actual fun compareAndExchange(expectedValue: T, newValue: T): T

Atomically stores the given new value into this AtomicReference if the current value equals the expected value and returns the old value in any case.

Since Kotlin 2.1

actual fun compareAndExchange(expectedValue: T, newValue: T): T

Atomically stores the given new value into this AtomicReference if the current value equals the expected value and returns the old value in any case.

Since Kotlin 2.1

actual fun compareAndExchange(expectedValue: T, newValue: T): T

Atomically stores the given new value into this AtomicReference if the current value equals the expected value and returns the old value in any case.

Since Kotlin 2.1

actual fun compareAndExchange(expectedValue: T, newValue: T): T

Atomically stores the given new value into this AtomicReference if the current value equals the expected value and returns the old value in any case.

Since Kotlin 2.1

compareAndSet

expect fun compareAndSet(expectedValue: T, newValue: T): Boolean

Atomically stores the given new value into this AtomicReference if the current value equals the expected value, returns true if the operation was successful and false only if the current value was not equal to the expected value.

Since Kotlin 2.1

actual fun compareAndSet(expectedValue: T, newValue: T): Boolean

Since Kotlin 2.1

actual fun compareAndSet(expectedValue: T, newValue: T): Boolean

Since Kotlin 2.1

actual fun compareAndSet(expectedValue: T, newValue: T): Boolean

Since Kotlin 2.1

actual fun compareAndSet(expectedValue: T, newValue: T): Boolean

Since Kotlin 2.1

actual fun compareAndSet(expectedValue: T, newValue: T): Boolean

Since Kotlin 2.1

exchange

expect fun exchange(newValue: T): T

Atomically stores the given new value into this AtomicReference. and returns the old value.

Since Kotlin 2.1

actual fun exchange(newValue: T): T

Atomically stores the given new value into this AtomicReference and returns the old value.

Since Kotlin 2.1

actual fun exchange(newValue: T): T

Atomically stores the given new value into this AtomicReference and returns the old value.

Since Kotlin 2.1

actual fun exchange(newValue: T): T

Atomically stores the given new value into this AtomicReference and returns the old value.

Since Kotlin 2.1

actual fun exchange(newValue: T): T

Atomically stores the given new value into this AtomicReference and returns the old value.

Since Kotlin 2.1

actual fun exchange(newValue: T): T

Atomically stores the given new value into this AtomicReference and returns the old value.

Since Kotlin 2.1

getAndSet

fun ~~getAndSet~~(newValue: T): T

Atomically sets the value to the given new value and returns the old value.

Since Kotlin 2.1

load

expect fun load(): T