RWTLockGuard<Resource>

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

RWTLockGuard<Resource>

Module: Threads Package: Synchronization


RWTLockGuard<Resource>   RWTLockGuardBase<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

RWTLockGuard()

~RWTLockGuard()

Header File

#include <rw/sync/RWTLockGuard.h>

Description

RWTLockGuard<Resource> is a guard class that acquires 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 a mutex upon creation and release it when destructed. The class used as the actual template parameter for Resource must be one that provides acquire and release methods, such as provided by the Threads Module synchronization classes.

Example

#include <rw/sync/RWMutexLock.h>
#include <rw/sync/RWTLockGuard.h>

// ...
RWMutexLock mutex;

void foo()
{  
   RWTLockGuard<RWMutexLock> lock(mutex);  // acquires mutex
   
   // ... critical section

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

Public Typedef

typedef Resource     ResourceType;

Public Constructor

RWTLockGuard(Resource& resource);

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

Public Destructor

~RWTLockGuard();

Destructor.

Private Constructor

RWTLockGuard(const RWTLockGuard<Resource>& second);

Copy construction prohibited.

Private Member Operator

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

Assignment prohibited.