RWTReadGuardBase< Resource > Class Template Reference
[Synchronization]

A base class for guard classes that support read access to a given section of code. More...

#include <rw/sync/RWTReadGuardBase.h>

Inheritance diagram for RWTReadGuardBase< Resource >:

List of all members.

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)

---

Detailed Description

template<class Resource>
class RWTReadGuardBase< Resource >

RWTReadGuardBase<Resource> is intended as a base class for guard classes that support read 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 reading upon creation and release it when destructed. The class used as the actual template parameter for Resource must be one that provides acquireRead and release methods such as the synchronization classes provided in this module.

See also:

RWTReadLockGuardBase<Resource> RWTReadUnlockGuard<Resource>

---

Constructor & Destructor Documentation

template<class Resource >

RWTReadGuardBase< Resource >::~RWTReadGuardBase

(

)

[inline]

Destructor.

template<class Resource >

RWTReadGuardBase< Resource >::RWTReadGuardBase

(

Resource &

resource

)

[inline, protected]

Constructs an instance with the given resource.

template<class Resource >

RWTReadGuardBase< Resource >::RWTReadGuardBase

(

const RWTReadGuardBase< Resource > &

second

)

[private]

Copy construction prohibited.

---

Member Function Documentation

template<class Resource >

void RWTReadGuardBase< Resource >::acquire

(

void

)

[inline]

Acquires read 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 will automatically release or acquire it (as appropriate).

template<class Resource >

bool RWTReadGuardBase< Resource >::isAcquired

(

)

const [inline]

Returns true if the resource is currently acquired.

template<class Resource >

RWTReadGuardBase<Resource>& RWTReadGuardBase< Resource >::operator=

(

const RWTReadGuardBase< Resource > &

second

)

[private]

Assignment prohibited.

template<class Resource >

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

template<class Resource >

Resource & RWTReadGuardBase< Resource >::resource

(

)

const [inline, protected]

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