RWTWriteGuardBase< Resource > Class Template Reference

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

#include <rw/sync/RWTWriteGuardBase.h>

Inheritance diagram for RWTWriteGuardBase< Resource >:

Public Member Functions
	~RWTWriteGuardBase (void)
void	acquire (void)
bool	isAcquired (void) const
void	release (void)

Protected Member Functions
	RWTWriteGuardBase (Resource &resource)
	RWTWriteGuardBase (Resource &resource, bool acquired)
Resource &	resource (void) const

Private Member Functions
	RWTWriteGuardBase (const RWTWriteGuardBase< Resource > &second)
RWTWriteGuardBase< Resource > &	operator= (const RWTWriteGuardBase< Resource > &second)

Detailed Description

template<class Resource>
class RWTWriteGuardBase< Resource >

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

See also

RWTWriteLockGuardBase, RWTWriteLockGuard, RWTWriteUnlockGuard

Constructor & Destructor Documentation

~RWTWriteGuardBase()

template<class Resource >

RWTWriteGuardBase< Resource >::~RWTWriteGuardBase

(

void

)

Destructor.

RWTWriteGuardBase() [1/3]

template<class Resource >

RWTWriteGuardBase< Resource >::RWTWriteGuardBase ( Resource & resource )

inlineprotected

Deprecated

As of SourcePro 13, use RWTWriteGuardBase(Resource&, bool) instead.

Constructs an instance with the given resource.

RWTWriteGuardBase() [2/3]

template<class Resource >

RWTWriteGuardBase< Resource >::RWTWriteGuardBase ( Resource & resource, bool acquired )

inlineprotected

Constructs an instance with the given resource. If acquired is true, the resource is assumed to be owned by the caller.

RWTWriteGuardBase() [3/3]

template<class Resource >

RWTWriteGuardBase< Resource >::RWTWriteGuardBase ( const RWTWriteGuardBase< Resource > & second )

private

Copy construction prohibited.

Member Function Documentation

acquire()

template<class Resource >

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.

isAcquired()

template<class Resource >

bool RWTWriteGuardBase< Resource >::isAcquired ( void ) const

inline

Returns true if the resource is currently acquired.

operator=()

template<class Resource >

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

private

Assignment prohibited.

release()

template<class Resource >

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

template<class Resource >

Resource & RWTWriteGuardBase< Resource >::resource ( void ) const

inlineprotected

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