#include <bsls_atomicoperations_default.h>

Inheritance diagram for bsls::AtomicOperations_DefaultUint64< IMP >:

Public Types
typedef Atomic_TypeTraits< IMP >	AtomicTypes

Static Public Member Functions
static Types::Uint64	getUint64 (typename AtomicTypes::Uint64 const *atomicUint)

static Types::Uint64	getUint64Acquire (typename AtomicTypes::Uint64 const *atomicUint)

static Types::Uint64	getUint64Relaxed (typename AtomicTypes::Uint64 const *atomicUint)

static void	initUint64 (typename AtomicTypes::Uint64 *atomicUint, Types::Uint64 initialValue=0)

static void	setUint64 (typename AtomicTypes::Uint64 *atomicUint, Types::Uint64 value)

static void	setUint64Relaxed (typename AtomicTypes::Uint64 *atomicUint, Types::Uint64 value)

static void	setUint64Release (typename AtomicTypes::Uint64 *atomicUint, Types::Uint64 value)

static Types::Uint64	swapUint64 (typename AtomicTypes::Uint64 *atomicUint, Types::Uint64 swapValue)

static Types::Uint64	swapUint64AcqRel (typename AtomicTypes::Uint64 *atomicUint, Types::Uint64 swapValue)

static Types::Uint64	testAndSwapUint64 (typename AtomicTypes::Uint64 *atomicUint, Types::Uint64 compareValue, Types::Uint64 swapValue)

static Types::Uint64	testAndSwapUint64AcqRel (typename AtomicTypes::Uint64 *atomicUint, Types::Uint64 compareValue, Types::Uint64 swapValue)

static void	addUint64 (typename AtomicTypes::Uint64 *atomicUint, Types::Uint64 value)

static void	addUint64AcqRel (typename AtomicTypes::Uint64 *atomicUint, Types::Uint64 value)

static void	addUint64Relaxed (typename AtomicTypes::Uint64 *atomicUint, Types::Uint64 value)

static Types::Uint64	addUint64Nv (typename AtomicTypes::Uint64 *atomicUint, Types::Uint64 value)

static Types::Uint64	addUint64NvAcqRel (typename AtomicTypes::Uint64 *atomicUint, Types::Uint64 value)

static Types::Uint64	addUint64NvRelaxed (typename AtomicTypes::Uint64 *atomicUint, Types::Uint64 value)

static void	decrementUint64 (typename AtomicTypes::Uint64 *atomicUint)

static void	decrementUint64AcqRel (typename AtomicTypes::Uint64 *atomicUint)

static Types::Uint64	decrementUint64Nv (typename AtomicTypes::Uint64 *atomicUint)

static Types::Uint64	decrementUint64NvAcqRel (typename AtomicTypes::Uint64 *atomicUint)

static void	incrementUint64 (typename AtomicTypes::Uint64 *atomicUint)

static void	incrementUint64AcqRel (typename AtomicTypes::Uint64 *atomicUint)

static Types::Uint64	incrementUint64Nv (typename AtomicTypes::Uint64 *atomicUint)

static Types::Uint64	incrementUint64NvAcqRel (typename AtomicTypes::Uint64 *atomicUint)

static Types::Uint64	subtractUint64Nv (typename AtomicTypes::Uint64 *atomicUint, Types::Uint64 value)

static Types::Uint64	subtractUint64NvAcqRel (typename AtomicTypes::Uint64 *atomicUint, Types::Uint64 value)

static Types::Uint64	subtractUint64NvRelaxed (typename AtomicTypes::Uint64 *atomicUint, Types::Uint64 value)

Detailed Description

template<class IMP>
struct bsls::AtomicOperations_DefaultUint64< IMP >

This class provides default implementations of non-essential atomic operations for the 64-bit unsigned integer type independent on any specific platform. It also provides prototypes for the atomic operations for the 64-bit unsigned integer type that have to be implemented separately for each specific platform. These platform-independent and platform-specific atomic operations together form a full set of atomic operations for the 64-bit unsigned integer type.

Note that AtomicOperations_DefaultUint64 is implemented in terms of the following atomic operations on the Int64 type that must be provided by the IMP template parameter.

static Types::Int64 getInt64(
                         typename AtomicTypes::Int64 const *atomicInt);
static Types::Int64 getInt64Relaxed(
                         typename AtomicTypes::Int64 const *atomicInt);
