SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
Base class for guard classes that support read access to a given section of code. More...
#include <rw/sync/RWTReadGuardBase.h>
Public Member Functions | |
~RWTReadGuardBase () | |
void | acquire () |
bool | isAcquired () const |
void | release () |
Protected Member Functions | |
RWTReadGuardBase (Resource &resource) | |
Resource & | resource () const |
Private Member Functions | |
RWTReadGuardBase (const RWTReadGuardBase< Resource > &second) | |
RWTReadGuardBase< Resource > & | operator= (const RWTReadGuardBase< Resource > &second) |
RWTReadGuardBase<Resource> is a base class for guard classes that support read access to a given section of code.
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 a mutex for reading 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.
RWTReadGuardBase< Resource >::~RWTReadGuardBase | ( | ) | [inline] |
Destructor.
RWTReadGuardBase< Resource >::RWTReadGuardBase | ( | Resource & | resource | ) | [inline, protected] |
Constructs an instance with the given resource.
RWTReadGuardBase< Resource >::RWTReadGuardBase | ( | const RWTReadGuardBase< Resource > & | second | ) | [private] |
Copy construction prohibited.
void RWTReadGuardBase< Resource >::acquire | ( | void | ) | [inline] |
Acquires read access on the resource held by the guard unless access has already been acquired. Use this function rather than manipulating the resource directly so the guard will automatically release or acquire access (as appropriate).
bool RWTReadGuardBase< Resource >::isAcquired | ( | ) | const [inline] |
Returns true
if the resource is currently acquired.
RWTReadGuardBase<Resource>& RWTReadGuardBase< Resource >::operator= | ( | const RWTReadGuardBase< Resource > & | second | ) | [private] |
Assignment prohibited.
void RWTReadGuardBase< Resource >::release | ( | void | ) | [inline] |
Releases the resource held by the guard if it has been acquired. Use this function rather than manipulating the resource directly so the guard will automatically release or acquire access (as appropriate).
Resource & RWTReadGuardBase< Resource >::resource | ( | ) | const [inline, protected] |
Returns a reference to the resource currently held by the guard.
© 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.
Contact Rogue Wave about documentation or support issues.