kcenon::thread::sync::scoped_lock_guard< Mutex > Class Template Reference

RAII-based scoped lock guard with timeout support. More...

#include <sync_primitives.h>

Collaboration diagram for kcenon::thread::sync::scoped_lock_guard< Mutex >:

Public Member Functions
	scoped_lock_guard (Mutex &mutex)
	Construct and immediately acquire the lock.
template<typename Rep , typename Period >
	scoped_lock_guard (Mutex &mutex, const std::chrono::duration< Rep, Period > &timeout)
	Construct and try to acquire the lock with timeout.
	~scoped_lock_guard ()
	Destructor - automatically releases the lock if held.
	scoped_lock_guard (const scoped_lock_guard &)=delete
scoped_lock_guard &	operator= (const scoped_lock_guard &)=delete
	scoped_lock_guard (scoped_lock_guard &&)=delete
scoped_lock_guard &	operator= (scoped_lock_guard &&)=delete
bool	owns_lock () const noexcept
	Check if the lock was successfully acquired.
void	unlock ()
	Explicitly release the lock before destruction.
	scoped_lock_guard (Mutex &mutex)
	Construct and immediately acquire the lock.
template<typename Rep , typename Period >
	scoped_lock_guard (Mutex &mutex, const std::chrono::duration< Rep, Period > &timeout)
	Construct and try to acquire the lock with timeout.
	~scoped_lock_guard ()
	Destructor - automatically releases the lock if held.
	scoped_lock_guard (const scoped_lock_guard &)=delete
scoped_lock_guard &	operator= (const scoped_lock_guard &)=delete
	scoped_lock_guard (scoped_lock_guard &&)=delete
scoped_lock_guard &	operator= (scoped_lock_guard &&)=delete
bool	owns_lock () const noexcept
	Check if the lock was successfully acquired.
void	unlock ()
	Explicitly release the lock before destruction.

Private Attributes
Mutex &	mutex_
bool	locked_

Detailed Description

template<typename Mutex>
class kcenon::thread::sync::scoped_lock_guard< Mutex >

RAII-based scoped lock guard with timeout support.

This class provides automatic lock management with optional timeout capabilities, ensuring locks are always released even in exceptional situations.

Definition at line 205 of file forward.h.

Constructor & Destructor Documentation

scoped_lock_guard() [1/8]

template<typename Mutex >

kcenon::thread::sync::scoped_lock_guard< Mutex >::scoped_lock_guard ( Mutex & mutex )

inlineexplicit

Construct and immediately acquire the lock.

Parameters

mutex

The mutex to lock

Definition at line 27 of file sync_primitives.h.

            : mutex_(mutex), locked_(true) {
            mutex_.lock();
        }

References kcenon::thread::sync::scoped_lock_guard< Mutex >::mutex_.

scoped_lock_guard() [2/8]

template<typename Mutex >

template<typename Rep , typename Period >

kcenon::thread::sync::scoped_lock_guard< Mutex >::scoped_lock_guard ( Mutex & mutex, const std::chrono::duration< Rep, Period > & timeout )

inline

Construct and try to acquire the lock with timeout.

Parameters

mutex	The mutex to lock
timeout	Maximum time to wait for the lock

Definition at line 38 of file sync_primitives.h.

            : mutex_(mutex), locked_(false) {
            if constexpr (std::is_same_v<Mutex, std::timed_mutex> || 
                         std::is_same_v<Mutex, std::recursive_timed_mutex>) {
                locked_ = mutex_.try_lock_for(timeout);
            } else {
                // Fallback for mutexes without timeout support
                locked_ = mutex_.try_lock();
            }
        }

References kcenon::thread::sync::scoped_lock_guard< Mutex >::locked_, and kcenon::thread::sync::scoped_lock_guard< Mutex >::mutex_.

~scoped_lock_guard() [1/2]

template<typename Mutex >

kcenon::thread::sync::scoped_lock_guard< Mutex >::~scoped_lock_guard ( )

inline

Destructor - automatically releases the lock if held.

Definition at line 52 of file sync_primitives.h.

                             {
            if (locked_) {
                mutex_.unlock();
            }
        }

References kcenon::thread::sync::scoped_lock_guard< Mutex >::locked_, and kcenon::thread::sync::scoped_lock_guard< Mutex >::mutex_.

scoped_lock_guard() [3/8]

template<typename Mutex >

kcenon::thread::sync::scoped_lock_guard< Mutex >::scoped_lock_guard ( const scoped_lock_guard< Mutex > & )

delete

scoped_lock_guard() [4/8]

template<typename Mutex >

kcenon::thread::sync::scoped_lock_guard< Mutex >::scoped_lock_guard ( scoped_lock_guard< Mutex > && )

delete

scoped_lock_guard() [5/8]

template<typename Mutex >

kcenon::thread::sync::scoped_lock_guard< Mutex >::scoped_lock_guard ( Mutex & mutex )

inlineexplicit

Construct and immediately acquire the lock.

Parameters

mutex

The mutex to lock

Definition at line 33 of file sync_primitives.h.

            : mutex_(mutex), locked_(true) {
            mutex_.lock();
        }

References kcenon::thread::sync::scoped_lock_guard< Mutex >::mutex_.

scoped_lock_guard() [6/8]

template<typename Mutex >

template<typename Rep , typename Period >

kcenon::thread::sync::scoped_lock_guard< Mutex >::scoped_lock_guard ( Mutex & mutex, const std::chrono::duration< Rep, Period > & timeout )

inline

Construct and try to acquire the lock with timeout.

Parameters

mutex	The mutex to lock
timeout	Maximum time to wait for the lock

