std::counti...re::release(3)

✨ NAME ✨

Okay so bestie, this is std::counting_semaphore::release(3) — header vibe: std::counti...re::release(3) — from the C++ Standard Libary manual (yes, that spelling is literally in the source, not me 💀).

The name is std::counting_semaphore::release, and the NAME line says std::counting_semaphore::release - std::counting_semaphore::release, because repetition is iconic 💅.

🌸 Synopsis 🌸

void release( std::ptrdiff_t update = 1 );

Since: C++20 ✨

This atomically increments the internal counter by the value of update. Any thread(s) waiting for the counter to be greater than 0 — like because they’re blocked in acquire — will subsequently be unblocked. Slay, wake-up call delivered 🫶.

🎀 Preconditions 🎀

Both of these need to be true, no cap:

• update >= 0
• update <= max() - counter

…where counter is the value of the internal counter. Both conditions are part of the contract, so don’t skip the vibe check 😭.

💖 Parameters 💖

• update — the amount to increment the internal counter by.

🦋 Exceptions 🦋

May throw std::system_error. Not a cute surprise, but there it is 🙈.

🌈 See also 🌈

• acquire — decrements the internal counter or blocks until it can (public member function).
• try_acquire — tries to decrement the internal counter without blocking (public member function).
• try_acquire_for — tries to decrement the internal counter, blocking for up to a duration time (public member function).
• try_acquire_until — tries to decrement the internal counter, blocking until a point in time (public member function).

mwah 💋 — source/version: http://cppreference.com, dated 2024.06.10. That’s the whole page, bestie — go flex those semaphores responsibly 🌟