Namespaces
Variants
Views
Actions

std::atomic_wait, std::atomic_wait_explicit

From cppreference.com
< cpp‎ | atomic
 
 
Concurrency support library
Threads
(C++11)
(C++20)
(C++20)
this_thread namespace
(C++11)
(C++11)
(C++11)
Mutual exclusion
(C++11)
(C++11)  
Generic lock management
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
Condition variables
(C++11)
Semaphores
Latches and Barriers
(C++20)
(C++20)
Futures
(C++11)
(C++11)
(C++11)
(C++11)
Safe Reclamation
(C++26)
(C++26)
Hazard Pointers





Atomic types
(C++11)
(C++20)
Initialization of atomic types
(C++11)(deprecated in C++20)
(C++11)(deprecated in C++20)
Memory ordering
Free functions for atomic operations
atomic_waitatomic_wait_explicit
(C++20)(C++20)
Free functions for atomic flags
 
template< class T >

void atomic_wait( const std::atomic<T>* object,

                  typename std::atomic<T>::value_type old );
(1) (since C++20)
template< class T >

void atomic_wait( const volatile std::atomic<T>* object,

                  typename std::atomic<T>::value_type old );
(2) (since C++20)
template< class T >

void atomic_wait_explicit( const std::atomic<T>* object,
                           typename std::atomic<T>::value_type old,

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

void atomic_wait_explicit( const volatile std::atomic<T>* object,
                           typename std::atomic<T>::value_type old,

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

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

  • Compare the value representation of object->load() (for overloads (1,2)) or object->load(order) (for overloads (3,4)) 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.

1,2) Equivalent to object->wait(old).
3,4) Equivalent to object->wait(old, order).
If order is one of std::memory_order::release and std::memory_order::acq_rel, the behavior is undefined.

Contents

[edit] Parameters

object - pointer to the atomic object to check and wait on
old - the value to check the atomic object no longer contains
order - the memory synchronization ordering

[edit] Return value

(none)

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

[edit] Example

[edit] See also

(C++20)
blocks the thread until notified and the atomic value changes
(public member function of std::atomic<T>) [edit]
notifies at least one thread waiting on the atomic object
(public member function of std::atomic<T>) [edit]
notifies all threads blocked waiting on the atomic object
(public member function of std::atomic<T>) [edit]
notifies a thread blocked in atomic_wait
(function template) [edit]
notifies all threads blocked in atomic_wait
(function template) [edit]