CppUtils::Thread::UniqueLocker<class T>

Monitor Object wrapper encapsulating a resource with a mutex.

Description

Ensures that all access to the underlying resource must pass through an Accessor RAII object that holds the mutex lock, guaranteeing at compile time that access to the protected data is synchronized.

Related guide

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

Template parameter	Description
T	The type of the protected resource.

Public methods & functions

explicit UniqueLocker::UniqueLocker(auto&&... args);

Constructs the protected resource in place.

Parameter	Description
args	Arguments forwarded to the resource constructor.

---

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

---

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

---

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

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

---

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

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

---

[[nodiscard]] auto UniqueLocker::access() & -> Accessor<T, std::mutex>;

Acquires exclusive read/write access to the resource.

Returns: Accessor object managing the lock and providing access.

---

auto UniqueLocker::access() const& -> Accessor<const T, std::mutex>;

Acquires exclusive read-only access to the resource from an lvalue reference.

Returns: Const Accessor object managing the lock.

---

auto UniqueLocker::access() const&& -> Accessor<const T, std::mutex>;

Acquires exclusive read-only access to the resource from an rvalue reference.

Returns: Const Accessor object managing the lock.

---