Atomic

actual typealias Atomic<V> = AtomicReference<V>

expect class Atomic<V>(initialValue: V)

Atomic value of V.

import arrow.atomic.AtomicInt
import arrow.atomic.update
import arrow.atomic.value
import arrow.fx.coroutines.parMap

suspend fun main() {
  val count = AtomicInt(0)
  (0 until 20_000).parMap {
    count.update(Int::inc)
  }
  println(count.value)
}

Atomic also offers some other interesting operators such as loop, update, tryUpdate, etc.

WARNING: Use AtomicInt and AtomicLong for Int and Long on Kotlin Native!

actual class Atomic<V>(initialValue: V)

Constructors

Atomic

expect constructor(initialValue: V)

actual constructor(initialValue: V)

Properties

value

var <T> Atomic<T>.value: T

Functions

compareAndSet

expect fun compareAndSet(expected: V, new: V): Boolean

Compare current value with expected and set to new if they're the same. Note, 'compare' is checking the actual object id, not 'equals'.

actual fun compareAndSet(expected: V, new: V): Boolean

get

expect fun get(): V

actual fun get(): V

getAndSet

expect fun getAndSet(value: V): V

actual fun getAndSet(value: V): V

getAndUpdate

inline fun <V> Atomic<V>.getAndUpdate(function: (V) -> V): V

Updates variable atomically using the specified function of its value and returns its old value.

loop

inline fun <V> Atomic<V>.loop(action: (V) -> Unit): Nothing

Infinite loop that reads this atomic variable and performs the specified action on its value.

set

expect fun set(value: V)

actual fun set(value: V)

tryUpdate

inline fun <V> Atomic<V>.tryUpdate(function: (V) -> V): Boolean

inline fun <V, U : V> Atomic<V>.tryUpdate(function: (V) -> U, onUpdated: (old: V, new: U) -> Unit): Boolean

update

inline fun <V> Atomic<V>.update(function: (V) -> V)

inline fun <V, U : V, R> Atomic<V>.update(function: (V) -> U, transform: (old: V, new: U) -> R): R

updateAndGet

inline fun <V> Atomic<V>.updateAndGet(function: (V) -> V): V

Updates variable atomically using the specified function of its value and returns its new value.