[#BloombergLP-bsls-AtomicOperations_DefaultUint64-00-testAndSwapUint64AcqRel]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bsls.adoc[bsls]::xref:BloombergLP/bsls/AtomicOperations_DefaultUint64-00.adoc[AtomicOperations&lowbar;DefaultUint64]::testAndSwapUint64AcqRel
:relfileprefix: ../../../
:mrdocs:

Conditionally swap `atomicUint` with acquire&sol;release ordering&period;

== Synopsis

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

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
xref:BloombergLP/bsls/Types/Uint64.adoc[Types::Uint64]
testAndSwapUint64AcqRel(
    AtomicTypes::Uint64* atomicUint,
    xref:BloombergLP/bsls/Types/Uint64.adoc[Types::Uint64] compareValue,
    xref:BloombergLP/bsls/Types/Uint64.adoc[Types::Uint64] swapValue);
----

== Description

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&sol;release memory ordering guarantee&period; The whole operation is performed atomically&period;

== Return Value

initial value of `atomicUint` before the operation

== Parameters

[cols="1,4"]
|===
| Name| Description
| *atomicUint*
| atomic unsigned 64&hyphen;bit integer to test and possibly update
| *compareValue*
| expected current value of `atomicUint`
| *swapValue*
| value to store if the comparison succeeds
|===


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