rwlogo
SourcePro 11.1

SourcePro® C++ API Reference Guide



   SourcePro C++
Documentation Home

RWTUnlockGuard< Resource > Class Template Reference
[Synchronization]

Guard class that releases its resource upon creation and acquires it upon destruction. More...

#include <rw/sync/RWTUnlockGuard.h>

Inheritance diagram for RWTUnlockGuard< Resource >:
RWTGuardBase< Resource >

List of all members.

Public Member Functions

 RWTUnlockGuard (Resource &resource)
 ~RWTUnlockGuard ()

Private Member Functions

 RWTUnlockGuard (const RWTUnlockGuard< Resource > &second)
RWTUnlockGuard< Resource > & operator= (const RWTUnlockGuard< Resource > &second)

Detailed Description

template<class Resource>
class RWTUnlockGuard< Resource >

RWTUnlockGuard<Resource> is a guard class that releases its resource upon creation and acquires it upon destruction. Guard objects work in conjunction with block statements in such a way as 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 release a mutex upon creation and reacquire it when destructed. The class used as the actual template parameter for Resource must be one that provides acquire and release methods such as the synchronization classes provided in this module.

Examples

 #include <rw/sync/RWMutexLock.h>
 #include <rw/sync/RWTUnlockGuard.h>
 
 
 // ...
 RWMutexLock mutex;
 
 void foo()
 {
    mutex.acquire();
 
    // ... critical code
 
    // temporarily release mutex for the duration of block:
    {
       RWTUnlockGuard<RWMutexLock> lock(mutex); // releases mutex
    
       // ... anti-critical section
 
       // Mutex will be reacquired in RWTUnlockGuard destructor.
    }
 
    // ... more critical code
 
    mutex.release();
 }
See also:
RWTLockGuard<Resource>

Constructor & Destructor Documentation

template<class Resource >
RWTUnlockGuard< Resource >::RWTUnlockGuard ( Resource &  resource  )  [inline]

Releases the resource.

template<class Resource >
RWTUnlockGuard< Resource >::~RWTUnlockGuard (  )  [inline]

Reacquires the resource.

template<class Resource>
RWTUnlockGuard< Resource >::RWTUnlockGuard ( const RWTUnlockGuard< Resource > &  second  )  [private]

Copy construction prohibited.


Member Function Documentation

template<class Resource>
RWTUnlockGuard<Resource>& RWTUnlockGuard< Resource >::operator= ( const RWTUnlockGuard< Resource > &  second  )  [private]

Assignment prohibited.


© 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.