STD::SHARED_LOCK(3)

💖 NAME 💖

std::shared_lock< _Mutex > — bestie, that's it, that's the name. It's shared_lock. Short, sweet, iconic. ✨

---

🦋 SYNOPSIS 🦋

#include <shared_mutex>

Okay so first things first, you gotta pull in the header. That's the whole entry fee. 🎀

👑 Public Types 👑

• typedef _Mutex mutex_type — the mutex type you're working with gets typedef'd to mutex_type, so you can stop typing out the whole template situation every single time. Slay.

🌸 Public Member Functions 🌸

• shared_lock (mutex_type &__m) — constructor taking a reference to your mutex, named __m. Simple. Clean. Main character.
• shared_lock (mutex_type &__m, adopt_lock_t) — same mutex ref __m, plus an adopt_lock_t tag riding along. 🫶
• template<typename _Rep, typename _Period> shared_lock (mutex_type &__m, const chrono::duration< _Rep, _Period > &__rel_time) — template constructor: your __m plus a chrono::duration< _Rep, _Period > reference called __rel_time. Yes, chrono::duration, exactly like that, no cap.
• template<typename _Clock, typename _Duration> shared_lock (mutex_type &__m, const chrono::time_point< _Clock, _Duration > &__abs_time) — the time-point sibling: __m plus a chrono::time_point< _Clock, _Duration > reference named __abs_time. 🔥
• shared_lock (mutex_type &__m, defer_lock_t) noexcept — __m plus a defer_lock_t tag, and it's marked noexcept so it's promising not to throw. 💅
• shared_lock (mutex_type &__m, try_to_lock_t) — __m plus a try_to_lock_t tag. No noexcept on this one, just saying. 👀
• shared_lock (shared_lock &&__sl) noexcept — move constructor, takes shared_lock &&__sl, and it's noexcept. Moves are the vibe.
• shared_lock (shared_lock const &)=delete — copy constructor is deleted. Like, literally not available. Do not attempt, bestie, it will not compile. 💀
• void lock () — returns void, takes nothing. It's just lock().
• mutex_type * mutex () const noexcept — returns a mutex_type *, and it's const noexcept. Pointer delivery service.
• operator bool () const noexcept — the bool conversion operator, const noexcept. Very "am I valid" energy, iykyk.
• shared_lock & operator= (shared_lock &&__sl) noexcept — move assignment, takes shared_lock &&__sl, returns a shared_lock &, marked noexcept.
• shared_lock & operator= (shared_lock const &)=delete — copy assignment is deleted too. Same rule as before: not a thing. 🙈
• bool owns_lock () const noexcept — returns bool, const noexcept. Yes or no, that's the range.
• mutex_type * release () noexcept — returns mutex_type *, noexcept. Releases and hands you back a pointer.
• void swap (shared_lock &__u) noexcept — takes a shared_lock & named __u, returns void, noexcept. Swap szn. 🌈
• bool try_lock () — returns bool, takes nothing.
• template<typename _Rep, typename _Period> bool try_lock_for (const chrono::duration< _Rep, _Period > &__rel_time) — template, returns bool, takes a chrono::duration< _Rep, _Period > reference called __rel_time.
• template<typename _Clock, typename _Duration> bool try_lock_until (const chrono::time_point< _Clock, _Duration > &__abs_time) — template, returns bool, takes a chrono::time_point< _Clock, _Duration > reference named __abs_time. The until twin to the for one above. ⭐
• void unlock () — returns void, takes nothing. That's the closer. Periodt.

---

🔥 Detailed Description 🔥

template<typename _Mutex>
    class std::shared_lock< _Mutex >"shared_lock

That's the class, written out exactly as the page has it — stray lil quote mark and all, we don't question it, we just respect it. 🧚

---

🎀 Author 🎀

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

---

And that's the whole page, bestie 🥰 this one came from libstdc++ (that's the source/version stamp on the footer, alongside the std::share...< _Mutex >(3) title up top). No date on the footer, so no date from me — I'm not out here making things up. Go forth and lock responsibly. 💜🌸