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

Inheritance diagram for Atomic< Type >:

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

Public Types inherited from AtomicBase< Type >
typedef AtomicHelpers::DiffTypeHelper< Type >::Type	DiffType

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...

Atomic &	operator= (const Atomic &other) noexcept
	Copies another value into this one (atomically). More...

Atomic &	operator= (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...

Public Member Functions inherited from AtomicBase< Type >
	AtomicBase () noexcept

	AtomicBase (const Type v) noexcept

	AtomicBase (const AtomicBase &other) noexcept

Type	get () const noexcept

AtomicBase &	operator= (const AtomicBase< Type > &other) noexcept

AtomicBase &	operator= (const Type newValue) noexcept

void	set (Type newValue) noexcept

Type	exchange (Type) noexcept

bool	compareAndSetBool (Type, Type) noexcept

Type	compareAndSetValue (Type, Type) noexcept

Static Public Member Functions
static void	memoryBarrier () noexcept
	Implements a memory read/write barrier. More...

Static Public Member Functions inherited from AtomicBase< Type >
static void	memoryBarrier () noexcept

Additional Inherited Members
Public Attributes inherited from AtomicBase< Type >
volatile Type	value
	The raw value that this class operates on. More...

Protected Member Functions inherited from AtomicBase< Type >
Type	operator++ (int)

Type	operator-- (int)

template<typename ValueType >
ValueType	negateValue (ValueType n) noexcept
	This templated negate function will negate pointers as well as integers. More...

template<typename PointerType >
PointerType *	negateValue (PointerType *n) noexcept
	This templated negate function will negate pointers as well as integers. More...

Static Protected Member Functions inherited from AtomicBase< Type >
template<typename Dest , typename Source >
static Dest	castTo (Source value) noexcept

static Type	castFrom32Bit (int32 value) noexcept

static Type	castFrom64Bit (int64 value) noexcept

static int32	castTo32Bit (Type value) noexcept

static int64	castTo64Bit (Type value) noexcept

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.

◆ 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

Atomically reads and returns the current value.

Referenced by ThreadLocalValue< Type >::get(), ThreadLocalValue< Type >::releaseCurrentThreadStorage(), and ThreadLocalValue< Type >::~ThreadLocalValue().

◆ operator=() [1/2]

template<typename Type>

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

noexcept

Copies another value into this one (atomically).

◆ 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< void * >::set().

◆ 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().

◆ 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

◆ memoryBarrier()

template<typename Type>

static void Atomic< Type >::memoryBarrier ( )

staticnoexcept

Implements a memory read/write barrier.

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

juce_Atomic.h

Public Types

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

template<typename Type> class Atomic< Type >

Member Typedef Documentation

◆ DiffType

Constructor & Destructor Documentation

◆ Atomic() [1/3]

◆ Atomic() [2/3]

◆ Atomic() [3/3]

◆ ~Atomic()

Member Function Documentation

◆ get()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ set()

◆ exchange()

◆ compareAndSetBool()

◆ compareAndSetValue()

◆ memoryBarrier()

template<typename Type>
class Atomic< Type >