Namespaces
Variants
Views
Actions

std::atomic_load, std::atomic_load_explicit

From cppreference.com
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 );
(2) (since C++11)
template< class T >

T atomic_load_explicit( std::atomic<T>* obj,

                        std::memory_order order );
(3) (since C++11)
template< class T >

T atomic_load_explicit( volatile std::atomic<T>* obj,

                        std::memory_order order );
(4) (since C++11)

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

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

Contents

[edit] 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.

[edit] Return value

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

[edit] Exceptions

noexcept specification:  
noexcept
  (since C++11)

[edit] See also

(C++11)
atomically obtains the value of the atomic object
(public member function of std::atomic) [edit]
atomically replaces the value of the atomic object with a non-atomic argument
(function template) [edit]
defines memory ordering constraints for the given atomic operation
(typedef) [edit]
specializes atomic operations for std::shared_ptr
(function template)