SourcePro C++ 12.0 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
A base class for guard classes that support write access to a given section of code. More...
#include <rw/sync/RWTWriteGuardBase.h>
Public Member Functions | |
~RWTWriteGuardBase () | |
void | acquire () |
bool | isAcquired () const |
void | release () |
Protected Member Functions | |
RWTWriteGuardBase (Resource &resource) | |
Resource & | resource () const |
Private Member Functions | |
RWTWriteGuardBase (const RWTWriteGuardBase< Resource > &second) | |
RWTWriteGuardBase< Resource > & | operator= (const RWTWriteGuardBase< Resource > &second) |
RWTWriteGuardBase<Resource> is a base class for guard classes that need to support write 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 writing when created and release it when destructed.
The class used as the actual template parameter for Resource
must provide acquireWrite
() and release
() methods, such as the synchronization classes in this module.
RWTWriteGuardBase< Resource >::~RWTWriteGuardBase | ( | ) | [inline] |
Destructor.
RWTWriteGuardBase< Resource >::RWTWriteGuardBase | ( | Resource & | resource | ) | [inline, protected] |
Constructs an instance with the given resource.
RWTWriteGuardBase< Resource >::RWTWriteGuardBase | ( | const RWTWriteGuardBase< Resource > & | second | ) | [private] |
Copy construction prohibited.
void RWTWriteGuardBase< Resource >::acquire | ( | void | ) | [inline] |
Acquires write access on the resource held by the guard unless it is already acquired. Use this function instead of directly manipulating the resource so that the guard automatically releases or acquires it, as appropriate.
bool RWTWriteGuardBase< Resource >::isAcquired | ( | ) | const [inline] |
Returns true if the resource is currently acquired.
RWTWriteGuardBase<Resource>& RWTWriteGuardBase< Resource >::operator= | ( | const RWTWriteGuardBase< Resource > & | second | ) | [private] |
Assignment prohibited.
void RWTWriteGuardBase< Resource >::release | ( | void | ) | [inline] |
Releases the resource held by the guard if it has been acquired. Use this function instead of directly manipulating the resource so that the guard automatically releases or acquires it, as appropriate.
Resource & RWTWriteGuardBase< 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.