co::base::Atomic< T > Class Template Reference

A variable with atomic semantics and standalone atomic operations. More...

#include <atomic.h>

List of all members.

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 COBASE_API T	getAndAdd (T &value, const T increment)
static COBASE_API T	getAndSub (T &value, const T increment)
static T	addAndGet (T &value, const T increment)
static T	subAndGet (T &value, const T increment)
static COBASE_API T	incAndGet (T &value)
static COBASE_API T	decAndGet (T &value)
static COBASE_API bool	compareAndSwap (T *value, const T expected, const T newValue)
	Perform a compare-and-swap atomic operation.

---

Detailed Description

template<class T>
class co::base::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.

Definition at line 58 of file co/base/atomic.h.

---

Constructor & Destructor Documentation

template<class T >

co::base::Atomic< T >::Atomic

(

const T

v = 0

)

[explicit]

Construct a new atomic variable with an initial value.

Version:

1.0

template<class T >

co::base::Atomic< T >::Atomic

(

const Atomic< T > &

v

)

Construct a copy of an atomic variable.

Not thread-safe!

Version:

1.0

---

Member Function Documentation

template<class T >

static T co::base::Atomic< T >::addAndGet	(	T &	value,
		const T	increment
	)		[static]

Returns:

the new value after adding the given increment.

template<class T >

static COBASE_API bool co::base::Atomic< T >::compareAndSwap	(	T *	value,
		const T	expected,
		const T	newValue
	)		[static]

Perform a compare-and-swap atomic operation.

template<class T >

bool co::base::Atomic< T >::compareAndSwap	(	const T	expected,
		const T	newValue
	)

Perform a compare-and-swap atomic operation.

Atomically replaces the value and return true if the value matched the expected.

Returns:

true if the new value was set, false otherwise

Version:

1.1.2

template<class T >

static COBASE_API T co::base::Atomic< T >::decAndGet

(

T &

value

)

[static]

Returns:

the new value after decrementing the value.

template<class T >

static COBASE_API T co::base::Atomic< T >::getAndAdd	(	T &	value,
		const T	increment
	)		[static]

Returns:

the old value, then add the given increment.

template<class T >

static COBASE_API T co::base::Atomic< T >::getAndSub	(	T &	value,
		const T	increment
	)		[static]

Returns:

the old value, then substract the increment.

template<class T >

static COBASE_API T co::base::Atomic< T >::incAndGet

(

T &

value

)

[static]

Returns:

the new value after incrementing the value.

template<class T >

co::base::Atomic< T >::operator T

(

void

)

const

Returns:

the current value

Version:

1.0

template<class T >

bool co::base::Atomic< T >::operator!=

(

const Atomic< T > &

rhs

)

const

Returns:

true if the variable has not the given value.

Version:

1.1.2

template<class T >

T co::base::Atomic< T >::operator++

(

void

)

Atomically increment by one and return the new value.

Version:

1.0

template<class T >

T co::base::Atomic< T >::operator++

(

int

)

Atomically increment by one and return the old value.

Version:

1.0

template<class T >

T co::base::Atomic< T >::operator+=

(

T

v

)

Atomically add a value and return the new value.

Version:

1.0

template<class T >

T co::base::Atomic< T >::operator--

(

void

)

Atomically decrement by one and return the new value.

Version:

1.0

template<class T >

T co::base::Atomic< T >::operator--

(

int

)

Atomically decrement by one and return the old value.

Version:

1.0

template<class T >

T co::base::Atomic< T >::operator-=

(

T

v

)

Atomically substract a value and return the new value.

Version:

1.0

template<class T >

void co::base::Atomic< T >::operator=

(

const T

v

)

Assign a new value.

Version:

1.0

template<class T >

void co::base::Atomic< T >::operator=

(

const Atomic< T > &

v

)

Assign a new value.

Not thread-safe!

Version:

1.0

template<class T >

bool co::base::Atomic< T >::operator==

(

const Atomic< T > &

rhs

)

const

Returns:

true if the variable has the given value.

Version:

1.1.2

template<class T >

static T co::base::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:

• co/base/atomic.h