[#BloombergLP-bsls-AtomicOperations_DefaultPointer64-061]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bsls.adoc[bsls]::AtomicOperations_DefaultPointer64
:relfileprefix: ../../
:mrdocs:

This class provides default implementations of non‐essential atomic operations for the 64‐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.

== Synopsis

Declared in `<bsls_atomicoperations_default.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class IMP>
struct AtomicOperations_DefaultPointer64;
----

== Description

Note that `AtomicOperations_DefaultPointer64` 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); `

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsls/AtomicOperations_DefaultPointer64-061/AtomicTypes.adoc[`AtomicTypes`] 
| This `typedef` is an alias to `Atomic_TypeTraits<IMP>`.
|===


== Static Member Functions

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsls/AtomicOperations_DefaultPointer64-061/getPtr.adoc[`getPtr`] 
| Atomically retrieve the value of the specified `atomicPtr`, providing the sequential consistency memory ordering guarantee.
| xref:BloombergLP/bsls/AtomicOperations_DefaultPointer64-061/getPtrAcquire.adoc[`getPtrAcquire`] 
| Atomically retrieve the value of the specified `atomicPtr`, providing the acquire memory ordering guarantee.
| xref:BloombergLP/bsls/AtomicOperations_DefaultPointer64-061/getPtrRelaxed.adoc[`getPtrRelaxed`] 
| Atomically retrieve the value of the specified `atomicPtr`, without providing any memory ordering guarantees.
| xref:BloombergLP/bsls/AtomicOperations_DefaultPointer64-061/initPointer.adoc[`initPointer`] 
| Initialize the specified `atomicPtr` and set its value to the optionally specified `initialValue`.
| xref:BloombergLP/bsls/AtomicOperations_DefaultPointer64-061/setPtr.adoc[`setPtr`] 
| Atomically set the value of the specified `atomicPtr` to the specified `value`, providing the sequential consistency memory ordering guarantee.
| xref:BloombergLP/bsls/AtomicOperations_DefaultPointer64-061/setPtrRelaxed.adoc[`setPtrRelaxed`] 
| Atomically set the value of the specified `atomicPtr` to the specified `value`, without providing any memory ordering guarantees.
| xref:BloombergLP/bsls/AtomicOperations_DefaultPointer64-061/setPtrRelease.adoc[`setPtrRelease`] 
| Atomically set the value of the specified `atomicPtr` to the specified `value`, providing the release memory ordering guarantee.
| xref:BloombergLP/bsls/AtomicOperations_DefaultPointer64-061/swapPtr.adoc[`swapPtr`] 
| Atomically set the value of the specified `atomicPtr` to the specified `swapValue`, and return its previous value, providing the sequential consistency memory ordering guarantee.
| xref:BloombergLP/bsls/AtomicOperations_DefaultPointer64-061/swapPtrAcqRel.adoc[`swapPtrAcqRel`] 
| Atomically set the value of the specified `atomicPtr` to the specified `swapValue`, and return its previous value, providing the acquire/release memory ordering guarantee.
| xref:BloombergLP/bsls/AtomicOperations_DefaultPointer64-061/testAndSwapPtr.adoc[`testAndSwapPtr`] 
| 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.
| xref:BloombergLP/bsls/AtomicOperations_DefaultPointer64-061/testAndSwapPtrAcqRel.adoc[`testAndSwapPtrAcqRel`] 
| 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.
|===


== Derived Classes

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsls/AtomicOperations_Default64-0b.adoc[`AtomicOperations_Default64`] 
| This class provides default implementations of non‐essential atomic operations for the 32‐bit integer, 64‐bit integer, the 32‐bit unsigned integer, 64‐bit unsigned integer and 64‐bit pointer type for a generic 64‐bit platform.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#