std::atomic_wait, std::atomic_wait_explicit

template< class T >
void atomic_wait( const std::atomic<T>* object,
                  typename std::atomic<T>::value_type old );

template< class T >
void atomic_wait( const volatile std::atomic<T>* object,
                  typename std::atomic<T>::value_type old );

template< class T >
void atomic_wait_explicit( const std::atomic<T>* object, 
                           typename std::atomic<T>::value_type old, 
                           std::memory_order order );

template< class T >
void atomic_wait_explicit( const volatile std::atomic<T>* object,
                           typename std::atomic<T>::value_type old, 
                           std::memory_order order );

Performs atomic waiting operations. Behaves as if it repeatedly performs the following steps:

• Compare the value representation of object->load(std::memory_order_seq_cst) or object->load(order) with that of old.
  • If those are bitwise equal, then blocks until *object is notified by std::atomic::notify_one() or std::atomic::notify_all(), or the thread is unblocked spuriously.
  • Otherwise, returns.

These functions are guaranteed to return only if value has changed, even if the underlying implementation unblocks spuriously.

Parameters

Return value

(none).

Notes

This form of change-detection is often more efficient than simple polling or pure spinlocks.

Due to the ABA problem, transient changes from old to another value and back to old might be missed, and not unblock.

The comparison is bitwise (similar to std::memcmp); no comparison operator is used. Padding bits that never participate in an object's value representation are ignored.

Example

See also