Simple class to hold a primitive value and perform atomic operations on it. More...

Inherits AtomicBase< Type >.

Public Types

typedef AtomicBase< Type >::DiffType DiffType
 Resulting type when subtracting the underlying Type. More...
 

Public Member Functions

 Atomic () noexcept
 Creates a new value, initialised to zero. More...
 
 Atomic (const Type initialValue) noexcept
 Creates a new value, with a given initial value. More...
 
 Atomic (const Atomic &other) noexcept
 Copies another value (atomically). More...
 
 ~Atomic () noexcept
 Destructor. More...
 
Type get () const noexcept
 Atomically reads and returns the current value. More...
 
Atomicoperator= (const Atomic &other) noexcept
 Copies another value into this one (atomically). More...
 
Atomicoperator= (const Type newValue) noexcept
 Copies another value into this one (atomically). More...
 
void set (Type newValue) noexcept
 Atomically sets the current value. More...
 
Type exchange (Type v) noexcept
 Atomically sets the current value, returning the value that was replaced. More...
 
Type operator+= (DiffType amountToAdd) noexcept
 Atomically adds a number to this value, returning the new value. More...
 
Type operator-= (DiffType amountToSubtract) noexcept
 Atomically subtracts a number from this value, returning the new value. More...
 
Type operator++ () noexcept
 Atomically increments this value, returning the new value. More...
 
Type operator-- () noexcept
 Atomically decrements this value, returning the new value. More...
 
bool compareAndSetBool (Type newValue, Type valueToCompare) noexcept
 Atomically compares this value with a target value, and if it is equal, sets this to be equal to a new value. More...
 
Type compareAndSetValue (Type newValue, Type valueToCompare) noexcept
 Atomically compares this value with a target value, and if it is equal, sets this to be equal to a new value. More...
 

Static Public Member Functions

static void memoryBarrier () noexcept
 Implements a memory read/write barrier. More...
 

Detailed Description

template<typename Type>
class Atomic< Type >

Simple class to hold a primitive value and perform atomic operations on it.

The type used must be a 32 or 64 bit primitive, like an int, pointer, etc. There are methods to perform most of the basic atomic operations.

Member Typedef Documentation

◆ DiffType

template<typename Type>
typedef AtomicBase<Type>::DiffType Atomic< Type >::DiffType

Resulting type when subtracting the underlying Type.

Constructor & Destructor Documentation

◆ Atomic() [1/3]

template<typename Type>
Atomic< Type >::Atomic ( )
noexcept

Creates a new value, initialised to zero.

Referenced by Atomic< Thread::ThreadID >::memoryBarrier().

◆ Atomic() [2/3]

template<typename Type>
Atomic< Type >::Atomic ( const Type  initialValue)
explicitnoexcept

Creates a new value, with a given initial value.

◆ Atomic() [3/3]

template<typename Type>
Atomic< Type >::Atomic ( const Atomic< Type > &  other)
noexcept

Copies another value (atomically).

◆ ~Atomic()

template<typename Type>
Atomic< Type >::~Atomic ( )
noexcept

Destructor.

Member Function Documentation

◆ get()

template<typename Type>
Type Atomic< Type >::get ( ) const
noexcept

◆ operator=() [1/2]

template<typename Type>
Atomic& Atomic< Type >::operator= ( const Atomic< Type > &  other)
noexcept

Copies another value into this one (atomically).

Referenced by Atomic< Thread::ThreadID >::memoryBarrier().

◆ operator=() [2/2]

template<typename Type>
Atomic& Atomic< Type >::operator= ( const Type  newValue)
noexcept

Copies another value into this one (atomically).

◆ set()

template<typename Type>
void Atomic< Type >::set ( Type  newValue)
noexcept

Atomically sets the current value.

◆ exchange()

template<typename Type>
Type Atomic< Type >::exchange ( Type  v)
noexcept

Atomically sets the current value, returning the value that was replaced.

Referenced by Atomic< Thread::ThreadID >::memoryBarrier().

◆ operator+=()

template<typename Type>
Type Atomic< Type >::operator+= ( DiffType  amountToAdd)
noexcept

Atomically adds a number to this value, returning the new value.

Referenced by Atomic< Thread::ThreadID >::memoryBarrier().

◆ operator-=()

template<typename Type>
Type Atomic< Type >::operator-= ( DiffType  amountToSubtract)
noexcept

Atomically subtracts a number from this value, returning the new value.

Referenced by Atomic< Thread::ThreadID >::memoryBarrier().

◆ operator++()

template<typename Type>
Type Atomic< Type >::operator++ ( )
noexcept

Atomically increments this value, returning the new value.

Referenced by Atomic< Thread::ThreadID >::memoryBarrier().

◆ operator--()

template<typename Type>
Type Atomic< Type >::operator-- ( )
noexcept

Atomically decrements this value, returning the new value.

Referenced by Atomic< Thread::ThreadID >::memoryBarrier().

◆ compareAndSetBool()

template<typename Type>
bool Atomic< Type >::compareAndSetBool ( Type  newValue,
Type  valueToCompare 
)
noexcept

Atomically compares this value with a target value, and if it is equal, sets this to be equal to a new value.

This operation is the atomic equivalent of doing this:

bool compareAndSetBool (Type newValue, Type valueToCompare)
{
if (get() == valueToCompare)
{
set (newValue);
return true;
}
return false;
}
Returns
true if the comparison was true and the value was replaced; false if the comparison failed and the value was left unchanged.
See also
compareAndSetValue

Referenced by ThreadLocalValue< Type >::get(), and Atomic< Thread::ThreadID >::memoryBarrier().

◆ compareAndSetValue()

template<typename Type>
Type Atomic< Type >::compareAndSetValue ( Type  newValue,
Type  valueToCompare 
)
noexcept

Atomically compares this value with a target value, and if it is equal, sets this to be equal to a new value.

This operation is the atomic equivalent of doing this:

Type compareAndSetValue (Type newValue, Type valueToCompare)
{
Type oldValue = get();
if (oldValue == valueToCompare)
set (newValue);
return oldValue;
}
Returns
the old value before it was changed.
See also
compareAndSetBool

Referenced by Atomic< Thread::ThreadID >::memoryBarrier().

◆ memoryBarrier()

template<typename Type>
static void Atomic< Type >::memoryBarrier ( )
staticnoexcept

Implements a memory read/write barrier.

Referenced by Atomic< Thread::ThreadID >::memoryBarrier().


The documentation for this class was generated from the following file: