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

#include <atomic.h>

Collaboration diagram for lunchbox::Atomic< T >:

Public Member Functions
	Atomic (const T v=0)
	Construct a new atomic variable with an initial value. More...

	Atomic (const Atomic< T > &v)
	Construct a copy of an atomic variable. More...

	operator T (void) const

void	operator= (const T v)
	Assign a new value. More...

void	operator= (const Atomic< T > &v)
	Assign a new value. More...

T	operator+= (T v)
	Atomically add a value and return the new value. More...

T	operator-= (T v)
	Atomically substract a value and return the new value. More...

T	operator++ (void)
	Atomically increment by one and return the new value. More...

T	operator-- (void)
	Atomically decrement by one and return the new value. More...

T	operator++ (int)
	Atomically increment by one and return the old value. More...

T	operator-- (int)
	Atomically decrement by one and return the old value. More...

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

Static Public Member Functions
static LUNCHBOX_API T	getAndAdd (T &value, const T increment)

static LUNCHBOX_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 LUNCHBOX_API T	incAndGet (T &value)

static LUNCHBOX_API T	decAndGet (T &value)

static LUNCHBOX_API bool	compareAndSwap (T *value, const T expected, const T newValue)
	Perform a compare-and-swap atomic operation. More...

Detailed Description

template<class T>
class lunchbox::Atomic< T >

A variable with atomic semantics and standalone atomic operations.

Use the C++11 equivalent if you can.

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 int32_t and ssize_t are implemented and typedef'd as a_int32_t and a_ssize_t.

Definition at line 87 of file atomic.h.

Constructor & Destructor Documentation

template<class T>

lunchbox::Atomic< T >::Atomic ( const T v = 0 )

explicit

Construct a new atomic variable with an initial value.

Version: 1.0

Definition at line 312 of file atomic.h.

template<class T>

lunchbox::Atomic< T >::Atomic ( const Atomic< T > & v )

Construct a copy of an atomic variable.

Not thread-safe!

Version: 1.0

Definition at line 315 of file atomic.h.

Member Function Documentation

template<class T>

T lunchbox::Atomic< T >::addAndGet	(	T &	value,
		const T	increment
	)

static

Returns: the new value after adding the given increment.

Definition at line 271 of file atomic.h.

References lunchbox::memoryBarrierAcquire(), and lunchbox::memoryBarrierRelease().

Here is the call graph for this function:

template<class T>

static LUNCHBOX_API 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
	)

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

Definition at line 379 of file atomic.h.

template<class T>

T lunchbox::Atomic< T >::decAndGet ( T & value )

static

Returns: the new value after decrementing the value.

Definition at line 306 of file atomic.h.

template<class T>

T lunchbox::Atomic< T >::getAndAdd	(	T &	value,
		const T	increment
	)

static

Returns: the old value, then add the given increment.

Definition at line 241 of file atomic.h.

References lunchbox::memoryBarrierAcquire(), and lunchbox::memoryBarrierRelease().

Here is the call graph for this function:

template<class T>

T lunchbox::Atomic< T >::getAndSub	(	T &	value,
		const T	increment
	)

static

Returns: the old value, then substract the increment.

Definition at line 256 of file atomic.h.

References lunchbox::memoryBarrierAcquire(), and lunchbox::memoryBarrierRelease().

Here is the call graph for this function:

template<class T>

T lunchbox::Atomic< T >::incAndGet ( T & value )

static

Returns: the new value after incrementing the value.

Definition at line 301 of file atomic.h.

template<class T >

lunchbox::Atomic< T >::operator T ( void ) const

Returns: the current value

Version: 1.0

Definition at line 318 of file atomic.h.

References lunchbox::memoryBarrierAcquire().

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 not the given value.

Version: 1.1.2

Definition at line 372 of file atomic.h.

References lunchbox::memoryBarrier().

Here is the call graph for this function:

template<class T >

T lunchbox::Atomic< T >::operator++ ( void )

Atomically increment by one and return the new value.

Version: 1.0

Definition at line 346 of file atomic.h.

template<class T >

T lunchbox::Atomic< T >::operator++ ( int )

Atomically increment by one and return the old value.

Version: 1.0

Definition at line 356 of file atomic.h.

template<class T>

T lunchbox::Atomic< T >::operator+= ( T v )

Atomically add a value and return the new value.

Version: 1.0

Definition at line 336 of file atomic.h.

template<class T >

T lunchbox::Atomic< T >::operator-- ( void )

Atomically decrement by one and return the new value.

Version: 1.0

Definition at line 351 of file atomic.h.

template<class T >

T lunchbox::Atomic< T >::operator-- ( int )

Atomically decrement by one and return the old value.

Version: 1.0

Definition at line 361 of file atomic.h.

template<class T>

T lunchbox::Atomic< T >::operator-= ( T v )

Atomically substract a value and return the new value.

Version: 1.0

Definition at line 341 of file atomic.h.

template<class T>

void lunchbox::Atomic< T >::operator= ( const T v )

Assign a new value.

Version: 1.0

Definition at line 324 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 330 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 366 of file atomic.h.

References lunchbox::memoryBarrier().

Here is the call graph for this function:

template<class T>

T lunchbox::Atomic< T >::subAndGet	(	T &	value,
		const T	increment
	)

static

Returns: the new value after substracting the increment.

Definition at line 286 of file atomic.h.

References lunchbox::memoryBarrierAcquire(), and lunchbox::memoryBarrierRelease().

Here is the call graph for this function:

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

atomic.h

Public Member Functions

Static Public Member Functions

Detailed Description

template<class T> class lunchbox::Atomic< T >

Constructor & Destructor Documentation

Member Function Documentation

template<class T>
class lunchbox::Atomic< T >