mbo::LockedVar< _Ty, _THREAD_MODEL > Class Template Reference

locked variable More...

#include <MboLockedVar.h>

Collaboration diagram for mbo::LockedVar< _Ty, _THREAD_MODEL >:

[legend]

List of all members.

Public Member Functions
	LockedVar ()
	locked variable
	LockedVar (const _Ty &tIn)
	operator _Ty ()
	operator const _Ty () const
_Ty &	operator * ()
const _Ty &	operator * () const
const _Ty &	operator= (const _Ty &tIn)
_Ty	__exchange (const _Ty &tIn)
mbo::CLock	__getLock () const
Protected Attributes
_Ty	m_val

---

Detailed Description

template<class _Ty, class _THREAD_MODEL = ThreadModel>
class mbo::LockedVar< _Ty, _THREAD_MODEL >

locked variable

LockedVar is used to define locked variables (mostly class members) that are guarded by a mutex. These variables can be accessed by copy only since that is needed to ensure the lock mechanism. If you need locked members and gain reference access to them you'll need to define a separate mutex or lock and have no need for this LockVar type.

Definition at line 59 of file MboLockedVar.h.

---

Constructor & Destructor Documentation

template<class _Ty, class _THREAD_MODEL = ThreadModel>

mbo::LockedVar< _Ty, _THREAD_MODEL >::LockedVar

(

)

[inline]

locked variable

Default Constructor

Definition at line 76 of file MboLockedVar.h.

        : m_val()
    {
    }

template<class _Ty, class _THREAD_MODEL = ThreadModel>

mbo::LockedVar< _Ty, _THREAD_MODEL >::LockedVar

(

const _Ty &

tIn

)

[inline]

Standrad Constructor

Parameters:

tIn

initial value

Definition at line 84 of file MboLockedVar.h.

        : m_val(tIn)
    {
    }

---

Member Function Documentation

template<class _Ty, class _THREAD_MODEL = ThreadModel>

mbo::LockedVar< _Ty, _THREAD_MODEL >::operator _Ty

(

)

[inline]

access to locked value (a copy is returned)

Returns:

not locked copy of the value

Note:

This returns a copy because returning a reference would bypass locking.

Definition at line 94 of file MboLockedVar.h.

References mbo::LockedVar< _Ty, _THREAD_MODEL >::m_val.

    {
        Lock lock(&m_mx);
        return m_val;
    }

template<class _Ty, class _THREAD_MODEL = ThreadModel>

mbo::LockedVar< _Ty, _THREAD_MODEL >::operator const _Ty

(

)

const [inline]

const access to locked value (a const copy is returned)

Returns:

not locked const copy of the value

Note:

This returns a copy because returning a reference would bypass locking.

Definition at line 105 of file MboLockedVar.h.

References mbo::LockedVar< _Ty, _THREAD_MODEL >::m_val.

    {
        Lock lock(&m_mx);
        return m_val;
    }

template<class _Ty, class _THREAD_MODEL = ThreadModel>

_Ty& mbo::LockedVar< _Ty, _THREAD_MODEL >::operator *

(

)

[inline]

Returns:

non const access to locked value

Definition at line 113 of file MboLockedVar.h.

References mbo::LockedVar< _Ty, _THREAD_MODEL >::m_val.

    {
        Lock lock(&m_mx);
        return m_val;
    }

template<class _Ty, class _THREAD_MODEL = ThreadModel>

const _Ty& mbo::LockedVar< _Ty, _THREAD_MODEL >::operator *

(

)

const [inline]

Returns:

const access to locked value

Definition at line 121 of file MboLockedVar.h.

References mbo::LockedVar< _Ty, _THREAD_MODEL >::m_val.

    {
        Lock lock(&m_mx);
        return m_val;
    }

template<class _Ty, class _THREAD_MODEL = ThreadModel>

const _Ty& mbo::LockedVar< _Ty, _THREAD_MODEL >::operator=

(

const _Ty &

tIn

)

[inline]

assignment

Parameters:

tIn

new value

Note:

This returns a reference to the input. It is not feasible to return the value itself. A copy would be to slow and a reference would bypass locking.

Definition at line 133 of file MboLockedVar.h.

References mbo::LockedVar< _Ty, _THREAD_MODEL >::m_val.

    {
        Lock lock(&m_mx);
        m_val = tIn;
        return tIn; /* tIn not t */
    }

template<class _Ty, class _THREAD_MODEL = ThreadModel>

_Ty mbo::LockedVar< _Ty, _THREAD_MODEL >::__exchange

(

const _Ty &

tIn

)

[inline]

value exchangement

Parameters:

tIn

the new value

Returns:

the old value

Definition at line 145 of file MboLockedVar.h.

References mbo::LockedVar< _Ty, _THREAD_MODEL >::m_val.

    {
        Lock lock(&m_mx);
        T tOld(m_val);
        m_val = tIn;
        return tOld; /* the old value */
    }

template<class _Ty, class _THREAD_MODEL = ThreadModel>

mbo::CLock mbo::LockedVar< _Ty, _THREAD_MODEL >::__getLock

(

)

const [inline]

Returns:

Lock for variable

Definition at line 155 of file MboLockedVar.h.

    {
        return mbo::CLockSingle(&m_mx);
    }

---

Member Data Documentation

template<class _Ty, class _THREAD_MODEL = ThreadModel>

_Ty mbo::LockedVar< _Ty, _THREAD_MODEL >::m_val [protected]

Definition at line 70 of file MboLockedVar.h.

Referenced by mbo::LockedVar< bool >::__exchange(), mbo::LockedVar< _Ty, _THREAD_MODEL >::__exchange(), mbo::LockedVar< bool >::operator *(), mbo::LockedVar< _Ty, _THREAD_MODEL >::operator *(), mbo::LockedVar< bool >::operator _Ty(), mbo::LockedVar< _Ty, _THREAD_MODEL >::operator _Ty(), mbo::LockedVar< bool >::operator const _Ty(), mbo::LockedVar< _Ty, _THREAD_MODEL >::operator const _Ty(), mbo::LockedVar< bool >::operator=(), and mbo::LockedVar< _Ty, _THREAD_MODEL >::operator=().

---

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

• MboLockedVar.h

---