static Types::Int64 getInt64Acquire(
                         typename AtomicTypes::Int64 const *atomicInt);
static void setInt64(typename AtomicTypes::Int64 *atomicInt,
                     Types::Int64 value);
static void setInt64Relaxed(typename AtomicTypes::Int64 *atomicInt,
                            Types::Int64 value);
static void setInt64Release(typename AtomicTypes::Int64 *atomicInt,
                            Types::Int64 value);
static Types::Int64 swapInt64(typename AtomicTypes::Int64 *atomicInt,
                              Types::Int64 swapValue);
static Types::Int64 swapInt64AcqRel(
                                typename AtomicTypes::Int64 *atomicInt,
                                Types::Int64 swapValue);
static Types::Int64 testAndSwapInt64(
                                typename AtomicTypes::Int64 *atomicInt,
                                Types::Int64 compareValue,
                                Types::Int64 swapValue);
static Types::Int64 testAndSwapInt64AcqRel(
                                typename AtomicTypes::Int64 *atomicInt,
                                Types::Int64 compareValue,
                                Types::Int64 swapValue);

Member Typedef Documentation

◆ AtomicTypes

template<class IMP >

typedef Atomic_TypeTraits<IMP> bsls::AtomicOperations_DefaultUint64< IMP >::AtomicTypes

Member Function Documentation

◆ addUint64()

template<class IMP >

void bsls::AtomicOperations_DefaultUint64< IMP >::addUint64	(	typename AtomicTypes::Uint64 *	atomicUint,
		Types::Uint64	value
	)

inlinestatic

Atomically add to the specified atomicUint the specified value, providing the sequential consistency memory ordering guarantee.

◆ addUint64AcqRel()

template<class IMP >

void bsls::AtomicOperations_DefaultUint64< IMP >::addUint64AcqRel	(	typename AtomicTypes::Uint64 *	atomicUint,
		Types::Uint64	value
	)

inlinestatic

Atomically add to the specified atomicUint the specified value, providing the acquire/release memory ordering guarantee.

◆ addUint64Nv()

template<class IMP >

Types::Uint64 bsls::AtomicOperations_DefaultUint64< IMP >::addUint64Nv	(	typename AtomicTypes::Uint64 *	atomicUint,
		Types::Uint64	value
	)

inlinestatic

Atomically add to the specified atomicUint the specified value and return the resulting value, providing the sequential consistency memory ordering guarantee.

◆ addUint64NvAcqRel()

template<class IMP >

Types::Uint64 bsls::AtomicOperations_DefaultUint64< IMP >::addUint64NvAcqRel	(	typename AtomicTypes::Uint64 *	atomicUint,
		Types::Uint64	value
	)

inlinestatic

Atomically add to the specified atomicUint the specified value and return the resulting value, providing the acquire/release memory ordering guarantee.

◆ addUint64NvRelaxed()

template<class IMP >

Types::Uint64 bsls::AtomicOperations_DefaultUint64< IMP >::addUint64NvRelaxed	(	typename AtomicTypes::Uint64 *	atomicUint,
		Types::Uint64	value
	)

inlinestatic

Atomically add to the specified atomicUint the specified value and return the resulting value, without providing any memory ordering guarantees.

◆ addUint64Relaxed()

template<class IMP >

void bsls::AtomicOperations_DefaultUint64< IMP >::addUint64Relaxed	(	typename AtomicTypes::Uint64 *	atomicUint,
		Types::Uint64	value
	)

inlinestatic

Atomically add to the specified atomicUint the specified value, without providing any memory ordering guarantees.

◆ decrementUint64()

template<class IMP >

void bsls::AtomicOperations_DefaultUint64< IMP >::decrementUint64 ( typename AtomicTypes::Uint64 * atomicUint )

inlinestatic

Atomically decrement the specified atomicUint by 1, providing the sequential consistency memory ordering guarantee.

◆ decrementUint64AcqRel()

template<class IMP >

void bsls::AtomicOperations_DefaultUint64< IMP >::decrementUint64AcqRel ( typename AtomicTypes::Uint64 * atomicUint )

inlinestatic

Atomically decrement the specified atomicUint by 1, providing the acquire/release memory ordering guarantee.

◆ decrementUint64Nv()

template<class IMP >

