epics::pvData::Lock Class Reference

A lock for multithreading. More...

#include "lock.h"

Public Member Functions
	Lock (Mutex &m)
	~Lock ()
void	lock ()
void	unlock ()
bool	tryLock ()
bool	ownsLock () const

Detailed Description

A lock for multithreading.

This is based on item 14 of

• Effective C++, Third Edition, Scott Meyers

Definition at line 36 of file lock.h.

Constructor & Destructor Documentation

epics::pvData::Lock::Lock ( Mutex &  m )

inlineexplicit

Constructor

Parameters

m	The mutex for the facility being locked.

Definition at line 43 of file lock.h.

    : mutexPtr(m), locked(true)
    { mutexPtr.lock();}

epics::pvData::Lock::~Lock ( )

inline

Destructor Note that destructor does an automatic unlock.

Definition at line 50 of file lock.h.

{unlock();}

Member Function Documentation

void epics::pvData::Lock::lock ( )

inline

Take the lock Recursive locks are supported but each lock must be matched with an unlock.

Definition at line 55 of file lock.h.

    {
        if(!locked) 
        {
            mutexPtr.lock();
            locked = true;
        }
    }

bool epics::pvData::Lock::ownsLock ( ) const

inline

See if caller has the lock,

Returns

(false,true) if caller (does not have, has) the lock.

Definition at line 91 of file lock.h.

{return locked;}

bool epics::pvData::Lock::tryLock ( )

inline

If lock is not held take the lock.

Returns

(false,true) if caller (does not have, has) the lock.

Definition at line 78 of file lock.h.

    {
         if(locked) return true;
         if(mutexPtr.tryLock()) {
             locked = true;
             return true;
         }
         return false;
    }

void epics::pvData::Lock::unlock ( )

inline

release the lock.

Definition at line 66 of file lock.h.

    {
        if(locked)
        {
            mutexPtr.unlock();
            locked=false;
        }
    }

---

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

• modules/pvData/src/misc/pv/lock.h