Namespaces
Variants
Views
Actions

Difference between revisions of "Template:cpp/atomic/atomic/wait"

From cppreference.com
(Splitted the volatile overloads.)
m
 
(One intermediate revision by one user not shown)
Line 25: Line 25:
 
{{par begin}}
 
{{par begin}}
 
{{par|old|the value to check the {{tt|{{{1|}}}}}'s object no longer contains}}
 
{{par|old|the value to check the {{tt|{{{1|}}}}}'s object no longer contains}}
−
{{par|order|the memory synchronization ordering for this operation}}
+
{{par|order|memory order constraints to enforce}}
 
{{par end}}  
 
{{par end}}  
  
Line 39: Line 39:
  
 
===Example===
 
===Example===
−
{{example|code=
+
{{example
 +
|code=
 
{{#ifeq:{{{1|atomic}}}|atomic|#include <atomic>
 
{{#ifeq:{{{1|atomic}}}|atomic|#include <atomic>
 
#include <chrono>
 
#include <chrono>
Line 58: Line 59:
 
     // time, then decrement the outstanding task count.
 
     // time, then decrement the outstanding task count.
 
     for (std::future<void>& task_future : task_futures)
 
     for (std::future<void>& task_future : task_futures)
−
    {
 
 
         task_future = std::async([&]
 
         task_future = std::async([&]
 
         {
 
         {
Line 75: Line 75:
 
             }
 
             }
 
         });
 
         });
−
    }
 
 
      
 
      
 
     all_tasks_completed.wait(false);
 
     all_tasks_completed.wait(false);

Latest revision as of 06:13, 19 November 2023

Template:cpp/atomic//title Template:cpp/atomic//navbar

void wait( T old, std::memory_order order =
                      std::memory_order::seq_cst ) const noexcept;
 (1) (since C++20)
void wait( T old, std::memory_order order =
                      std::memory_order::seq_cst ) const volatile noexcept;
 (2) (since C++20)

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

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

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

If order is one of std::memory_order::release and std::memory_order::acq_rel, the behavior is undefined.

Contents

[edit] Parameters

old - the value to check the 's object no longer contains
order - memory order constraints to enforce

[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

Run this code
#include <atomic>
#include <chrono>
#include <future>
#include <iostream>
#include <thread>
 
using namespace std::literals;
 
int main()
{
    std::atomic<bool> all_tasks_completed{false};
    std::atomic<unsigned> completion_count{};
    std::future<void> task_futures[16];
    std::atomic<unsigned> outstanding_task_count{16};
 
    // Spawn several tasks which take different amounts of
    // time, then decrement the outstanding task count.
    for (std::future<void>& task_future : task_futures)
        task_future = std::async([&]
        {
            // This sleep represents doing real work...
            std::this_thread::sleep_for(50ms);
 
            ++completion_count;
            --outstanding_task_count;
 
            // When the task count falls to zero, notify
            // the waiter (main thread in this case).
            if (outstanding_task_count.load() == 0)
            {
                all_tasks_completed = true;
                all_tasks_completed.notify_one();
            }
        });
 
    all_tasks_completed.wait(false);
 
    std::cout << "Tasks completed = " << completion_count.load() << '\n';
}

Output: 

Tasks completed = 16

[edit] See also

(C++20)
 notifies at least one thread waiting on the atomic object
(public member function of Template:cpp/atomic//title) [edit]
(C++20)
 notifies all threads blocked waiting on the atomic object
(public member function of Template:cpp/atomic//title) [edit]
(C++20)
 notifies a thread blocked in atomic_wait
(function template) [edit]
(C++20)
 notifies all threads blocked in atomic_wait
(function template) [edit]
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=Template:cpp/atomic/atomic/wait&oldid=163146"