std::condition_variable(3)

💖 std::condition_variable — the Library Functions Manual era 💖

okay so bestie, welcome to the libstdc++ manual page for std::condition_variable(3), which is filed under Library Functions Manual and lives in the std::condition_variable section of your heart. yes we're doing this. grab a boba. 🧋

---

🌸 NAME 🌸

std::condition_variable — condition_variable 💅

like. that's the whole name. it's giving minimalism. it's giving "the class name is the description." iconic behaviour honestly.

---

✨ SYNOPSIS ✨

#include <condition_variable>

that's it, that's the include. no extra headers, no drama, no #defines you have to fight with. just vibes and a header file. 🦋

🌈 Public Types 🌈

one (1) public type, and she's a legend:

• typedef __gthread_cond_t * native_handle_type — the raw, underlying, native handle type. the actual guts of the thing, as a pointer to __gthread_cond_t. iykyk.

🎀 Public Member Functions 🎀

okay here comes the lineup, no skips, every single one of them, periodt:

• condition_variable(const condition_variable &) = delete — nope, can't copy-construct her. she said "no duplicates." 💀
• native_handle_type native_handle() — hands you the native handle. the real one. the native_handle_type one.
• void notify_all() noexcept — wakes up everybody waiting. and she does it noexcept, because she does not have time to throw. 🔥
• void notify_one() noexcept — wakes up exactly one (1) lucky waiter. also noexcept. also unbothered.
• condition_variable & operator=(const condition_variable &) = delete — and no copy-assignment either, bestie. she is not clonable. = delete said what it said. 🙈
• void wait(unique_lock<mutex> &__lock) — takes your unique_lock<mutex> by reference and just… waits. classic.
• template<typename _Predicate> void wait(unique_lock<mutex> &__lock, _Predicate __p) — the templated glow-up: same lock, plus a _Predicate __p so you're not sitting there re-checking by hand.
• template<typename _Rep, typename _Period> cv_status wait_for(unique_lock<mutex> &__lock, const chrono::duration<_Rep, _Period> &__rtime) — waiting, but with a deadline-shaped chrono::duration<_Rep, _Period> called __rtime. returns cv_status, because sometimes you just gotta know.
• template<typename _Rep, typename _Period, typename _Predicate> bool wait_for(unique_lock<mutex> &__lock, const chrono::duration<_Rep, _Period> &__rtime, _Predicate __p) — the wait_for with a _Predicate __p on top, and this one returns bool. yes the return type changed, no we don't need to talk about it.
• template<typename _Clock, typename _Duration> cv_status wait_until(unique_lock<mutex> &__lock, const chrono::time_point<_Clock, _Duration> &__atime) — waiting until an actual chrono::time_point<_Clock, _Duration> named __atime. returns cv_status.
• template<typename _Clock, typename _Duration, typename _Predicate> bool wait_until(unique_lock<mutex> &__lock, const chrono::time_point<_Clock, _Duration> &__atime, _Predicate __p) — same time_point<_Clock, _Duration> energy, plus _Predicate __p, and it returns bool.
• template<typename _Duration> cv_status wait_until(unique_lock<mutex> &__lock, const chrono::time_point<steady_clock, _Duration> &__atime) — special friend for steady_clock. cv_status return, _Duration template, __atime by reference. 💜
• template<typename _Duration> cv_status wait_until(unique_lock<mutex> &__lock, const chrono::time_point<system_clock, _Duration> &__atime) — and the matching special friend for system_clock. same shape, different clock, she's got range. ⭐

lowkey the way there are two wait_fors and four wait_untils and they return cv_status or bool depending on whether you brought a predicate… that's the whole personality. and we love her for it. 🫶

---

🦋 Detailed Description 🦋

condition_variable

yes. that's the detailed description. the detailed-est. we've been blessed with the maximum amount of detail. 😭 Doxygen really said "she speaks for herself."

---

👑 Author 👑

Generated automatically by Doxygen for libstdc++ from the source code.

which is to say: no human author is credited here, she was generated by Doxygen, from the source code, for libstdc++. the source code is her mother. 🧚

---

💜 SEE ALSO 💜

okay so this page doesn't actually have a SEE ALSO section, but honestly? the wait, notify_one and notify_all members are the see-also. look at them. look at her. she's the whole ecosystem.

---

and that's the page, bestie!! that was std::condition_variable(3) from the Library Functions Manual, brought to you by libstdc++. mwah. go notify_all on your friends. 💖✨🎀🦋🌸💅🫶🔥👑🌈⭐💀🙈🍓🧚💜