Types::Uint64 bsls::AtomicOperations_DefaultUint64< IMP >::decrementUint64Nv ( typename AtomicTypes::Uint64 * atomicUint )

inlinestatic

Atomically decrement the specified atomicUint by 1 and return the resulting value, providing the sequential consistency memory ordering guarantee.

◆ decrementUint64NvAcqRel()

template<class IMP >

Types::Uint64 bsls::AtomicOperations_DefaultUint64< IMP >::decrementUint64NvAcqRel ( typename AtomicTypes::Uint64 * atomicUint )

inlinestatic

Atomically decrement the specified atomicUint by 1 and return the resulting value, providing the acquire/release memory ordering guarantee.

◆ getUint64()

template<class IMP >

Types::Uint64 bsls::AtomicOperations_DefaultUint64< IMP >::getUint64 ( typename AtomicTypes::Uint64 const * atomicUint )

inlinestatic

Atomically retrieve the value of the specified atomicUint, providing the sequential consistency memory ordering guarantee.

◆ getUint64Acquire()

template<class IMP >

Types::Uint64 bsls::AtomicOperations_DefaultUint64< IMP >::getUint64Acquire ( typename AtomicTypes::Uint64 const * atomicUint )

inlinestatic

Atomically retrieve the value of the specified atomicUint, providing the acquire memory ordering guarantee.

◆ getUint64Relaxed()

template<class IMP >

Types::Uint64 bsls::AtomicOperations_DefaultUint64< IMP >::getUint64Relaxed ( typename AtomicTypes::Uint64 const * atomicUint )

inlinestatic

Atomically retrieve the value of the specified atomicUint, without providing any memory ordering guarantees.

◆ incrementUint64()

template<class IMP >

void bsls::AtomicOperations_DefaultUint64< IMP >::incrementUint64 ( typename AtomicTypes::Uint64 * atomicUint )

inlinestatic

Atomically increment the value of the specified atomicUint by 1, providing the sequential consistency memory ordering guarantee.

◆ incrementUint64AcqRel()

template<class IMP >

void bsls::AtomicOperations_DefaultUint64< IMP >::incrementUint64AcqRel ( typename AtomicTypes::Uint64 * atomicUint )

inlinestatic

Atomically increment the value of the specified atomicUint by 1, providing the acquire/release memory ordering guarantee.

◆ incrementUint64Nv()

template<class IMP >

Types::Uint64 bsls::AtomicOperations_DefaultUint64< IMP >::incrementUint64Nv ( typename AtomicTypes::Uint64 * atomicUint )

inlinestatic

Atomically increment the specified atomicUint by 1 and return the resulting value, providing the sequential consistency memory ordering guarantee.

◆ incrementUint64NvAcqRel()

template<class IMP >

Types::Uint64 bsls::AtomicOperations_DefaultUint64< IMP >::incrementUint64NvAcqRel ( typename AtomicTypes::Uint64 * atomicUint )

inlinestatic

Atomically increment the specified atomicUint by 1 and return the resulting value, providing the acquire/release memory ordering guarantee.

◆ initUint64()

template<class IMP >

void bsls::AtomicOperations_DefaultUint64< IMP >::initUint64	(	typename AtomicTypes::Uint64 *	atomicUint,
		Types::Uint64	initialValue = `0`
	)

inlinestatic

Initialize the specified atomicUint and set its value to the optionally specified initialValue.

◆ setUint64()

template<class IMP >

void bsls::AtomicOperations_DefaultUint64< IMP >::setUint64	(	typename AtomicTypes::Uint64 *	atomicUint,
		Types::Uint64	value
	)

inlinestatic

Atomically set the value of the specified atomicUint to the specified value, providing the sequential consistency memory ordering guarantee.

◆ setUint64Relaxed()

template<class IMP >

void bsls::AtomicOperations_DefaultUint64< IMP >::setUint64Relaxed	(	typename AtomicTypes::Uint64 *	atomicUint,
		Types::Uint64	value
	)

inlinestatic

Atomically set the value of the specified atomicUint to the specified value, without providing any memory ordering guarantees.

◆ setUint64Release()

template<class IMP >

void bsls::AtomicOperations_DefaultUint64< IMP >::setUint64Release	(	typename AtomicTypes::Uint64 *	atomicUint,
		Types::Uint64	value
	)

inlinestatic

Atomically set the value of the specified atomicUint to the specified value, providing the release memory ordering guarantee.

