std::atomic_notify_one

From cppreference.com
< cpp‎ | atomic
 
 
Concurrency support library
Threads
(C++11)
(C++20)
(C++20)
this_thread namespace
(C++11)
(C++11)
(C++11)
Atomic types
(C++11)
(C++20)
Initialization of atomic types
(C++11)(deprecated in C++20)
(C++11)(deprecated in C++20)
Free functions for atomic operations
atomic_notify_one
(C++20)
Free functions for atomic flags
Memory ordering
Mutual exclusion
(C++11)
Generic lock management
(C++11)
(C++11)
(C++11)
(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)
 
Defined in header <atomic>
(since C++20)
template< class T >
void atomic_notify_one( std::atomic<T>* object );
template< class T >
void atomic_notify_one( volatile std::atomic<T>* object );

Performs atomic notifying operations.

If there is a thread blocked in atomic waiting operation (i.e. std::atomic_wait(), std::atomic_wait_explicit(), or std::atomic::wait()) on *object, then unblocks at least one such thread; otherwise does nothing.

Equivalent to object->notify_one().

Parameters

object - pointer to the atomic object to notify

Return value

(none)

Notes

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

Example

See also

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