SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
Guard class that tries to acquire its resource upon creation and release it upon destruction. More...
#include <rw/sync/RWTTryLockGuard.h>
Public Member Functions | |
RWTTryLockGuard (Resource &resource) | |
~RWTTryLockGuard () | |
bool | tryAcquire () |
Private Member Functions | |
RWTTryLockGuard (const RWTTryLockGuard< Resource > &second) | |
RWTTryLockGuard< Resource > & | operator= (const RWTTryLockGuard< Resource > &second) |
RWTTryLockGuard<Resource> is a guard class that tries to acquire its resource upon creation and, if successful, release it upon destruction. Guard objects work in conjunction with block statements to establish an appropriate state upon creation, maintain that state for the duration of the block, and restore the original state upon destruction. For example, a guard may acquire a mutex when created and release it when destructed. The class used as the actual template parameter for Resource
must be one that provides tryAcquire
() and release
() methods, such as some synchronization classes provided in this module.
#include <rw/sync/RWMutexLock.h> #include <rw/sync/RWTTryLockGuard.h> RWMutexLock mutex; bool foo() { // ... { // try to acquire mutex: RWTTryLockGuard<RWMutexLock> lock(mutex); // See if the mutex was acquired: if (!lock.isAcquired()) { return false; // Can't get lock, // give up and return error } // ... critical section // Mutex will be released in RWTTryLockGuard destructor // before leaving scope, especially important // if an exception might be thrown! } // ... return true; }
RWTTryLockGuard< Resource >::RWTTryLockGuard | ( | Resource & | resource | ) | [inline] |
Constructs an instance with the given resource and attempts to acquire that resource. Use the inherited isAcquired() member function to see if the acquisition was successful.
RWTTryLockGuard< Resource >::~RWTTryLockGuard | ( | ) | [inline] |
Destructor.
RWTTryLockGuard< Resource >::RWTTryLockGuard | ( | const RWTTryLockGuard< Resource > & | second | ) | [private] |
Copy construction prohibited.
RWTTryLockGuard<Resource>& RWTTryLockGuard< Resource >::operator= | ( | const RWTTryLockGuard< Resource > & | second | ) | [private] |
Assignment prohibited.
bool RWTTryLockGuard< Resource >::tryAcquire | ( | ) | [inline] |
Tries again to acquire the resource. Use this function instead of manipulating the resource directly so the guard will automatically release it.
© Copyright Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave and SourcePro are registered trademarks of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.
Contact Rogue Wave about documentation or support issues.