std::recursive_mutex(3)

💖 std::recursive_mutex 💖

okay so bestie, listen. this page is from the Library Functions Manual, and it's about std::recursive_mutex — the mutex that actually lets you come back for seconds. no cap. it's giving main character energy in the C++ threading world and i'm obsessed. 🦋

---

✨ NAME ✨

std::recursive_mutex — the standard recursive mutex type, fr fr 💅

---

🌸 SYNOPSIS 🌸

#include <mutex>

🎀 Public Types 🎀

• typedef __native_type * native_handle_type — the native handle type, the lil pointer that lets you get all up close and personal with the underlying implementation 🫶

👑 Public Member Functions 👑

• recursive_mutex (const recursive_mutex &)=delete — nope, you cannot copy it. deleted. it's not that kind of mutex, bestie 😭
• void lock () — locks it up 🔥
• native_handle_type native_handle () noexcept — hands you the native handle, and it's noexcept so it will not be dramatic about it ✨
• recursive_mutex & operator= (const recursive_mutex &)=delete — also deleted. no assigning. no passing it around like a group chat screenshot 💀
• bool try_lock () noexcept — tries to lock, tells you yes or no, and it's noexcept so no surprises 🍓
• void unlock () — unlocks it 🎀

---

🌈 Detailed Description 🌈

so the whole vibe here is: it's the standard recursive mutex type.

here's the tea ☕ — a recursive mutex can be locked more than once by the same thread. like, the same thread can just keep coming back and locking it again and again, no judgement.

but the other threads?? they're stuck outside. other threads cannot lock the mutex until the owning thread unlocks it as many times as it was locked. so if you locked it three times, you gotta unlock it three times. it's a whole matching-set situation. count your locks, bestie, or nobody's getting in. 🧚

---

⭐ Since ⭐

C++11 — old enough to be iconic, still slaying 💜

---

🫶 Author 🫶

Generated automatically by Doxygen for libstdc++ from the source code. (not me writing fanfic, the robots did it, and honestly? they ate.)

---

heads up: this page came straight out of libstdc++, so go thank the libstdc++ girlies for the whole thing. mwah 💋 bye bestie, go lock responsibly ✨