xmltooling  3.0.1
xmltooling::SharedLock Class Reference

RAII wrapper for a shared lock. More...

#include <xmltooling/util/Threads.h>

Public Member Functions

 SharedLock (RWLock *lock, bool lockit=true)
 Locks and wraps the designated shared lock. More...
 
 SharedLock (const boost::scoped_ptr< RWLock > &lock, bool lockit=true)
 Locks and wraps the designated shared lock. More...
 
 ~SharedLock ()
 Unlocks the wrapped shared lock, if any.
 
RWLockrelease ()
 Releases control of the original shared lock and returns it without unlocking it. More...
 

Detailed Description

RAII wrapper for a shared lock.

Constructor & Destructor Documentation

xmltooling::SharedLock::SharedLock ( RWLock lock,
bool  lockit = true 
)
inline

Locks and wraps the designated shared lock.

Parameters
locklock to acquire
lockittrue if the lock should be acquired here, false if already acquired
xmltooling::SharedLock::SharedLock ( const boost::scoped_ptr< RWLock > &  lock,
bool  lockit = true 
)
inline

Locks and wraps the designated shared lock.

Parameters
locklock to acquire
lockittrue if the lock should be acquired here, false if already acquired

Member Function Documentation

RWLock* xmltooling::SharedLock::release ( )
inline

Releases control of the original shared lock and returns it without unlocking it.

Returns
the original shared lock

The documentation for this class was generated from the following file: