BDE 4.14.0 Production release
Loading...
Searching...
No Matches
Public Types | Static Public Member Functions | List of all members
bsls::AtomicOperations_DefaultPointer32< IMP > Struct Template Reference

#include <bsls_atomicoperations_default.h>

Inheritance diagram for bsls::AtomicOperations_DefaultPointer32< IMP >:
bsls::AtomicOperations_Default32< IMP >

Public Types

typedef Atomic_TypeTraits< IMP > AtomicTypes
 

Static Public Member Functions

static void * getPtr (typename AtomicTypes::Pointer const *atomicPtr)
 
static void * getPtrAcquire (typename AtomicTypes::Pointer const *atomicPtr)
 
static void * getPtrRelaxed (typename AtomicTypes::Pointer const *atomicPtr)
 
static void initPointer (typename AtomicTypes::Pointer *atomicPtr, void *initialValue=0)
 
static void setPtr (typename AtomicTypes::Pointer *atomicPtr, void *value)
 
static void setPtrRelaxed (typename AtomicTypes::Pointer *atomicPtr, void *value)
 
static void setPtrRelease (typename AtomicTypes::Pointer *atomicPtr, void *value)
 
static void * swapPtr (typename AtomicTypes::Pointer *atomicPtr, void *swapValue)
 
static void * swapPtrAcqRel (typename AtomicTypes::Pointer *atomicPtr, void *swapValue)
 
static void * testAndSwapPtr (typename AtomicTypes::Pointer *atomicPtr, void *compareValue, void *swapValue)
 
static void * testAndSwapPtrAcqRel (typename AtomicTypes::Pointer *atomicPtr, void *compareValue, void *swapValue)
 

Detailed Description

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

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

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

static int getInt(typename AtomicTypes::Int const *atomicInt);
static int getIntRelaxed(typename AtomicTypes::Int const *atomicInt);
static int getIntAcquire(typename AtomicTypes::Int const *atomicInt);
static void setInt(typename AtomicTypes::Int *atomicInt, int value);
static void setIntRelaxed(typename AtomicTypes::Int *atomicInt,
int value);
static void setIntRelease(typename AtomicTypes::Int *atomicInt,
int value);
static int swapInt(typename AtomicTypes::Int *atomicInt,
int swapValue);
static int swapIntAcqRel(typename AtomicTypes::Int *atomicInt,
int swapValue);
static int testAndSwapInt(typename AtomicTypes::Int *atomicInt,
int compareValue,
int swapValue);
static int testAndSwapIntAcqRel(typename AtomicTypes::Int *atomicInt,
int compareValue,
int swapValue);

Member Typedef Documentation

◆ AtomicTypes

template<class IMP >
typedef Atomic_TypeTraits<IMP> bsls::AtomicOperations_DefaultPointer32< IMP >::AtomicTypes

Member Function Documentation

◆ getPtr()

template<class IMP >
void * bsls::AtomicOperations_DefaultPointer32< IMP >::getPtr ( typename AtomicTypes::Pointer const *  atomicPtr)
inlinestatic

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

◆ getPtrAcquire()

template<class IMP >
void * bsls::AtomicOperations_DefaultPointer32< IMP >::getPtrAcquire ( typename AtomicTypes::Pointer const *  atomicPtr)
inlinestatic

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

◆ getPtrRelaxed()

template<class IMP >
void * bsls::AtomicOperations_DefaultPointer32< IMP >::getPtrRelaxed ( typename AtomicTypes::Pointer const *  atomicPtr)
inlinestatic

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

◆ initPointer()

template<class IMP >
void bsls::AtomicOperations_DefaultPointer32< IMP >::initPointer ( typename AtomicTypes::Pointer *  atomicPtr,
void *  initialValue = 0 
)
inlinestatic

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

◆ setPtr()

template<class IMP >
void bsls::AtomicOperations_DefaultPointer32< IMP >::setPtr ( typename AtomicTypes::Pointer *  atomicPtr,
void *  value 
)
inlinestatic

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

◆ setPtrRelaxed()

template<class IMP >
void bsls::AtomicOperations_DefaultPointer32< IMP >::setPtrRelaxed ( typename AtomicTypes::Pointer *  atomicPtr,
void *  value 
)
inlinestatic

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

◆ setPtrRelease()

template<class IMP >
void bsls::AtomicOperations_DefaultPointer32< IMP >::setPtrRelease ( typename AtomicTypes::Pointer *  atomicPtr,
void *  value 
)
inlinestatic

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

◆ swapPtr()

template<class IMP >
void * bsls::AtomicOperations_DefaultPointer32< IMP >::swapPtr ( typename AtomicTypes::Pointer *  atomicPtr,
void *  swapValue 
)
inlinestatic

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

◆ swapPtrAcqRel()

template<class IMP >
void * bsls::AtomicOperations_DefaultPointer32< IMP >::swapPtrAcqRel ( typename AtomicTypes::Pointer *  atomicPtr,
void *  swapValue 
)
inlinestatic

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

◆ testAndSwapPtr()

template<class IMP >
void * bsls::AtomicOperations_DefaultPointer32< IMP >::testAndSwapPtr ( typename AtomicTypes::Pointer *  atomicPtr,
void *  compareValue,
void *  swapValue 
)
inlinestatic

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

◆ testAndSwapPtrAcqRel()

template<class IMP >
void * bsls::AtomicOperations_DefaultPointer32< IMP >::testAndSwapPtrAcqRel ( typename AtomicTypes::Pointer *  atomicPtr,
void *  compareValue,
void *  swapValue 
)
inlinestatic

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

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