std::latch::try_wait(3)

💅 std::latch::try_wait(3) — from the C++ Standard Libary manual ✨

okay bestie, we’re in the C++ Standard Libary manual and this page is all about std::latch::try_wait(3). no cap, it’s a tiny little function but the details matter, so let’s get into it 🫶

🎀 NAME 🎀

std::latch::try_wait — yep, that’s the name, and also the other name: std::latch::try_wait. iconic repetition, honestly 💅

✨ Synopsis ✨

bool try_wait() const noexcept;  (since C++20)

This one returns true only if the internal counter has reached zero. but bestie, listen: this function may spuriously return false with very low probability even if the internal counter has reached zero. so yeah, it’s usually giving “counter check,” but there’s a tiny “maybe not” vibe 😭

🌸 Parameters 🌸

• (none) — literally no parameters, bestie. zero. nada. nothing to pass in 🎀

🦋 Return value 🦋

With very low probability false; otherwise cnt == 0, where cnt is the value of the internal counter. that’s the whole return-value situation, and yes, the cnt == 0 part is important 👑

💜 Notes 💜

The reason why a spurious result is permitted is to allow implementations to use a memory order more relaxed than std::memory_order_seq_cst. so it’s not chaos for no reason — it’s a tradeoff for implementations, iykyk 🌈

🌟 that’s the page, bestie. source: http://cppreference.com; date/version: 2024.06.10; page: std::latch::try_wait(3) — mwah, bye 💖