◆ subtractUint64Nv()

template<class IMP >

Types::Uint64 bsls::AtomicOperations_DefaultUint64< IMP >::subtractUint64Nv	(	typename AtomicTypes::Uint64 *	atomicUint,
		Types::Uint64	value
	)

inlinestatic

Atomically subtract from the specified atomicUint the specified value and return the resulting value, providing the sequential consistency memory ordering guarantee.

◆ subtractUint64NvAcqRel()

template<class IMP >

Types::Uint64 bsls::AtomicOperations_DefaultUint64< IMP >::subtractUint64NvAcqRel	(	typename AtomicTypes::Uint64 *	atomicUint,
		Types::Uint64	value
	)

inlinestatic

Atomically subtract from the specified atomicUint the specified value and return the resulting value, providing the acquire/release memory ordering guarantee.

◆ subtractUint64NvRelaxed()

template<class IMP >

Types::Uint64 bsls::AtomicOperations_DefaultUint64< IMP >::subtractUint64NvRelaxed	(	typename AtomicTypes::Uint64 *	atomicUint,
		Types::Uint64	value
	)

inlinestatic

Atomically subtract from the specified atomicUint the specified value and return the resulting value, without providing any memory ordering guarantees.

◆ swapUint64()

template<class IMP >

Types::Uint64 bsls::AtomicOperations_DefaultUint64< IMP >::swapUint64	(	typename AtomicTypes::Uint64 *	atomicUint,
		Types::Uint64	swapValue
	)

inlinestatic

Atomically set the value of the specified atomicUint to the specified swapValue and return its previous value, providing the sequential consistency memory ordering guarantee.

◆ swapUint64AcqRel()

template<class IMP >

Types::Uint64 bsls::AtomicOperations_DefaultUint64< IMP >::swapUint64AcqRel	(	typename AtomicTypes::Uint64 *	atomicUint,
		Types::Uint64	swapValue
	)

inlinestatic

Atomically set the value of the specified atomicUint to the specified swapValue and return its previous value, providing the acquire/release memory ordering guarantee.

◆ testAndSwapUint64()

template<class IMP >

Types::Uint64 bsls::AtomicOperations_DefaultUint64< IMP >::testAndSwapUint64	(	typename AtomicTypes::Uint64 *	atomicUint,
		Types::Uint64	compareValue,
		Types::Uint64	swapValue
	)

inlinestatic

Conditionally set the value of the specified atomicUint to the specified swapValue if and only if the value of atomicUint equals the value of the specified compareValue, and return the initial value of atomicUint, providing the sequential consistency memory ordering guarantee. The whole operation is performed atomically.

◆ testAndSwapUint64AcqRel()

template<class IMP >

Types::Uint64 bsls::AtomicOperations_DefaultUint64< IMP >::testAndSwapUint64AcqRel	(	typename AtomicTypes::Uint64 *	atomicUint,
		Types::Uint64	compareValue,
		Types::Uint64	swapValue
	)

inlinestatic

Conditionally set the value of the specified atomicUint to the specified swapValue if and only if the value of atomicUint equals the value of the specified compareValue, and return the initial value of atomicUint, providing the acquire/release memory ordering guarantee. The whole operation is performed atomically.

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

bsls_atomicoperations_default.h

Public Types

Static Public Member Functions

Detailed Description

Member Typedef Documentation

◆ AtomicTypes

Member Function Documentation

◆ addUint64()

◆ addUint64AcqRel()

◆ addUint64Nv()

◆ addUint64NvAcqRel()

◆ addUint64NvRelaxed()

◆ addUint64Relaxed()

◆ decrementUint64()

◆ decrementUint64AcqRel()

◆ decrementUint64Nv()

◆ decrementUint64NvAcqRel()

◆ getUint64()

◆ getUint64Acquire()

◆ getUint64Relaxed()

◆ incrementUint64()

◆ incrementUint64AcqRel()

◆ incrementUint64Nv()

◆ incrementUint64NvAcqRel()

◆ initUint64()

◆ setUint64()

◆ setUint64Relaxed()

◆ setUint64Release()

◆ subtractUint64Nv()

◆ subtractUint64NvAcqRel()

◆ subtractUint64NvRelaxed()

◆ swapUint64()

◆ swapUint64AcqRel()

◆ testAndSwapUint64()

◆ testAndSwapUint64AcqRel()