rwlogo
SourcePro C++ 12.5

SourcePro® C++ API Reference Guide

Product Documentation:

   SourcePro C++
Documentation Home

 All Classes Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
List of all members | Public Member Functions | Protected Member Functions | Private Member Functions
RWTReadLockGuardBase< T > Class Template Reference

Base class for guard classes that acquire read access to a resource upon creation and release it upon destruction. More...

#include <rw/sync/RWTReadLockGuardBase.h>

Inheritance diagram for RWTReadLockGuardBase< T >:
RWTReadGuardBase< Resource >

Public Member Functions

 ~RWTReadLockGuardBase ()
 
- Public Member Functions inherited from RWTReadGuardBase< Resource >
 ~RWTReadGuardBase ()
 
void acquire ()
 
bool isAcquired () const
 
void release ()
 

Protected Member Functions

 RWTReadLockGuardBase (Resource &resource)
 
- Protected Member Functions inherited from RWTReadGuardBase< Resource >
 RWTReadGuardBase (Resource &resource)
 
Resource & resource () const
 

Private Member Functions

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

Detailed Description

template<class T>
class RWTReadLockGuardBase< T >

RWTReadLockGuardBase<Resource> is a base class for guard classes that acquire read access on a resource upon creation and release it upon destruction. Guard objects work in conjunction with block statements 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 template parameter Resource must be one that provides acquireRead() and release() methods, such as the synchronization classes provided in this module.

See Also
RWTReadLockGuard<Resource> , RWTTryReadLockGuard<Resource> , RWTReadUnlockGuard<Resource>

Constructor & Destructor Documentation

template<class T>
RWTReadLockGuardBase< T >::~RWTReadLockGuardBase ( )

Releases the resource if it has been acquired.

template<class T>
RWTReadLockGuardBase< T >::RWTReadLockGuardBase ( Resource &  resource)
protected

Constructs an instance with the given resource. Note that this constructor does not attempt to acquire read access on the resource. That is the responsibility of the derived class.

template<class T>
RWTReadLockGuardBase< T >::RWTReadLockGuardBase ( const RWTReadLockGuardBase< Resource > &  second)
private

Copy construction prohibited.

Member Function Documentation

template<class T>
RWTReadLockGuardBase<Resource>& RWTReadLockGuardBase< T >::operator= ( const RWTReadLockGuardBase< 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.
Provide feedback to Rogue Wave about its documentation.