mbo::CLockSingle Class Reference

Single-Lock implementation. More...

#include <MboSynch.h>

Inheritance diagram for mbo::CLockSingle:

[legend]

Collaboration diagram for mbo::CLockSingle:

[legend]

List of all members.

Public Member Functions
	CLockSingle (const ICriticalSection *pmx)
	CLockSingle (const CLockSingle &lx)
virtual	~CLockSingle ()
virtual void	Enter () const
virtual void	Leave () const
virtual unsigned long	GetLevel () const

---

Detailed Description

Single-Lock implementation.

This Lock automatically calls Enter() upon creation and Leave() in destruction.

Note:

This class is distributed under the following license GNU Lesser General Public License, version 2.1.

Definition at line 445 of file MboSynch.h.

---

Constructor & Destructor Documentation

mbo::CLockSingle::CLockSingle

(

const ICriticalSection *

pmx

)

[inline, explicit]

constructor to allow selective call to Enter()

/*! default constructor which directly calls Enter()

Parameters:

pmx

Mutex to use for Lock

Definition at line 456 of file MboSynch.h.

        : m_pmx(pmx)
    {
        assert(pmx);
        Enter();
    }

mbo::CLockSingle::CLockSingle

(

const CLockSingle &

lx

)

[inline, explicit]

copy constructor

Ensure the lock is entered since the destructor will call Leave().

Definition at line 469 of file MboSynch.h.

        : m_pmx(lx.m_pmx)
    {
        Enter();
    }

virtual mbo::CLockSingle::~CLockSingle

(

)

[inline, virtual]

destructor

Definition at line 479 of file MboSynch.h.

    {
        Leave();
    }

---

Member Function Documentation

virtual void mbo::CLockSingle::Enter

(

)

const [inline, virtual]

enter the Lock

Implements mbo::ILock.

Definition at line 486 of file MboSynch.h.

    {
        m_pmx->Enter();
    }

virtual void mbo::CLockSingle::Leave

(

)

const [inline, virtual]

leave the Lock

Implements mbo::ILock.

Definition at line 493 of file MboSynch.h.

    {
        m_pmx->Leave();
    }

virtual unsigned long mbo::CLockSingle::GetLevel

(

)

const [inline, virtual]

Returns:

Number of times CriticalSection/Mutex is entered

Note:

This is only valie when the CriticalSection/Mutex is owned by the current thread.

This may not be correctly available in which case 1 is returned to signal Enter state.

Implements mbo::ILock.

Definition at line 499 of file MboSynch.h.

    {
        return m_pmx->GetLevel();
    }

---

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

• MboSynch.h

---