Definition at line 44 of file sync_primitives.h.

            : mutex_(mutex), locked_(false) {
            if constexpr (std::is_same_v<Mutex, std::timed_mutex> || 
                         std::is_same_v<Mutex, std::recursive_timed_mutex>) {
                locked_ = mutex_.try_lock_for(timeout);
            } else {
                // Fallback for mutexes without timeout support
                locked_ = mutex_.try_lock();
            }
        }

References kcenon::thread::sync::scoped_lock_guard< Mutex >::locked_, and kcenon::thread::sync::scoped_lock_guard< Mutex >::mutex_.

~scoped_lock_guard() [2/2]

template<typename Mutex >

kcenon::thread::sync::scoped_lock_guard< Mutex >::~scoped_lock_guard ( )

inline

Destructor - automatically releases the lock if held.

Definition at line 58 of file sync_primitives.h.

                             {
            if (locked_) {
                mutex_.unlock();
            }
        }

References kcenon::thread::sync::scoped_lock_guard< Mutex >::locked_, and kcenon::thread::sync::scoped_lock_guard< Mutex >::mutex_.

scoped_lock_guard() [7/8]

template<typename Mutex >

kcenon::thread::sync::scoped_lock_guard< Mutex >::scoped_lock_guard ( const scoped_lock_guard< Mutex > & )

delete

scoped_lock_guard() [8/8]

template<typename Mutex >

kcenon::thread::sync::scoped_lock_guard< Mutex >::scoped_lock_guard ( scoped_lock_guard< Mutex > && )

delete

Member Function Documentation

operator=() [1/4]

template<typename Mutex >

scoped_lock_guard & kcenon::thread::sync::scoped_lock_guard< Mutex >::operator= ( const scoped_lock_guard< Mutex > & )

delete

operator=() [2/4]

template<typename Mutex >

scoped_lock_guard & kcenon::thread::sync::scoped_lock_guard< Mutex >::operator= ( const scoped_lock_guard< Mutex > & )

delete

operator=() [3/4]

template<typename Mutex >

scoped_lock_guard & kcenon::thread::sync::scoped_lock_guard< Mutex >::operator= ( scoped_lock_guard< Mutex > && )

delete

operator=() [4/4]

template<typename Mutex >

scoped_lock_guard & kcenon::thread::sync::scoped_lock_guard< Mutex >::operator= ( scoped_lock_guard< Mutex > && )

delete

owns_lock() [1/2]

template<typename Mutex >

bool kcenon::thread::sync::scoped_lock_guard< Mutex >::owns_lock ( ) const

inlinenodiscardnoexcept

Check if the lock was successfully acquired.

Returns

true if lock is held, false otherwise

Definition at line 68 of file sync_primitives.h.

                                                      {
            return locked_;
        }

References kcenon::thread::sync::scoped_lock_guard< Mutex >::locked_.

owns_lock() [2/2]

template<typename Mutex >

bool kcenon::thread::sync::scoped_lock_guard< Mutex >::owns_lock ( ) const

inlinenodiscardnoexcept

Check if the lock was successfully acquired.

Returns

true if lock is held, false otherwise

Definition at line 74 of file sync_primitives.h.

                                                      {
            return locked_;
        }

References kcenon::thread::sync::scoped_lock_guard< Mutex >::locked_.

unlock() [1/2]

template<typename Mutex >

void kcenon::thread::sync::scoped_lock_guard< Mutex >::unlock ( )

inline

Explicitly release the lock before destruction.

Definition at line 75 of file sync_primitives.h.

                      {
            if (locked_) {
                mutex_.unlock();
                locked_ = false;
            }
        }

References kcenon::thread::sync::scoped_lock_guard< Mutex >::locked_, and kcenon::thread::sync::scoped_lock_guard< Mutex >::mutex_.

unlock() [2/2]

template<typename Mutex >

void kcenon::thread::sync::scoped_lock_guard< Mutex >::unlock ( )

inline

Explicitly release the lock before destruction.

Definition at line 81 of file sync_primitives.h.

                      {
            if (locked_) {
                mutex_.unlock();
                locked_ = false;
            }
        }

References kcenon::thread::sync::scoped_lock_guard< Mutex >::locked_, and kcenon::thread::sync::scoped_lock_guard< Mutex >::mutex_.

Member Data Documentation

locked_

template<typename Mutex >

bool kcenon::thread::sync::scoped_lock_guard< Mutex >::locked_

private

Definition at line 84 of file sync_primitives.h.

Referenced by kcenon::thread::sync::scoped_lock_guard< Mutex >::owns_lock(), kcenon::thread::sync::scoped_lock_guard< Mutex >::scoped_lock_guard(), kcenon::thread::sync::scoped_lock_guard< Mutex >::unlock(), and kcenon::thread::sync::scoped_lock_guard< Mutex >::~scoped_lock_guard().

mutex_

template<typename Mutex >

Mutex & kcenon::thread::sync::scoped_lock_guard< Mutex >::mutex_

private

Definition at line 83 of file sync_primitives.h.

Referenced by kcenon::thread::sync::scoped_lock_guard< Mutex >::scoped_lock_guard(), kcenon::thread::sync::scoped_lock_guard< Mutex >::scoped_lock_guard(), kcenon::thread::sync::scoped_lock_guard< Mutex >::unlock(), and kcenon::thread::sync::scoped_lock_guard< Mutex >::~scoped_lock_guard().

---

The documentation for this class was generated from the following files:

• core/sync/include/sync_primitives.h
• include/kcenon/thread/core/sync_primitives.h
• include/kcenon/thread/forward.h