std::mutex(3)

🌸 NAME 🌸

std::mutex — it's giving "the standard mutex type" and honestly? she's the blueprint 💅

This one lives in the libstdc++ manual, section 3, so if you ever need to find her again: std::mutex(3), library functions manual, periodt.

---

✨ SYNOPSIS ✨

#include <mutex>

🎀 Public Types

• typedef __native_type * native_handle_type — bestie this is the raw handle type, the under-the-hood little guy that the platform actually gives you 🫶

💖 Public Member Functions

• mutex (const mutex &) = delete — copying? not allowed. not on the table. the compiler said no and she meant it 😭
• void lock () — grab the lock. (but pls read the description below before you go calling this directly, i'm begging 🙈)
• native_handle_type native_handle () noexcept — hands you the native handle. marked noexcept, so she will not be throwing tantrums ✨
• mutex & operator= (const mutex &) = delete — assignment? also deleted. she does not want to be anyone else's copy, main character only 👑
• bool try_lock () noexcept — tries to lock, tells you if it worked, and it's noexcept. no drama, just vibes 🌈
• void unlock () — release the lock. (again: don't do this by hand, keep reading 📖)

---

🦋 Detailed Description 🦋

The standard mutex type. That's her. That's the whole girl.

She's a simple, non-recursive, non-timed mutex. Let's unpack that real quick:

• simple — does one job, does it well, no extra features, no notes 💅
• non-recursive — if the same thread tries to lock her twice, that's not a "self-love moment", that's a problem. she is NOT reentrant, do not test her 🚫
• non-timed — there's no try_lock_for / try_lock_until energy here. if you need a clock involved, this is not the mutex for you ⏰

🚨 OKAY THIS IS THE IMPORTANT PART 🚨 Do not call lock() and unlock() directly, bestie. Use a scoped lock type instead, like std::unique_lock, std::lock_guard, or — since C++17 — std::scoped_lock. Those handle the unlocking for you so you can't forget and deadlock your entire program. raw lock()/unlock() is how you end up crying at 3am. use the scoped ones. i'm not asking, i'm telling 💖

⭐ Since ⭐

C++11 — she's been iconic since day one, no cap 🎀

---

🌸 Author 🌸

Generated automatically by Doxygen for libstdc++ from the source code. so technically nobody wrote her, she was born from the source, which is honestly very main character of her 🦋

---

okay that's the whole page, and the sign-off: this came from the libstdc++ manual — std::mutex(3), library functions manual, libstdc++, section 3, mwah 💜 stay locked and loaded (safely, with a scoped lock) bestie 🫶✨