W3cubDocs

/C++

std::atomic_load, std::atomic_load_explicit

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

See also

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

© cppreference.com
Licensed under the Creative Commons Attribution-ShareAlike Unported License v3.0.
http://en.cppreference.com/w/cpp/atomic/atomic_load