std::shared...lock_shared(3)

💅 std::shared...lock_shared(3) — C++ Standard Libary bestie page 💅

okay bestie, welcome to the manual page for std::shared...lock_shared(3) from the C++ Standard Libary (that’s the manual name, don’t come for me 😭). Hydrate, stretch, and let’s get into this shared-lock situation. 🫶✨

🌸 NAME 🌸

std::shared_timed_mutex::try_lock_shared - std::shared_timed_mutex::try_lock_shared

📚 Synopsis 📚

bool try_lock_shared();  (since C++14)

okay so this function tries to lock the mutex in shared mode. It returns immediately — no blocking, no waiting, no “gimme a sec.” If the lock acquisition is successful it returns true; otherwise it returns false. 💅

Heads up though: this function is allowed to fail spuriously and return false even if the mutex is not currently exclusively locked by any other thread. So a false doesn’t always mean someone else is holding it exclusively — rude, but legal. 😭

If a prior unlock() operation on the same mutex happens, it synchronizes-with (as defined in std::memory_order) this operation when this one returns true. That’s the memory-order tea. 🍵

⚠️ UNDEFINED BEHAVIOR ALERT: the behavior is undefined if the calling thread already owns the mutex in any mode. Do not do that. Not even a little. 💀

🎀 Parameters 🎀

Literally none. Zero. Nada. This function takes no parameters. 🧚

⭐ Return value ⭐

true if the lock was acquired successfully, otherwise false. That’s it. That’s the whole vibe check. ✅

🦋 Exceptions 🦋

It throws absolutely nothing. Not a single exception. Silent. Iconic. ✨

🍓 Example 🍓

This section is incomplete Reason: no example

Yeah bestie, they really left us hanging — no example here. 🙈

🔥 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)
• unlock_shared — unlocks the mutex (shared ownership) (public member function)

🏷️ Category 🏷️

• * Todo no example

made with 💖 by http://cppreference.com — version/date: 2024.06.10 🌈🫶