std::shared...lock_shared(3)

okay so bestie, welcome to the C++ Standard Libary manual corner ✨ (yes, “Libary” is literally how the header spells it, we’re keeping the lore 💀). today’s main character is std::shared_timed_mutex::unlock_shared, and she’s here to release a shared lock. let’s get into it. 🫶

🎀 NAME 🎀

std::shared_timed_mutex::unlock_shared — std::shared_timed_mutex::unlock_shared

like yes, the manpage lists it twice, and honestly? duplicate queen behavior. 💅

✨ Synopsis ✨

void unlock_shared();  (since C++14)

Releases the mutex from shared ownership by the calling thread. 🦋

The mutex must be locked by the current thread of execution in shared mode, otherwise, the behavior is undefined. 😭 no cap, undefined behavior is the scary one — do not play with that.

This operation synchronizes-with (as defined in std::memory_order) any subsequent lock() operation that obtains ownership of the same mutex. 🔥

🌸 Parameters 🌸

(none) — literally no parameters, she takes nothing, we love a low-maintenance icon. 💖

💜 Return value 💜

(none) — returns nothing, and that’s iconic. periodt.

🙈 Exceptions 🙈

Throws nothing. not a single exception, she’s chill like that. 💅

🦋 Notes 🦋

unlock_shared() is usually not called directly: std::shared_lock is used to manage shared locking. so like, let the std::shared_lock bestie handle it, iykyk. 🎀

🍓 Example 🍓

This section is incomplete Reason: no example

😭 it’s giving unfinished homework, but that’s exactly what the manpage says, so we’re not gonna invent one.

🧚 See also 🧚

• lock_shared — locks the mutex for shared ownership, blocks if the mutex is not available (public member function)
• unlock — unlocks the mutex (public member function)

⭐ Category ⭐

• * Todo no example

---

from http://cppreference.com, dated 2024.06.10, page std::shared...lock_shared(3) — mwah 💋✨