std::atomic_store, std::atomic_store_explicit

 

C++

Language

Standard Library Headers

Freestanding and hosted implementations

Named requirements

Language support library

Concepts library (C++20)

Diagnostics library

Utilities library

Strings library

Containers library

Iterators library

Ranges library (C++20)

Algorithms library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

Filesystem library (C++17)

Technical Specifications

 

Atomic operations library

Types

atomic (C++11)

atomic_ref (C++20)

Functions

atomic_storeatomic_store_explicit (C++11)(C++11)

atomic_loadatomic_load_explicit (C++11)(C++11)

atomic_exchangeatomic_exchange_explicit (C++11)(C++11)

atomic_compare_exchange_weakatomic_compare_exchange_weak_explicitatomic_compare_exchange_strongatomic_compare_exchange_strong_explicit (C++11)(C++11)(C++11)(C++11)

atomic_fetch_addatomic_fetch_add_explicit (C++11)(C++11)

atomic_fetch_subatomic_fetch_sub_explicit (C++11)(C++11)

atomic_fetch_andatomic_fetch_and_explicit (C++11)(C++11)

atomic_fetch_oratomic_fetch_or_explicit (C++11)(C++11)

atomic_fetch_xoratomic_fetch_xor_explicit (C++11)(C++11)

atomic_is_lock_free (C++11)

Atomic flags

atomic_flag (C++11)

atomic_flag_test_and_setatomic_flag_test_and_set_explicit (C++11)(C++11)

atomic_flag_clearatomic_flag_clear_explicit (C++11)(C++11)

Initialization

atomic_init (C++11)

ATOMIC_VAR_INIT (C++11)

ATOMIC_FLAG_INIT (C++11)

Memory ordering

memory_order (C++11)

kill_dependency (C++11)

atomic_thread_fence (C++11)

atomic_signal_fence (C++11)

 

Defined in header <atomic>
	(1)	(since C++11)
template< class T > void atomic_store( std::atomic<T>* obj,                    typename std::atomic<T>::value_type desr ) noexcept;
template< class T > void atomic_store( volatile std::atomic<T>* obj,                    typename std::atomic<T>::value_type desr ) noexcept;
			(2)	(since C++11)
template< class T > void atomic_store_explicit( std::atomic<T>* obj,                             typename std::atomic<T>::value_type desr,                             std::memory_order order) noexcept;
template< class T > void atomic_store_explicit( volatile std::atomic<T>* obj,                             typename std::atomic<T>::value_type desr,                             std::memory_order order) noexcept;

1) Atomically replaces the value pointed to by obj with the value of desr as if by obj->store(desr)

2) Atomically replaces the value pointed to by obj with the value of desr as if by obj->store(desr, order)

Parameters

obj	-	pointer to the atomic object to modify
desr	-	the value to store in the atomic object
order	-	the memory synchronization ordering for this operation: only std::memory_order_relaxed, std::memory_order_release and std::memory_order_seq_cst are permitted.

Return value

none.

Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR	Applied to	Behavior as published	Correct behavior
P0558R1	C++11	exact type match required because T is deduced from multiple arguments	T is deduced from the atomic argument only

See also

store	atomically replaces the value of the atomic object with a non-atomic argument (public member function of std::atomic)
atomic_loadatomic_load_explicit (C++11)(C++11)	atomically obtains the value stored in an atomic object (function template)
memory_order (C++11)	defines memory ordering constraints for the given atomic operation (enum)
std::atomic_store(std::shared_ptr) std::atomic_store_explicit(std::shared_ptr)	specializes atomic operations for std::shared_ptr (function template)