RWTGuardBase<Resource>

Threads Module Reference Guide
Rogue Wave web site: Home Page | Main Documentation Page

RWTGuardBase<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 Constructors
Private Member Operator
See Also

Local Index

Members

acquire()
isAcquired()

operator=()
release()

resource()
ResourceType

RWTGuardBase()
~RWTGuardBase()

Header File

#include <rw/sync/RWTGuardBase.h>

Description

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.

Public Typedef

typedef Resource     ResourceType;

Public Destructor

~RWTGuardBase();

Destructor.

Public Member Functions

void
acquire();

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
isAcquired() const;

Returns true if the resource is currently acquired.

void
release();

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

Protected Constructors

RWTGuardBase(Resource& resource);

Constructs an instance with the given resource.

Protected Member Function

Resource&
resource() const;

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

Private Constructors

RWTGuardBase(const RWTGuardBase<Resource>& second);

Dummy copy constructor, required by derived class copy constructors. The copy constructor does not attempt to copy the resource.

Private Member Operator

RWTGuardBase&
operator=(const RWTGuardBase<resource>& second);

Assignment prohibited.