RWTTryLockGuard< Resource > Class Template Reference

Guard class that tries to acquire its resource upon creation and release it upon destruction. More...

#include <rw/sync/RWTTryLockGuard.h>

Inheritance diagram for RWTTryLockGuard< Resource >:

Public Member Functions
	RWTTryLockGuard (Resource &resource)
	~RWTTryLockGuard ()
bool	tryAcquire ()
Public Member Functions inherited from RWTLockGuardBase< Resource >
	~RWTLockGuardBase ()
Public Member Functions inherited from RWTGuardBase< Resource >
	~RWTGuardBase ()
void	acquire ()
bool	isAcquired () const
void	release ()

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

Additional Inherited Members
Protected Member Functions inherited from RWTLockGuardBase< Resource >
	RWTLockGuardBase (Resource &resource)
	RWTLockGuardBase (Resource &resource, bool acquired)
Protected Member Functions inherited from RWTGuardBase< Resource >
	RWTGuardBase (Resource &resource)
	RWTGuardBase (Resource &resource, bool acquired)
Resource &	resource () const

Detailed Description

template<class Resource>
class RWTTryLockGuard< Resource >

RWTTryLockGuard is a guard class that tries to acquire its resource upon creation and, if successful, release it upon destruction. 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 when created and release it when destructed. The class used as the actual template parameter for Resource must be one that provides tryAcquire() and release() methods, such as some synchronization classes provided in this module.

Example

#include <rw/sync/RWMutexLock.h>
#include <rw/sync/RWTTryLockGuard.h>

RWMutexLock mutex;

bool foo()
{
    // ...
    {
        // try to acquire mutex:
        RWTTryLockGuard<RWMutexLock> lock(mutex);

        // See if the mutex was acquired:
        if (!lock.isAcquired()) {
            return false;     // Can't get lock,
            // give up and return error
        }
        // ... critical section

        // Mutex will be released in RWTTryLockGuard destructor
        // before leaving scope, especially important
        // if an exception might be thrown!
    }

    // ...
    return true;
}

See also

RWTLockGuard, RWTUnlockGuard

Constructor & Destructor Documentation

template<class Resource >

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

inline

Constructs an instance with the given resource and attempts to acquire that resource. Use the inherited isAcquired() member function to see if the acquisition was successful.

template<class Resource >

RWTTryLockGuard< Resource >::~RWTTryLockGuard ( )

inline

Destructor.

template<class Resource>

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

private

Copy construction prohibited.

Member Function Documentation

template<class Resource>

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

private

Assignment prohibited.

template<class Resource >

bool RWTTryLockGuard< Resource >::tryAcquire ( )

inline

Tries again to acquire the resource. Use this function instead of manipulating the resource directly so the guard will automatically release it.