Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
Public Member Functions | List of all members
QAtomicInteger< T > Class Template Reference

\inmodule QtCore More...

#include <qatomic.h>

+ Inheritance diagram for QAtomicInteger< T >:
+ Collaboration diagram for QAtomicInteger< T >:

Public Member Functions

constexpr QAtomicInteger (T value=0) noexcept
 Constructs a QAtomicInteger with the given value.
 
 QAtomicInteger (const QAtomicInteger &other) noexcept
 Constructs a copy of other.
 
QAtomicInteger & operator= (const QAtomicInteger &other) noexcept
 Assigns other to this QAtomicInteger and returns a reference to this QAtomicInteger.
 
- Public Member Functions inherited from QBasicAtomicInteger< T >
T loadRelaxed () const noexcept
 
void storeRelaxed (T newValue) noexcept
 
T loadAcquire () const noexcept
 
void storeRelease (T newValue) noexcept
 
 operator T () const noexcept
 
T operator= (T newValue) noexcept
 
bool ref () noexcept
 
bool deref () noexcept
 
bool testAndSetRelaxed (T expectedValue, T newValue) noexcept
 
bool testAndSetAcquire (T expectedValue, T newValue) noexcept
 
bool testAndSetRelease (T expectedValue, T newValue) noexcept
 
bool testAndSetOrdered (T expectedValue, T newValue) noexcept
 
bool testAndSetRelaxed (T expectedValue, T newValue, T &currentValue) noexcept
 
bool testAndSetAcquire (T expectedValue, T newValue, T &currentValue) noexcept
 
bool testAndSetRelease (T expectedValue, T newValue, T &currentValue) noexcept
 
bool testAndSetOrdered (T expectedValue, T newValue, T &currentValue) noexcept
 
T fetchAndStoreRelaxed (T newValue) noexcept
 
T fetchAndStoreAcquire (T newValue) noexcept
 
T fetchAndStoreRelease (T newValue) noexcept
 
T fetchAndStoreOrdered (T newValue) noexcept
 
T fetchAndAddRelaxed (T valueToAdd) noexcept
 
T fetchAndAddAcquire (T valueToAdd) noexcept
 
T fetchAndAddRelease (T valueToAdd) noexcept
 
T fetchAndAddOrdered (T valueToAdd) noexcept
 
T fetchAndSubRelaxed (T valueToAdd) noexcept
 
T fetchAndSubAcquire (T valueToAdd) noexcept
 
T fetchAndSubRelease (T valueToAdd) noexcept
 
T fetchAndSubOrdered (T valueToAdd) noexcept
 
T fetchAndAndRelaxed (T valueToAdd) noexcept
 
T fetchAndAndAcquire (T valueToAdd) noexcept
 
T fetchAndAndRelease (T valueToAdd) noexcept
 
T fetchAndAndOrdered (T valueToAdd) noexcept
 
T fetchAndOrRelaxed (T valueToAdd) noexcept
 
T fetchAndOrAcquire (T valueToAdd) noexcept
 
T fetchAndOrRelease (T valueToAdd) noexcept
 
T fetchAndOrOrdered (T valueToAdd) noexcept
 
T fetchAndXorRelaxed (T valueToAdd) noexcept
 
T fetchAndXorAcquire (T valueToAdd) noexcept
 
T fetchAndXorRelease (T valueToAdd) noexcept
 
T fetchAndXorOrdered (T valueToAdd) noexcept
 
T operator++ () noexcept
 
T operator++ (int) noexcept
 
T operator-- () noexcept
 
T operator-- (int) noexcept
 
T operator+= (T v) noexcept
 
T operator-= (T v) noexcept
 
T operator&= (T v) noexcept
 
T operator|= (T v) noexcept
 
T operator^= (T v) noexcept
 
 QBasicAtomicInteger ()=default
 
constexpr QBasicAtomicInteger (T value) noexcept
 
 QBasicAtomicInteger (const QBasicAtomicInteger &)=delete
 
QBasicAtomicInteger & operator= (const QBasicAtomicInteger &)=delete
 
QBasicAtomicInteger & operator= (const QBasicAtomicInteger &) volatile =delete
 

Additional Inherited Members

- Public Types inherited from QBasicAtomicInteger< T >
typedef T Type
 
typedef QAtomicOps< T > Ops
 
- Static Public Member Functions inherited from QBasicAtomicInteger< T >
static constexpr bool isReferenceCountingNative () noexcept
 
static constexpr bool isReferenceCountingWaitFree () noexcept
 
static constexpr bool isTestAndSetNative () noexcept
 
static constexpr bool isTestAndSetWaitFree () noexcept
 
static constexpr bool isFetchAndStoreNative () noexcept
 
static constexpr bool isFetchAndStoreWaitFree () noexcept
 
static constexpr bool isFetchAndAddNative () noexcept
 
static constexpr bool isFetchAndAddWaitFree () noexcept
 
- Public Attributes inherited from QBasicAtomicInteger< T >
Ops::Type _q_value
 

Detailed Description

template<typename T>
class QAtomicInteger< T >

\inmodule QtCore

The QAtomicInteger class provides platform-independent atomic operations on integers.

Since
5.3

For atomic operations on pointers, see the QAtomicPointer class.

An atomic operation is a complex operation that completes without interruption. The QAtomicInteger class provides atomic reference counting, test-and-set, fetch-and-store, and fetch-and-add for integers.

The template parameter T must be a C++ integer type: \list

  • 8-bit: bool, char, signed char, unsigned char, qint8, quint8, char8_t (C++20)
  • 16-bit: short, unsigned short, qint16, quint16, char16_t
  • 32-bit: int, unsigned int, qint32, quint32, char32_t
  • 64-bit: long long, unsigned long long, qint64, quint64
  • platform-specific size: long, unsigned long
  • pointer size: qintptr, quintptr, qptrdiff \endlist

Of the list above, only the 8-bit, 16-bit, 32-bit- and pointer-sized instantiations are guaranteed to work on all platforms. Support for other sizes depends on the compiler and processor architecture the code is being compiled for. To test whether the 64-bit types are supported on 32-bit platforms, check the macro Q_ATOMIC_INT64_IS_SUPPORTED.

Definition at line 17 of file qatomic.h.

Constructor & Destructor Documentation

◆ QAtomicInteger() [1/2]

template<typename T>
QAtomicInteger< T >::QAtomicInteger ( T value = 0)
inlineconstexprnoexcept

Constructs a QAtomicInteger with the given value.

Definition at line 21 of file qatomic.h.

◆ QAtomicInteger() [2/2]

template<typename T>
QAtomicInteger< T >::QAtomicInteger ( const QAtomicInteger< T > & other)
inlinenoexcept

Constructs a copy of other.

Definition at line 23 of file qatomic.h.

Member Function Documentation

◆ operator=()

template<typename T>
QAtomicInteger & QAtomicInteger< T >::operator= ( const QAtomicInteger< T > & other)
inlinenoexcept

Assigns other to this QAtomicInteger and returns a reference to this QAtomicInteger.

Since
5.3

Atomically stores the other value into this atomic type using a sequentially consistent memory ordering if possible; or "Release" ordering if not. This function returns a reference to this object.

See also
storeRelaxed(), storeRelease()

Definition at line 29 of file qatomic.h.

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