RWTWriteUnlockGuard<Resource>

Threads Module Reference Guide
Rogue Wave web site: Home Page | Main Documentation Page

RWTWriteUnlockGuard<Resource>

Module: Threads Package: Synchronization


RWTWriteUnlockGuard<Resource>   RWTWriteGuardBase<Resource>

Local Index
Header File
Description
Example
Public Typedef
Public Constructor
Public Destructor
Private Constructor
Private Member Operator
See Also

Local Index

Members

operator=()

ResourceType

RWTWriteUnlockGuard()

~RWTWriteUnlockGuard()

Header File

#include <rw/sync/RWTWriteUnlockGuard.h>

Description

RWTWriteUnlockGuard<Resource> is a guard class that releases its resource upon creation and acquires write access on its resource 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 write access on a mutex upon creation and reacquire write access on that mutex when destructed. The class used as the actual template parameter for Resource must be one that provides acquireWrite and release methods such as the synchronization classes provided in this module.

Example

#include <rw/sync/RWReadersWriterLock.h>
#include <rw/sync/RWTWriteUnlockGuard.h>

// ...
RWReadersWriterLock rwlock;
void foo()
{
   rwlock.acquireWrite();

   // ... critical code

   // temporarily release readers-writer lock 
   // for duration of block:
   {  
      // constructor releases lock:   
      RWTWriteUnlockGuard<RWReadersWriterLock> lock(rwlock);  
   
      // ... anti-critical section

      // lock will be reacquired for writing in 
      // RWTWriteUnlockGuard destructor.
   }
   // ... more critical code
   rwlock.release();
}

Public Typedef

typedef Resource     ResourceType;

Public Constructor

RWTWriteUnlockGuard(Resource& resource);

Releases the resource.

Public Destructor

~RWTWriteUnlockGuard();

Reacquires write access on the resource.

Private Constructor

RWTWriteUnlockGuard(const RWTWriteUnlockGuard<Resource>&
                   second);

Copy construction prohibited.

Private Member Operator

RWTWriteUnlockGuard<Resource>&
operator=(const RWTWriteUnlockGuard<Resource>& second);

Assignment prohibited.