#include <bslmt_readlockguard.h>
Public Member Functions | |
| ReadLockGuard (T *lock) | |
| ReadLockGuard (T *lock, bool alreadyLockedFlag) | |
| ~ReadLockGuard () | |
| T * | release () |
| T * | ptr () const |
Detailed Description
template<class T>
class bslmt::ReadLockGuard< T >
This class template implements a guard for acquisition and release of read synchronization resources (i.e., reader locks).
See Component bslmt_readlockguard
Constructor & Destructor Documentation
| bslmt::ReadLockGuard< T >::ReadLockGuard | ( | T * | lock | ) | [explicit] |
Create a scoped guard that conditionally manages the specified lock (if non-null) and invokes lock->lockRead(). Supplying a null lock has no effect. The behavior is undefined unless lock (if non-null) is not already locked by this thread. Note that lock must remain valid throughout the lifetime of this guard, or until release is called.
| bslmt::ReadLockGuard< T >::ReadLockGuard | ( | T * | lock, | |
| bool | alreadyLockedFlag | |||
| ) |
Create a scoped guard that conditionally manages the specified lock (if non-null) and invokes lock->lockRead() if the specified alreadyLockedFlag is false. Supplying a null lock has no effect. The behavior is undefined unless the state of lock (if non-null) is consistent with alreadyLockedFlag. Note that alreadyLockedFlag is used to indicate whether lock is in an already-locked state when passed, so if alreadyLockedFlag is true the lock method will not be called on the supplied lock. Also note that lock must remain valid throughout the lifetime of this guard, or until release is called.
| bslmt::ReadLockGuard< T >::~ReadLockGuard | ( | ) |
Destroy this scoped guard and invoke the unlock method on the lock object under management by this guard, if any. If no lock is currently being managed, this method has no effect.
Member Function Documentation
| T* bslmt::ReadLockGuard< T >::release | ( | ) |
Return the address of the modifiable lock object under management by this guard, and release the lock from further management by this guard. If no lock is currently being managed, return 0 with no other effect. Note that this operation does not unlock the lock object (if any) that was under management.
| T* bslmt::ReadLockGuard< T >::ptr | ( | ) | const |
Return the address of the modifiable lock object under management by this guard, or 0 if no lock is currently being managed.
The documentation for this class was generated from the following file:
Generated on Fri Mar 31 2023 13:30:22 for BDE Release 3.115.0.0 Production Release by
1.7.1