std::atomic...::notify_one(3)

okay bestie, welcome to the std::atomic...::notify_one(3) page from the C++ Standard Libary manual set 💖 (yes, that spelling is the manual name — we're keeping it iconic and untouched). This one is all about std::atomic_ref::notify_one, and it's lowkey the “wake up at least one waiting bestie” button of the atomic world ✨

🎀 NAME 🎀

• std::atomic_ref::notify_one — std::atomic_ref::notify_one

🦋 Synopsis 🦋

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

Both overloads are since C++20 👑. Overload (1) is const noexcept; overload (2) is const volatile noexcept — matching the code block exactly, no edits, periodt 💅.

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.

💜 Return value 💜

• (none) — no return value, bestie. It does the notifying thing and vibes 🫶

✨ Notes ✨

This form of change-detection is often more efficient than simple polling or pure spinlocks. So if you were about to spin, the note is gently saying this change-detection form is often more efficient — that's the whole claim, no extra lore 🦋

🌸 Example 🌸

This section is incomplete. Reason: no example.

🦋 See also 🦋

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

🏷️ Category 🏷️

• * Todo no example

That's the page, bestie 💅 It came from http://cppreference.com with the 2024.06.10 date/version stamp, and the footer tag was std::atomic...::notify_one(3) — mwah, go notify at least one waiting thread and slay 🎀🔥