atomic_exchange, atomic_exchange_explicit

< c‎ | atomic
Revision as of 23:32, 2 November 2012 by P12bot (Talk | contribs)

Template:ddcl list begin <tr class="t-dsc-header">

Defined in header <stdatomic.h>

<td></td> <td></td> </tr> <tr class="t-dcl ">

<td >
C atomic_exchange( volatile A* obj, C desired );

<td > (1) </td> <td > (since C11) </td> </tr> <tr class="t-dcl ">

<td >
C atomic_exchange_explicit( volatile A* obj, C desired, memory_order order );

<td > (2) </td> <td > (since C11) </td> </tr> Template:ddcl list end

Atomically replaces the value pointed by obj with desired and returns the value obj held previously. The operation is read-modify-write operation. The first version orders memory accesses according to memory_order_seq_cst, the second version orders memory accesses according to order.

This is a generic function defined for all atomic object types. A is the type of an atomic object, C is the non-atomic type corresponding to A.


obj - pointer to the atomic object to modify
desired - the value to replace the atomic object with
order - the memory synchronization ordering for this operation: all values are permitted

Return value

The value held previously be the atomic object pointed to by obj.

See also

Template:c/atomic/dcl list atomic compare exchange
C++ documentation for atomic_exchange, atomic_exchange_explicit