RWTReadUnlockGuard<Resource>

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

RWTReadUnlockGuard<Resource>

Module: Threads Package: Synchronization


RWTReadUnlockGuard<Resource>   RWTReadGuardBase<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

RWTReadUnlockGuard()

Header File

#include <rw/sync/RWTReadUnlockGuard.h>

Description

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

Example

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

// ...
RWReadersWriterLock rwlock;

void foo()
{
   rwlock.acquireRead();
   // ... critical code

   // temporarily release readers-writer lock 
   // for duration of block:
   {  
      // constructor releases lock:   
      RWTReadUnlockGuard<RWReadersWriterLock> lock(rwlock);  
   
      // ... anti-critical section
      // lock will be reacquired for reading in 
      //   RWTReadUnlockGuard destructor.
   }
   // ... more critical code
   rwlock.release();
}

Public Typedef

typedef Resource     ResourceType;

Public Constructor

RWTReadUnlockGuard(Resource& resource);

Releases the resource.

Public Destructor

~RWTReadUnlockGuard();

Reacquires read access on the resource.

Private Constructor

RWTReadUnlockGuard(const RWTReadUnlockGuard<Resource>& second);

Copy construction prohibited.

Private Member Operator

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

Assignment prohibited.