BloombergLP::bsls::AtomicPointer::testAndSwap

Conditionally swap this pointer if it equals compareValue.

Synopsis

Declared in <bsls_atomic.h>

TYPE*
testAndSwap(
    TYPE const* compareValue,
    TYPE* swapValue);

Description

Compare the value of this object to the specified compareValue. If they are equal, set the value of this atomic pointer to the specified swapValue, otherwise leave this value unchanged. Return the previous value of this atomic pointer, whether or not the swap occurred. Note that the entire test-and-swap operation is performed atomically.

Return Value

previous value of this object

Parameters

NameDescription
compareValueexpected current value of this object
swapValuepointer to store if the comparison succeeds