A variable with atomic semantics and standalone atomic operations. More...
#include <atomic.h>
Public Member Functions | |
| Atomic (const T v=0) | |
| Construct a new atomic variable with an initial value. | |
| Atomic (const Atomic< T > &v) | |
| Construct a copy of an atomic variable. | |
| operator T (void) const | |
| void | operator= (const T v) |
| Assign a new value. | |
| void | operator= (const Atomic< T > &v) |
| Assign a new value. | |
| T | operator+= (T v) |
| Atomically add a value and return the new value. | |
| T | operator-= (T v) |
| Atomically substract a value and return the new value. | |
| T | operator++ (void) |
| Atomically increment by one and return the new value. | |
| T | operator-- (void) |
| Atomically decrement by one and return the new value. | |
| T | operator++ (int) |
| Atomically increment by one and return the old value. | |
| T | operator-- (int) |
| Atomically decrement by one and return the old value. | |
| bool | operator== (const Atomic< T > &rhs) const |
| bool | operator!= (const Atomic< T > &rhs) const |
| bool | compareAndSwap (const T expected, const T newValue) |
| Perform a compare-and-swap atomic operation. | |
Static Public Member Functions | |
| static T | getAndAdd (T &value, const T increment) |
| static T | getAndSub (T &value, const T increment) |
| static T | addAndGet (T &value, const T increment) |
| static T | subAndGet (T &value, const T increment) |
| static T | incAndGet (T &value) |
| static T | decAndGet (T &value) |
| static bool | compareAndSwap (T *value, const T expected, const T newValue) |
| Perform a compare-and-swap atomic operation. | |
Detailed Description
template<class T>
class lunchbox::Atomic< T >
A variable with atomic semantics and standalone atomic operations.
Atomic variables can be modified safely from multiple threads concurrently. They are useful to implement lock-free algorithms.
For implementation reasons, only signed atomic variables are supported, of which only int32_t is implemented right now.
Constructor & Destructor Documentation
template<class T>
| lunchbox::Atomic< T >::Atomic | ( | const T | v = 0 | ) | [explicit] |
template<class T>
| lunchbox::Atomic< T >::Atomic | ( | const Atomic< T > & | v | ) |
Member Function Documentation
template<class T>
| static T lunchbox::Atomic< T >::addAndGet | ( | T & | value, |
| const T | increment | ||
| ) | [static] |
- Returns:
- the new value after adding the given increment.
template<class T>
| static bool lunchbox::Atomic< T >::compareAndSwap | ( | T * | value, |
| const T | expected, | ||
| const T | newValue | ||
| ) | [static] |
Perform a compare-and-swap atomic operation.
template<class T>
| bool lunchbox::Atomic< T >::compareAndSwap | ( | const T | expected, |
| const T | newValue | ||
| ) |
template<class T>
| static T lunchbox::Atomic< T >::decAndGet | ( | T & | value | ) | [static] |
- Returns:
- the new value after decrementing the value.
template<class T>
| static T lunchbox::Atomic< T >::getAndAdd | ( | T & | value, |
| const T | increment | ||
| ) | [static] |
- Returns:
- the old value, then add the given increment.
template<class T>
| static T lunchbox::Atomic< T >::getAndSub | ( | T & | value, |
| const T | increment | ||
| ) | [static] |
- Returns:
- the old value, then substract the increment.
template<class T>
| static T lunchbox::Atomic< T >::incAndGet | ( | T & | value | ) | [static] |
- Returns:
- the new value after incrementing the value.
template<class T >
| lunchbox::Atomic< T >::operator T | ( | void | ) | const |
template<class T>
| bool lunchbox::Atomic< T >::operator!= | ( | const Atomic< T > & | rhs | ) | const |
- Returns:
- true if the variable has not the given value.
- Version:
- 1.1.2
Definition at line 247 of file atomic.h.
References lunchbox::memoryBarrier().
Here is the call graph for this function:
template<class T >
| T lunchbox::Atomic< T >::operator++ | ( | void | ) |
template<class T >
| T lunchbox::Atomic< T >::operator++ | ( | int | ) |
template<class T>
| T lunchbox::Atomic< T >::operator+= | ( | T | v | ) |
template<class T >
| T lunchbox::Atomic< T >::operator-- | ( | void | ) |
template<class T >
| T lunchbox::Atomic< T >::operator-- | ( | int | ) |
template<class T>
| T lunchbox::Atomic< T >::operator-= | ( | T | v | ) |
template<class T>
| void lunchbox::Atomic< T >::operator= | ( | const T | v | ) |
Assign a new value.
- Version:
- 1.0
Definition at line 199 of file atomic.h.
References lunchbox::memoryBarrier().
Here is the call graph for this function:
template<class T>
| void lunchbox::Atomic< T >::operator= | ( | const Atomic< T > & | v | ) |
Assign a new value.
Not thread-safe!
- Version:
- 1.0
Definition at line 205 of file atomic.h.
References lunchbox::memoryBarrier().
Here is the call graph for this function:
template<class T>
| bool lunchbox::Atomic< T >::operator== | ( | const Atomic< T > & | rhs | ) | const |
- Returns:
- true if the variable has the given value.
- Version:
- 1.1.2
Definition at line 241 of file atomic.h.
References lunchbox::memoryBarrier().
Here is the call graph for this function:
template<class T>
| static T lunchbox::Atomic< T >::subAndGet | ( | T & | value, |
| const T | increment | ||
| ) | [static] |
- Returns:
- the new value after substracting the increment.
The documentation for this class was generated from the following file:
