std::atomic_load, std::atomic_load_explicit

 

C++

Language

Standard library headers

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

 

Atomic operations library

Types

atomic (C++11)

atomic_is_lock_free (C++11)

Functions

atomic_store atomic_store_explicit (C++11) (C++11)

atomic_load atomic_load_explicit (C++11) (C++11)

atomic_exchange atomic_exchange_explicit (C++11) (C++11)

atomic_compare_exchange_weak atomic_compare_exchange_weak_explicit atomic_compare_exchange_strong atomic_compare_exchange_strong_explicit (C++11) (C++11) (C++11) (C++11)

atomic_fetch_add atomic_fetch_add_explicit (C++11) (C++11)

atomic_fetch_sub atomic_fetch_sub_explicit (C++11) (C++11)

atomic_fetch_and atomic_fetch_and_explicit (C++11) (C++11)

atomic_fetch_or atomic_fetch_or_explicit (C++11) (C++11)

atomic_fetch_xor atomic_fetch_xor_explicit (C++11) (C++11)

Atomic flags

atomic_flag (C++11)

atomic_flag_test_and_set atomic_flag_test_and_set_explicit (C++11) (C++11)

atomic_flag_clear atomic_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>
template< class T > T atomic_load( std::atomic<T>* obj );	(1)	(since C++11)
template< class T > T atomic_load( volatile std::atomic<T>* obj );	(1)	(since C++11)
template< class T > T atomic_load_explicit( std::atomic<T>* obj,                         std::memory_order order );	(2)	(since C++11)
template< class T > T atomic_load_explicit( volatile std::atomic<T>* obj,                         std::memory_order order );	(2)	(since C++11)

1) Atomically obtains the value pointed to by obj as if by obj->load()

2) Atomically obtains the value pointed to by obj as if by obj->load(order)

Parameters

obj	-	pointer to the atomic object to modify
order	-	the memory sycnhronization ordering for this operation: only std::memory_order_relaxed, std::memory_order_consume, std::memory_order_acquire and std::memory_order_seq_cst are permitted.

Return value

The value that is held by the atomic object pointed to by obj

Exceptions

noexcept specification:  

noexcept

  (since C++11)

See also

load (C++11)	atomically obtains the value of the atomic object (public member function of std::atomic)
atomic_store atomic_store_explicit (C++11) (C++11)	atomically replaces the value of the atomic object with a non-atomic argument (function template)
memory_order (C++11)	defines memory ordering constraints for the given atomic operation (typedef)
std::atomic_load(std::shared_ptr) std::atomic_load_explicit(std::shared_ptr)	specializes atomic operations for std::shared_ptr (function template)
C documentation for atomic_load, atomic_load_explicit