dxd - dynax driver framework  2675
cross platform open source driver development framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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

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

+ Here is the caller graph for this function:

template<class lock_t = mutex>
dxd::lock< lock_t >::lock ( lock_t &  lock)
inline

standard constructor

Parameters
lockthe mutex or rwlock object to lock
template<class lock_t = mutex>
dxd::lock< lock_t >::~lock ( )
inline

standard destructor

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

template<class lock_t = mutex>
dxd::lock< lock_t >::lock ( lock_t &  lock)
inline

standard constructor

Parameters
lockthe mutex or rwlock object to lock
template<class lock_t = mutex>
dxd::lock< lock_t >::~lock ( )
inline

standard destructor

Member Function Documentation

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
lockthe mutex or rwlock object to lock

+ Here is the call graph for this function:

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
lockthe mutex or rwlock object to lock

+ Here is the call graph for this function:

Member Data Documentation

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:

(c) copyright 2009 dynamic acoustics e.U. generated on Tue Dec 4 2018

a closed source license may be obtained by requesting a written permission from dynamic acoustics e.U.
however - governmental use generally and military use especially is strictly prohibited though.