Lock Class Reference

Ephemeral mutex, semaphore or rw-lock locking object. More...

#include <yateclass.h>

Public Member Functions
	Lock (Lockable &lck, long maxwait=-1, bool readLock=false)
	Lock (Lockable *lck, long maxwait=-1, bool readLock=false)
	~Lock ()
Lockable *	locked () const
void	drop ()
bool	acquire (Lockable *lck, long maxwait=-1, bool readLock=false)
bool	acquire (Lockable &lck, long maxwait=-1, bool readLock=false)

Detailed Description

Ephemeral mutex, semaphore or rw-lock locking object.

A lock is a stack allocated (automatic) object that locks a lockable object on creation and unlocks it on destruction - typically when exiting a block

Constructor & Destructor Documentation

Lock() [1/2]

Lock ( Lockable & lck, long maxwait = -1, bool readLock = false )

inline

Create the lock, try to lock the object

Parameters

lck	Reference to the object to lock
maxwait	Time in microseconds to wait, -1 wait forever
readLock	Read lock a RWLock

References acquire().

Lock() [2/2]

Lock ( Lockable * lck, long maxwait = -1, bool readLock = false )

inline

Create the lock, try to lock the object

Parameters

lck	Pointer to the object to lock
maxwait	Time in microseconds to wait, -1 wait forever
readLock	Read lock a RWLock

References acquire().

~Lock()

~Lock ( )

inline

Destroy the lock, unlock the mutex if it was locked

References drop().

Member Function Documentation

acquire() [1/2]

bool acquire ( Lockable & lck, long maxwait = -1, bool readLock = false )

inline

Attempt to acquire a new lock on another object

Parameters

lck	Reference to the object to lock
maxwait	Time in microseconds to wait, -1 wait forever
readLock	Read lock a RWLock

Returns

True if locking succeeded or same object was locked

References acquire().

acquire() [2/2]

bool acquire ( Lockable * lck, long maxwait = -1, bool readLock = false )

inline

Attempt to acquire a new lock on another object

Parameters

lck	Pointer to the object to lock
maxwait	Time in microseconds to wait, -1 wait forever
readLock	Read lock a RWLock

Returns

True if locking succeeded or same object was locked

References drop(), Lockable::lock(), Lockable::lockableRWLock(), locked(), and RWLock::readLock().

Referenced by acquire(), Lock(), and Lock().

drop()

void drop ( )

inline

Unlock the object if it was locked and drop the reference to it

Referenced by acquire(), and ~Lock().

locked()

Lockable * locked ( ) const

inline

Return a pointer to the lockable object this lock holds

Returns

A pointer to a Lockable or NULL if locking failed

Referenced by acquire().

---

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

• yateclass.h