RWTWriteGuardBase<Resource>

Module:  Threads   Package:  Synchronization

Base Class

• Local Index
• Header File
• Description
• Public Typedef
• Public Destructor
• Public Member Functions
• Protected Constructors
• Protected Member Function
• Private Constructor
• Private Member Operators
• See Also

Members

acquire() isAcquired()

operator=() release()

resource() ResourceType

RWTWriteGuardBase() ~RWTWriteGuardBase()

#include <rw/sync/RWTWriteGuardBase.h> 

RWTWriteGuardBase<Resource> is intended as 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 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 for writing upon creation and release it when destructed. The class used as the actual template parameter for Resource must be one that provides acquireWrite and release methods (such as the synchronization classes provided in this module).

typedef Resource     ResourceType;

~RWTWriteGuardBase();

Destructor.

void
acquire();

Acquires write access on the resource held by the guard unless it is already acquired. Uses this function instead of directly manipulating the resource so that the guard will automatically release or acquire it (as appropriate).

bool
isAcquired() const;

Returns true if the resource is currently acquired.

void
release();

Releases the resource held by the guard if it has been acquired. Uses this function instead of directly manipulating the resource so that the guard will automatically release or acquire it (as appropriate).

RWTWriteGuardBase(Resource& resource);

Constructs an instance with the given resource.

Resource&
resource() const;

Returns a reference to the resource currently held by the guard.

RWTWriteGuardBase(const RWTWriteGuardBase<Resource>& second);

Copy construction prohibited.

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

Assignment prohibited.

RWTWriteLockGuardBase<Resource>, RWTWriteLockGuard<Resource>, RWTTryWriteLockGuard<Resource>, RWTWriteUnlockGuard<Resource>

© 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.