SourcePro 11.1 |
SourcePro® C++ API Reference Guide |
SourcePro C++ Documentation Home |
Base class for guard classes. More...
#include <rw/sync/RWTGuardBase.h>
Public Member Functions | |
~RWTGuardBase () | |
void | acquire () |
bool | isAcquired () const |
void | release () |
Protected Member Functions | |
RWTGuardBase (Resource &resource) | |
Resource & | resource () const |
Private Member Functions | |
RWTGuardBase (const RWTGuardBase< Resource > &second) | |
RWTGuardBase & | operator= (const RWTGuardBase< Resource > &second) |
RWTGuardBase<Resource> is intended as a base class for guard classes. 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 the synchronization classes provided in this module.
RWTGuardBase< Resource >::~RWTGuardBase | ( | ) | [inline] |
Destructor.
RWTGuardBase< Resource >::RWTGuardBase | ( | Resource & | resource | ) | [inline, protected] |
Constructs an instance with the given resource.
RWTGuardBase< Resource >::RWTGuardBase | ( | const RWTGuardBase< Resource > & | second | ) | [private] |
Dummy copy constructor, required by derived class copy constructors. The copy constructor does not attempt to copy the resource.
void RWTGuardBase< Resource >::acquire | ( | void | ) | [inline] |
Acquires the resource held by the guard unless it is already acquired. Use this function instead of directly manipulating the resource so that the guard will automatically release or acquire it (as appropriate).
bool RWTGuardBase< Resource >::isAcquired | ( | ) | const [inline] |
Returns true if the resource is currently acquired.
RWTGuardBase& RWTGuardBase< Resource >::operator= | ( | const RWTGuardBase< Resource > & | second | ) | [private] |
Assignment prohibited.
void RWTGuardBase< 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 will automatically release or acquire it (as appropriate).
Resource & RWTGuardBase< 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.