dxd::lock< lock_t > Class Template Reference

#include <dxd_sync_platform.h>

Public Member Functions
	lock ()
	lock ()=default
	lock (lock_t &lock)
	lock (lock_t &lock)
bool	trylock (lock_t &lock)
bool	trylock (lock_t &lock)
	~lock ()
	~lock ()

Public Attributes
os_result	status =not_initialized

Constructor & Destructor Documentation

lock() [1/4]

template<class lock_t = mutex>

dxd::lock< lock_t >::lock ( )

default

this constructor is only used in conjunction with trylock(): where the mutex or rwlock might be obtained at trylock() time

lock() [2/4]

template<class lock_t = mutex>

dxd::lock< lock_t >::lock ( lock_t &  lock )

inline

standard constructor

Parameters

lock	the mutex or rwlock object to lock

~lock() [1/2]

template<class lock_t = mutex>

dxd::lock< lock_t >::~lock ( )

inline

standard destructor

lock() [3/4]

template<class lock_t = mutex>

dxd::lock< lock_t >::lock ( )

inline

this constructor is only used in conjunction with trylock(): where the mutex or rwlock might be obtained at trylock() time

lock() [4/4]

template<class lock_t = mutex>

dxd::lock< lock_t >::lock ( lock_t &  lock )

inline

standard constructor

Parameters

lock	the mutex or rwlock object to lock

~lock() [2/2]

template<class lock_t = mutex>

dxd::lock< lock_t >::~lock ( )

inline

standard destructor

Member Function Documentation

trylock() [1/2]

template<class lock_t = mutex>

bool dxd::lock< lock_t >::trylock ( lock_t &  lock )

inline

try to obtain the lock for the mutex or rwlock object; returns true if mutex or rwlock object could be successfully locked; false if mutex was locked elsewhere

Parameters

lock	the mutex or rwlock object to lock

trylock() [2/2]

template<class lock_t = mutex>

bool dxd::lock< lock_t >::trylock ( lock_t &  lock )

inline

try to obtain the lock for the mutex or rwlock object; returns true if mutex or rwlock object could be successfully locked; false if mutex was locked elsewhere

Parameters

lock	the mutex or rwlock object to lock

Member Data Documentation

status

template<class lock_t = mutex>

os_result dxd::lock< lock_t >::status =not_initialized

---

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

• iokit/dxd_sync_platform.h