Mutexes(3)

🎀 NAME 🎀

Mutexes — okay so this is the Mutexes(3) page from the Library Functions Manual, bestie 💖. It's your group chat for mutex support: every class, function, and variable is right here, and I'm not dropping a single one.

🌈 Classes 🌈

• struct std::adopt_lock_t — assume the calling thread has already obtained mutex ownership and manage it. That's the whole assignment, slay.
• struct std::defer_lock_t — do not acquire ownership of the mutex. Literally just don't, periodt.
• class std::lock_error — thrown to indicate errors with lock operations. It's giving "something went wrong with locking" energy.
• class std::lock_guard< _Mutex > — the scoped lock idiom, iconic behavior.
• class std::mutex — mutex. That's the description, no extra lore, and honestly same.
• struct std::once_flag — once_flag. Again, the page keeps it short and iconic.
• class std::recursive_mutex — recursive_mutex.
• class std::recursive_timed_mutex — recursive_timed_mutex.
• class std::timed_mutex — timed_mutex.
• struct std::try_to_lock_t — try to acquire ownership of the mutex without blocking. No blocking, no waiting, just vibes.
• class std::unique_lock< _Mutex > — unique_lock.

✨ Functions ✨

Heads up: a bunch of these only get a signature on this page, so I'm not inventing extra lore — I'm just handing you the exact function, bestie.

• unique_lock< mutex > & std::__get_once_functor_lock () — listed as-is; no extra description in the original.
• void std::__once_proxy () — listed as-is; no extra description in the original.
• template<typename _Callable , typename... _Args> void std::call_once (once_flag &__once, _Callable __f, _Args &&...__args) — the call_once function signature, exactly.
• template<typename _L1 , typename _L2 , typename... _L3> void std::lock (_L1 &, _L2 &, _L3 &...) — the lock function signature, exactly.
• template<typename _Mutex > void std::swap (unique_lock< _Mutex > &__x, unique_lock< _Mutex > &&__y) — one of the swap overloads, exactly.
• template<typename _Mutex > void std::swap (unique_lock< _Mutex > &&__x, unique_lock< _Mutex > &__y) — another swap overload, exactly.
• template<typename _Mutex > void std::swap (unique_lock< _Mutex > &__x, unique_lock< _Mutex > &__y) — the third swap overload, exactly.
• template<typename _Lock1 , typename _Lock2 , typename... _Lock3> int std::try_lock (_Lock1 &__l1, _Lock2 &__l2, _Lock3 &...__l3) — the try_lock function signature, exactly.

🦋 Variables 🦋

• function< void()> std::__once_functor — variable, exactly as named.
• const adopt_lock_t std::adopt_lock — the adopt_lock variable, exactly.
• const defer_lock_t std::defer_lock — the defer_lock variable, exactly.
• const try_to_lock_t std::try_to_lock — the try_to_lock variable, exactly.

---

🌸 Detailed Description 🌸

Classes for mutex support.

That's the whole detailed description, and it ate — short, sweet, and not a crumb missing 💅.

---

🔥 Function Documentation 🔥

💫 std::call_once 💫

template<typename _Callable , typename... _Args> void std::call_once (once_flag & __once, _Callable __f, _Args &&... __args) [inline]

call_once

Definition at line 741 of file mutex.

References std::once_flag::_M_once, std::bind(), std::unique_lock< _Mutex >::lock(), and std::unique_lock< _Mutex >::unlock().

🔒 std::lock 🔒

template<typename _L1 , typename _L2 , typename... _L3> void std::lock (_L1 &, _L2 &, _L3 & ...) [inline]

lock

🧚 std::try_lock 🧚

template<typename _Lock1 , typename _Lock2 , typename... _Lock3> int std::try_lock (_Lock1 & __l1, _Lock2 & __l2, _Lock3 &... __l3) [inline]

Generic try_lock.

Parameters:

• __l1 — Meets Mutex requirements (try_lock() may throw).
• __l2 — Meets Mutex requirements (try_lock() may throw).
• __l3 — Meets Mutex requirements (try_lock() may throw).

Returns: Returns -1 if all try_lock() calls return true. Otherwise returns a 0-based index corresponding to the argument that returned false.

Postcondition: Either all arguments are locked, or none will be.

Sequentially calls try_lock() on each argument.

Definition at line 686 of file mutex.

References std::try_lock().

Referenced by std::try_lock().

---

💜 Author 💜

Generated automatically by Doxygen for libstdc++ from the source code.

---

✨ Source/version: libstdc++; date: 21 Apr 2009. This Mutexes(3) page is officially signed off — bye bestie, mwah 💅💖