std::shared_lock::unlock(3)

💖 NAME 💖 — std::shared_lock::unlock(3) from the C++ Standard Libary manual

okay so bestie, welcome to the page for std::shared_lock::unlock — yes, the shared-lock unlock function, and it is literally the “let go of the shared lock” moment. Main character energy for your mutex, honestly. 💅

🌸 Synopsis 🌸

void unlock();  (since C++14)

Unlocks the associated mutex from shared mode. Effectively calls mutex()->unlock_shared().

std::system_error is thrown if there is no associated mutex or if the mutex is not locked.

🎀 Parameters 🎀

(none) — not a single parameter, bestie. Lowkey zero. None. 🫶

✨ Return value ✨

(none) — it returns nothing, it just does the unlock thing. Periodt.

💥 Exceptions 💥

• Any exceptions thrown by mutex()->unlock_shared().
• If there is no associated mutex, std::system_error with an error code of std::errc::operation_not_permitted.

bestie please note: no associated mutex or a mutex that isn’t locked means std::system_error, okay? No cap, that’s the exception vibe. 😭

🧚 Example 🧚

This section is incomplete.

Reason: no example.

Not me wanting an example too, but that’s what the page says. 🙈

🔥 See also 🔥

• lock — locks the associated mutex (public member function)
• release — disassociates the mutex without unlocking (public member function)

🦋 Category 🦋

• Todo no example

xoxo, your Unix bestie 💜 — source: http://cppreference.com, version/date: 2024.06.10, page: std::shared_lock::unlock(3)