RWTReadLockGuard<Resource>

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

RWTReadLockGuard<Resource>

Module: Threads Package: Synchronization


RWTReadLockGuard<Resource>   RWTReadLockGuardBase<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

RWTReadLockGuard()

~RWTReadLockGuard()

Header File

#include <rw/sync/RWTReadLockGuard.h>

Description

RWTReadLockGuard<Resource> is a guard class that acquires read access on its resource upon creation and releases 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 acquire read access on a mutex upon creation and release it 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/RWTReadLockGuard.h>

// ...
RWReadersWriterLock rwlock;

void foo()
{  
   // acquire read access:
   RWTReadLockGuard<RWReaderWritersLock> lock(rwlock);   
  
   // ... critical section

   // lock will be released in RWTReadLockGuard destructor 
   // before leaving scope, especially important if an exception
   // might be thrown!
}

Public Typedef

typedef Resource     ResourceType;

Public Constructor

RWTReadLockGuard(Resource& resource);

Constructs an instance with the given resource and acquires read access on that resource. (The resource will be released in the destructor of the base class.)

Public Destructor

~RWTReadLockGuard();

Destructor.

Private Constructor

RWTReadLockGuard(const RWTReadLockGuard<Resource>& second);

Copy constructor prohibited.

Private Member Operator

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

Assignment prohibited.