std::timed_mutex::unlock(3)

💅 std::timed_mutex::unlock 💅

okay so this page is from the C++ Standard Libary manual, section 3, and it's literally the std::timed_mutex::unlock page — bestie, we're unlocking mutexes and keeping the vibes immaculate 💖

✨ NAME ✨

std::timed_mutex::unlock — yes, that's the name, it's giving "the unlock function for std::timed_mutex" and we're obsessed 🎀

📜 Synopsis

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

Unlocks the mutex. simple as that, no cap ✨

The mutex must be locked by the current thread of execution, otherwise, the behavior is undefined. like, do not freestyle this one, bestie 😭 that's the undefined-behavior zone 💀

This operation synchronizes-with (as defined in std::memory_order) any subsequent lock operation that obtains ownership of the same mutex. yes queen, memory-ordering lore 🧚

🧾 Parameters

(none) — zero parameters, not a single one, we love a low-maintenance icon 💅

🎁 Return value

(none) — it returns nothing, because the unlock is the moment, periodt 💖

🚨 Exceptions

Throws nothing. literally nothing. not even a little throw. slay 🫶

📝 Notes

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

🧪 Example

This section is incomplete Reason: no example

not me finding an incomplete Example section 💀 bestie we have no example, it's giving "todo" but make it iconic 😭

👀 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)
• try_lock_for — tries to lock the mutex, returns if the mutex has been unavailable for the specified timeout duration (public member function)
• try_lock_until — tries to lock the mutex, returns if the mutex has been unavailable until specified time point has been reached (public member function)
• C documentation for mtx_unlock — the C side of the story, iykyk

🗂️ Category

• Todo no example

---

big kiss to http://cppreference.com — source/version and date 2024.06.10, plus the std::timed_mutex::unlock(3) footer energy — byeeeeee 💖🦋