[#BloombergLP-bsls-AtomicOperations_DefaultPointer64-061]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bsls.adoc[bsls]::AtomicOperations&lowbar;DefaultPointer64
:relfileprefix: ../../
:mrdocs:

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

== Synopsis

Declared in `&lt;bsls&lowbar;atomicoperations&lowbar;default&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template&lt;class IMP&gt;
struct AtomicOperations&lowbar;DefaultPointer64;
----

== Description

Note that `AtomicOperations&lowbar;DefaultPointer64` is implemented in terms of the following atomic operations on the Int64 type that must be provided by the `IMP` template parameter&period; &grave; static Types&colon;&colon;Int64 getInt64( typename AtomicTypes&colon;&colon;Int64 const &ast;atomicInt)&semi; static Types&colon;&colon;Int64 getInt64Relaxed( typename AtomicTypes&colon;&colon;Int64 const &ast;atomicInt)&semi; static Types&colon;&colon;Int64 getInt64Acquire( typename AtomicTypes&colon;&colon;Int64 const &ast;atomicInt)&semi; static void setInt64(typename AtomicTypes&colon;&colon;Int64 &ast;atomicInt, Types&colon;&colon;Int64 value)&semi; static void setInt64Relaxed(typename AtomicTypes&colon;&colon;Int64 &ast;atomicInt, Types&colon;&colon;Int64 value)&semi; static void setInt64Release(typename AtomicTypes&colon;&colon;Int64 &ast;atomicInt, Types&colon;&colon;Int64 value)&semi; static Types&colon;&colon;Int64 swapInt64(typename AtomicTypes&colon;&colon;Int64 &ast;atomicInt, Types&colon;&colon;Int64 swapValue)&semi; static Types&colon;&colon;Int64 swapInt64AcqRel( typename AtomicTypes&colon;&colon;Int64 &ast;atomicInt, Types&colon;&colon;Int64 swapValue)&semi; static Types&colon;&colon;Int64 testAndSwapInt64( typename AtomicTypes&colon;&colon;Int64 &ast;atomicInt, Types&colon;&colon;Int64 compareValue, Types&colon;&colon;Int64 swapValue)&semi; static Types&colon;&colon;Int64 testAndSwapInt64AcqRel( typename AtomicTypes&colon;&colon;Int64 &ast;atomicInt, Types&colon;&colon;Int64 compareValue, Types&colon;&colon;Int64 swapValue)&semi; &grave;

== Type Aliases

[cols="1,4"]
|===
| Name| Description
| xref:BloombergLP/bsls/AtomicOperations_DefaultPointer64-061/AtomicTypes.adoc[`AtomicTypes`] 
| This `typedef` is an alias to `Atomic&lowbar;TypeTraits&lt;IMP&gt;`&period;
|===


== 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&period;
| xref:BloombergLP/bsls/AtomicOperations_DefaultPointer64-061/getPtrAcquire.adoc[`getPtrAcquire`] 
| Atomically retrieve the value of the specified `atomicPtr`, providing the acquire memory ordering guarantee&period;
| xref:BloombergLP/bsls/AtomicOperations_DefaultPointer64-061/getPtrRelaxed.adoc[`getPtrRelaxed`] 
| Atomically retrieve the value of the specified `atomicPtr`, without providing any memory ordering guarantees&period;
| xref:BloombergLP/bsls/AtomicOperations_DefaultPointer64-061/initPointer.adoc[`initPointer`] 
| Initialize the specified `atomicPtr` and set its value to the optionally specified `initialValue`&period;
| 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&period;
| 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&period;
| 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&period;
| 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&period;
| 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&sol;release memory ordering guarantee&period;
| 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&period; The whole operation is performed atomically&period;
| 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&sol;release memory ordering guarantee&period; The whole operation is performed atomically&period;
|===


== Derived Classes

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


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