Trait/Object

monifu.concurrent.atomic

Atomic

Related Docs: object Atomic | package atomic

Permalink

trait Atomic[T] extends Any

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

Source: Atomic.scala

Linear Supertypes

Known Subclasses

AtomicAny, AtomicBoolean, AtomicByte, AtomicChar, AtomicDouble, AtomicFloat, AtomicInt, AtomicLong, AtomicNumber, AtomicNumberAny, AtomicShort, BlockableAtomic

Ordering

Alphabetic
By Inheritance

Inherited

Atomic
Any

Hide All
Show All

Visibility

Public
All

Abstract Value Members

abstract def :=(value: T): Unit

Alias for set().
Alias for set(). Updates the current value.
value
will be the new value returned by get()
abstract def compareAndSet(expect: T, update: T): 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
abstract def get: T

returns
the current value persisted by this Atomic
abstract def getAndSet(update: T): T

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.
abstract def getAndTransform(cb: (T) ⇒ T): T

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
abstract def getClass(): Class[_]

Definition Classes
Any
abstract def lazySet(update: T): Unit

Eventually sets to the given value.
Eventually sets to the given value. Has weaker visibility guarantees than the normal set().
abstract def set(update: T): Unit

Updates the current value.
Updates the current value.
update
will be the new value returned by get()
abstract def transform(cb: (T) ⇒ T): 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
abstract def transformAndExtract[U](cb: (T) ⇒ (U, T)): 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
abstract def transformAndGet(cb: (T) ⇒ T): T

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
abstract def update(value: T): Unit

Alias for set().
Alias for set(). Updates the current value.
value
will be the new value returned by get()

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
Any
final def ##(): Int

Definition Classes
Any
final def ==(arg0: Any): Boolean

Definition Classes
Any
def apply(): T

returns
the current value persisted by this Atomic, an alias for get()
final def asInstanceOf[T0]: T0

Definition Classes
Any
def equals(arg0: Any): Boolean

Definition Classes
Any
def hashCode(): Int

Definition Classes
Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def toString(): String

Definition Classes
Any

Inherited from Any

Ungrouped