lsst::ap::ScopedLock< MutexT > Class Template Reference

Grants access to a mutex, enforcing the RAII principle. More...

#include <Mutex.h>

Inheritance diagram for lsst::ap::ScopedLock< MutexT >:

Public Types
typedef MutexT *ScopedLock::*	UnspecifiedBool

Public Member Functions
	ScopedLock ()
	ScopedLock (MutexT &m)
	~ScopedLock ()
void	acquire (MutexT &m)
	Acquires the given Mutex. More...
bool	tryAcquire (MutexT &m)
void	release ()
bool	isAcquired () const
	operator UnspecifiedBool () const
bool	operator! () const

Private Member Functions
::pthread_mutex_t *	getPosixMutex ()

Private Attributes
MutexT *	_mutex

Friends
class	Condition< MutexT >

Detailed Description

template<typename MutexT>
class lsst::ap::ScopedLock< MutexT >

Grants access to a mutex, enforcing the RAII principle.

Definition at line 51 of file Mutex.h.

Member Typedef Documentation

template<typename MutexT>

typedef MutexT* ScopedLock::* lsst::ap::ScopedLock< MutexT >::UnspecifiedBool

Definition at line 192 of file Mutex.h.

Constructor & Destructor Documentation

template<typename MutexT>

lsst::ap::ScopedLock< MutexT >::ScopedLock ( )

inline

Definition at line 137 of file Mutex.h.

: _mutex(0) {}

template<typename MutexT>

lsst::ap::ScopedLock< MutexT >::ScopedLock ( MutexT &  m )

inlineexplicit

Definition at line 139 of file Mutex.h.

                                    : _mutex(&m) {
        m.acquire();
    }

template<typename MutexT>

lsst::ap::ScopedLock< MutexT >::~ScopedLock ( )

inline

Definition at line 143 of file Mutex.h.

                  {
        if (_mutex != 0) {
            _mutex->release();
            _mutex = 0;
        }
    }

Member Function Documentation

template<typename MutexT>

void lsst::ap::ScopedLock< MutexT >::acquire ( MutexT &  m )

inline

Acquires the given Mutex.

Definition at line 151 of file Mutex.h.

                             {
        assert(_mutex == 0);
        _mutex = &m;
        m.acquire();
    }

template<typename MutexT>

::pthread_mutex_t* lsst::ap::ScopedLock< MutexT >::getPosixMutex ( )

inlineprivate

Definition at line 206 of file Mutex.h.

                                      {
        return &(_mutex->_mutex);
    }

template<typename MutexT>

bool lsst::ap::ScopedLock< MutexT >::isAcquired ( ) const

inline

Returns true if and only if a Mutex is currently held; that is, if a Mutex was obtained via acquire(Mutex &) or tryAcquire(Mutex &) but not yet released via release().

Definition at line 187 of file Mutex.h.

                            {
        return _mutex != 0;
    }

template<typename MutexT>

lsst::ap::ScopedLock< MutexT >::operator UnspecifiedBool ( ) const

inline

Definition at line 194 of file Mutex.h.

                                     {
        return _mutex == 0 ? 0 : &ScopedLock::_mutex;
    }

template<typename MutexT>

bool lsst::ap::ScopedLock< MutexT >::operator! ( ) const

inline

Definition at line 198 of file Mutex.h.

                           {
        return _mutex == 0;
    }

template<typename MutexT>

void lsst::ap::ScopedLock< MutexT >::release ( )

inline

Releases a previously acquired Mutex.

Precondition

A Mutex was previously acquired via acquire(Mutex &) or tryAcquire(Mutex &).

Definition at line 177 of file Mutex.h.

                   {
        assert(_mutex != 0);
        _mutex->release();
        _mutex = 0;
    }

template<typename MutexT>

bool lsst::ap::ScopedLock< MutexT >::tryAcquire ( MutexT &  m )

inline

Attempts to acquire the given Mutex, returning immediately if this is not possible.

Precondition

Any previously acquired Mutex was released

Returns

true if the mutual exclusion lock was acquired, false otherwise.

Definition at line 163 of file Mutex.h.

                                {
        assert(_mutex == 0);
        if (m.tryAcquire()) {
            _mutex = &m;
            return true;
        }
        return false;
    }

Friends And Related Function Documentation

template<typename MutexT>

friend class Condition< MutexT >

friend

Definition at line 210 of file Mutex.h.

Member Data Documentation

template<typename MutexT>

MutexT* lsst::ap::ScopedLock< MutexT >::_mutex

private

Definition at line 204 of file Mutex.h.

---

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

• /lsst/home/lsstsw/stack/Linux64/ap/master-g60f1e072bb+1/include/lsst/ap/Mutex.h