std::atomic::notify_one(3)

🌟 std::atomic::notify_one(3) 🌟

okay so this is the std::atomic::notify_one(3) page from the C++ Standard Libary manual — yes, Libary is literally the manual name here, no cap. We're doing C++20 atomic notify-one vibes, and every single detail is staying. periodt. 💅

🌸 NAME 🌸

• std::atomic::notify_one - std::atomic::notify_one

✨ Synopsis ✨

okay so there are two overloads, both noexcept, both since C++20:

void notify_one() noexcept;          (1) (since C++20)
void notify_one() volatile noexcept; (2) (since C++20)

Performs atomic notifying operations. If there is a thread blocked in atomic waiting operation (i.e. wait()) on *this, then unblocks at least one such thread; otherwise does nothing. That's the whole move, bestie. ✨

💖 Return value 💖

• (none) — literally nothing comes back. The return value is (none), and that's iconic. 💖

🧠 Notes 🧠

This form of change-detection is often more efficient than simple polling or pure spinlocks. That's the note, and honestly slay for efficiency. 🔥

🥺 Example 🥺

Not me checking the example section and it's literally:

• This section is incomplete
• Reason: no example

😭 no example yet, bestie. We move. 🫶

👀 See also 👀

the page lists these exactly, including the standalone (C++20) line, so don't come for me:

• wait — blocks the thread until notified and the atomic value changes. (C++20) — (public member function)
• atomic_wait
• atomic_wait_explicit — blocks the thread until notified and the atomic value changes. (C++20) — (function template)
• (C++20)
• atomic_notify_one — notifies a thread blocked in atomic_wait. (C++20) — (function template)

🎀 Category 🎀

• * Todo no example

source/version + date sign-off: http://cppreference.com · 2024.06.10 · std::atomic::notify_one(3) — okay bye bestie, go be the notify_one you are and slay 💅💖