juce::Atomic< Type > Struct Template Reference

A simple wrapper around std::atomic. More...

#include <juce_Atomic.h>

Inheritance diagram for juce::Atomic< Type >:

Collaboration diagram for juce::Atomic< Type >:

Public Types
using	DiffType = typename AtomicHelpers::DiffTypeHelper< Type >::Type

Public Member Functions
	Atomic () noexcept
	Creates a new value, initialised to zero.
	Atomic (const Atomic &other) noexcept
	Copies another value (atomically).
	Atomic (Type initialValue) noexcept
	Creates a new value, with a given initial value.
	~Atomic () noexcept
	Destructor.
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.
Type	exchange (Type newValue) noexcept
	Atomically sets the current value, returning the value that was replaced.
Type	get () const noexcept
	Atomically reads and returns the current value.
void	memoryBarrier () noexcept
	Implements a memory read/write barrier.
Type	operator++ () noexcept
	Atomically increments this value, returning the new value.
Type	operator+= (DiffType amountToAdd) noexcept
	Atomically adds a number to this value, returning the new value.
Type	operator-- () noexcept
	Atomically decrements this value, returning the new value.
Type	operator-= (DiffType amountToSubtract) noexcept
	Atomically subtracts a number from this value, returning the new value.
Atomic< Type > &	operator= (const Atomic &other) noexcept
	Copies another value into this one (atomically).
Atomic< Type > &	operator= (Type newValue) noexcept
	Copies another value into this one (atomically).
void	set (Type newValue) noexcept
	Atomically sets the current value.

Public Attributes
std::atomic< Type >	value
	The std::atomic object that this class operates on.

Detailed Description

template<typename Type>
struct juce::Atomic< Type >

A simple wrapper around std::atomic.

@tags{Core}

Member Typedef Documentation

DiffType

template<typename Type >

using juce::Atomic< Type >::DiffType = typename AtomicHelpers::DiffTypeHelper<Type>::Type

Constructor & Destructor Documentation

Atomic() [1/3]

template<typename Type >

juce::Atomic< Type >::Atomic ( )

inlinenoexcept

Creates a new value, initialised to zero.

Atomic() [2/3]

template<typename Type >

juce::Atomic< Type >::Atomic ( Type  initialValue )

inlinenoexcept

Creates a new value, with a given initial value.

Atomic() [3/3]

template<typename Type >

juce::Atomic< Type >::Atomic ( const Atomic< Type > &  other )

inlinenoexcept

Copies another value (atomically).

~Atomic()

template<typename Type >

juce::Atomic< Type >::~Atomic ( )

inlinenoexcept

Destructor.

Member Function Documentation

compareAndSetBool()

template<typename Type >

bool juce::Atomic< Type >::compareAndSetBool ( Type  newValue, Type  valueToCompare  )

inlinenoexcept

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;
}

Internally, this method calls std::atomic::compare_exchange_strong with memory_order_seq_cst (the strictest std::memory_order).

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

References juce::Atomic< Type >::value.

Referenced by juce::ThreadLocalValue< Type >::get().

exchange()

template<typename Type >

Type juce::Atomic< Type >::exchange ( Type  newValue )

inlinenoexcept

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

References juce::Atomic< Type >::value.

get()

template<typename Type >

Type juce::Atomic< Type >::get ( ) const

inlinenoexcept

Atomically reads and returns the current value.

References juce::Atomic< Type >::value.

Referenced by juce::ThreadLocalValue< Type >::get().

memoryBarrier()

template<typename Type >

void juce::Atomic< Type >::memoryBarrier ( )

inlinenoexcept

Implements a memory read/write barrier.

Internally this calls std::atomic_thread_fence with memory_order_seq_cst (the strictest std::memory_order).

operator++()

template<typename Type >

Type juce::Atomic< Type >::operator++ ( )

inlinenoexcept

Atomically increments this value, returning the new value.

References juce::Atomic< Type >::value.

operator+=()

template<typename Type >

Type juce::Atomic< Type >::operator+= ( DiffType  amountToAdd )

inlinenoexcept

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

References juce::Atomic< Type >::value.

operator--()

template<typename Type >

Type juce::Atomic< Type >::operator-- ( )

inlinenoexcept

Atomically decrements this value, returning the new value.

References juce::Atomic< Type >::value.

operator-=()

template<typename Type >

Type juce::Atomic< Type >::operator-= ( DiffType  amountToSubtract )

inlinenoexcept

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

References juce::Atomic< Type >::value.

operator=() [1/2]

template<typename Type >

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

inlinenoexcept

Copies another value into this one (atomically).

References juce::Atomic< Type >::value.

operator=() [2/2]

template<typename Type >

Atomic< Type > & juce::Atomic< Type >::operator= ( Type  newValue )

inlinenoexcept

Copies another value into this one (atomically).

References juce::Atomic< Type >::value.

set()

template<typename Type >

void juce::Atomic< Type >::set ( Type  newValue )

inlinenoexcept

Atomically sets the current value.

References juce::Atomic< Type >::value.

Member Data Documentation

value

template<typename Type >

std::atomic<Type> juce::Atomic< Type >::value

The std::atomic object that this class operates on.

Referenced by juce::LeakedObjectDetector< OwnerClass >::LeakCounter::~LeakCounter(), juce::Atomic< Type >::compareAndSetBool(), juce::Atomic< Type >::exchange(), juce::Atomic< Type >::get(), juce::Atomic< Type >::operator++(), juce::Atomic< Type >::operator+=(), juce::Atomic< Type >::operator--(), juce::Atomic< Type >::operator-=(), juce::Atomic< Type >::operator=(), juce::Atomic< Type >::operator=(), and juce::Atomic< Type >::set().

---

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

• juce_Atomic.h