CppUtils::Thread::SharedLocker<class T>

Monitor Object wrapper providing shared read / exclusive write synchronization.

Description

Encapsulates a resource with a std::shared_mutex, allowing either multiple concurrent read-only accessors (via sharedAccess()) or a single exclusive read-write accessor (via uniqueAccess()).

Related guide

Check out the RAII synchronization guide for detailed explanations and usage examples.

Template parameter	Description
T	Type of the protected resource.

Public types

UniqueAccessor

using CppUtils::Thread::SharedLocker< T >::UniqueAccessor = Accessor<T, SharedMutex>;

SharedAccessor

using CppUtils::Thread::SharedLocker< T >::SharedAccessor = ReadOnlyAccessor<T, SharedMutex>;

Public methods & functions

constexpr SharedLocker::SharedLocker() requires std::default_initializable<T> = default;

---

explicit constexpr SharedLocker::SharedLocker(auto&& first, auto&&... rest);

Constructs the protected resource in place.

Parameter	Description
first	First argument forwarded to the resource constructor.
rest	Rest of arguments forwarded to the resource constructor.

---

SharedLocker::SharedLocker(const SharedLocker&) = delete;

---

auto SharedLocker::operator=(const SharedLocker&) -> SharedLocker& = delete;

---

constexpr SharedLocker::SharedLocker(SharedLocker&& other) noexcept(std::is_nothrow_move_constructible_v<T>);

Move constructor. Acquires lock on the source locker before moving its value.

---

constexpr auto SharedLocker::operator=(SharedLocker&& other) noexcept(std::is_nothrow_move_assignable_v<T>) -> SharedLocker&;

Move assignment. Acquires scoped lock on both mutexes before moving the value.

---

[[nodiscard]] constexpr auto SharedLocker::uniqueAccess() -> UniqueAccessor;

Acquires exclusive read/write access.

Returns: UniqueAccessor holding a unique lock.

---

[[nodiscard]] constexpr auto SharedLocker::sharedAccess() const -> SharedAccessor;

Acquires shared read-only access.

Returns: SharedAccessor holding a shared lock.

---