std::shared_mutex::unlock(3)

💖 std::shared_mutex::unlock(3) 💖

std::shared_mutex::unlock — okay so this is the unlock member function of std::shared_mutex, straight out of the C++ Standard Libary manual (section 3), and it's literally the "let go of the mutex" girlie. 💅

🦋 SYNOPSIS 🦋

void unlock();  (since C++17)

Unlocks the mutex. That's the whole vibe. 🔓

bestie, listen: the mutex must be locked by the current thread of execution, otherwise the behavior is undefined. not "maybe fine", not "we'll see" — undefined. 😭

This operation synchronizes-with (as defined in std::memory_order) any subsequent lock operation that obtains ownership of the same mutex. no cap, that's the memory-ordering tea. ✨

🎀 PARAMETERS 🎀

(none) — zero, nada, nothing, babe. 🎀

✨ RETURN VALUE ✨

(none) — it returns nothing and honestly? iconic. it doesn't need to give anything back. 👑

💀 EXCEPTIONS 💀

Throws nothing. not one exception. slay. 💀

🧚 NOTES 🧚

unlock() is usually not called directly: std::unique_lock and std::lock_guard are used to manage exclusive locking. so like, you can call it directly, but the cool kids let the RAII girlies handle it. 🧚

🌈 EXAMPLE 🌈

This section is incomplete. Reason: no example

literally no example yet 😭 the docs said "This section is incomplete" and the reason is "no example". we're waiting, bestie. 🙈

👑 SEE ALSO 👑

• lock — locks the mutex, blocks if the mutex is not available (public member function)
• try_lock — tries to lock the mutex, returns if the mutex is not available (public member function)
• C documentation for mtx_unlock

🍓 CATEGORY 🍓

• Todo no example

mwah 💋 this page is from http://cppreference.com, dated 2024.06.10, and it's the std::shared_mutex::unlock(3) page — catch you in the group chat! 🫶