mutex(3)

πŸ“¦ version 4.4.0, in nixpkgs unstable

πŸ’… mutex(3) β€” the Library Functions Manual cutie πŸ’…

okay so this page is from the Library Functions Manual and it's giving Standard C++ Library header energy. we're keeping every single detail, no cap, because the vibe is cute but the facts are sacred ✨


✨ NAME ✨

  • mutex β€” the original line is mutex -, and there's literally no description after the dash, so we're not inventing one, periodt 😭

πŸ¦‹ SYNOPSIS πŸ¦‹

here's the whole cast, bestie β€” no skipping, fr fr.

πŸŽ€ Classes πŸŽ€

  • struct std::adopt_lock_t β€” assume the calling thread has already obtained mutex ownership and manage it.
  • struct std::defer_lock_t β€” do not acquire ownership of the mutex.
  • class std::lock_error β€” thrown to indicate errors with lock operations.
  • class std::lock_guard< _Mutex > β€” scoped lock idiom.
  • class std::mutex β€” mutex (yes, that is the whole description, and honestly? iconic minimalism πŸ’€)
  • struct std::once_flag β€” once_flag
  • 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.
  • class std::unique_lock< _Mutex > β€” unique_lock

🌈 Namespaces 🌈

  • namespace std β€” the namespace, bestie. that's the entry 🫢

⭐ Defines ⭐

  • #define _GLIBCXX_MUTEX β€” the define, exactly as written, no edits πŸ’…

πŸ”₯ Functions πŸ”₯

these are the function signatures, verbatim β€” we do not touch the code, ever.

  • unique_lock< mutex > & std::__get_once_functor_lock ()
  • void std::__once_proxy ()
  • template<typename _Callable , typename... _Args> void std::call_once (once_flag &__once, _Callable __f, _Args &&...__args)
  • template<typename _L1 , typename _L2 , typename... _L3> void std::lock (_L1 &, _L2 &, _L3 &...)
  • template<typename _Mutex > void std::swap (unique_lock< _Mutex > &__x, unique_lock< _Mutex > &&__y)
  • template<typename _Mutex > void std::swap (unique_lock< _Mutex > &&__x, unique_lock< _Mutex > &__y)
  • template<typename _Mutex > void std::swap (unique_lock< _Mutex > &__x, unique_lock< _Mutex > &__y)
  • template<typename _Lock1 , typename _Lock2 , typename... _Lock3> int std::try_lock (_Lock1 &__l1, _Lock2 &__l2, _Lock3 &...__l3)

πŸ“ Variables πŸ“

  • function< void()> std::__once_functor
  • const adopt_lock_t std::adopt_lock
  • const defer_lock_t std::defer_lock
  • const try_to_lock_t std::try_to_lock

πŸ’– Detailed Description πŸ’–

This is a Standard C++ Library header.

Definition in file mutex.

that's the tea, and yes, it's short and sweet πŸ«–βœ¨

🌸 Author 🌸

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

literally generated by Doxygen for libstdc++, so you know it's official-ish πŸ’…


xoxo, your libstdc++ bestie πŸ’– this iconic page is dated 21 Apr 2009 and it's literally mutex(3) β€” byeee πŸŽ€

πŸ“¦ where this page comes from