std::recurs...tex::unlock(3)

🌸 NAME 🌸

okay so bestie, this is the std::recursive_mutex::unlock page from the C++ Standard Libary manual. It's the unlock member function for std::recursive_mutex, and she's literally here to handle your ownership level 💅.

✨ Synopsis ✨

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

so what does she do? She unlocks the mutex if its level of ownership is 1 — meaning there was exactly one more call to lock() than there were calls to unlock() made by this thread. Otherwise, she reduces the level of ownership by 1 ✨.

🚨 The mutex must be locked by the current thread of execution, otherwise the behavior is undefined. no cap, that part is serious 💀

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

🎀 Parameters 🎀

(none) — she takes nothing, not even a little snack 🍓.

🫶 Return value 🫶

(none) — returns nothing, she's too iconic for that.

💜 Exceptions 💜

Throws nothing. literally nothing. zero. 🕳️

🌈 Notes 🌈

unlock() is usually not called directly: std::unique_lock and std::lock_guard are used to manage exclusive locking. so like, let the guard girlies handle it 💅.

🦋 Example 🦋

This section is incomplete Reason: no example

👑 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 — the C side of the story, linked from here.

Category: * Todo no example

mwah 💖 source: http://cppreference.com · version/date: 2024.06.10 · footer page name: std::recurs...tex::unlock(3). bye bestie, go unlock responsibly 🎀✨