PikeAero::CMutexLock Class Reference

#include <cmutexlock.h>

Collaboration diagram for PikeAero::CMutexLock:

[legend]

Public Member Functions
	CMutexLock (CMutex *mutex=NULL)
void	lock (CMutex *mutex=NULL)
bool	tryLock (CMutex *mutex=NULL)
void	unlock (CMutex *mutex=NULL)
	~CMutexLock ()
Private Attributes
CMutex *	mMutex

---

Detailed Description

Implements a mutually exclusive (MUTEX) locking function.

Author:

Michael Sharkey <mike@pikeaero.com>

Definition at line 32 of file cmutexlock.h.

---

Constructor & Destructor Documentation

PikeAero::CMutexLock::CMutexLock

(

CMutex *

mutex = NULL

)

Definition at line 27 of file cmutexlock.cpp.

References lock(), and mMutex.

: mMutex(mutex)
{
    if ( mMutex != NULL )
    {
        lock();
    }
}

Here is the call graph for this function:

PikeAero::CMutexLock::~CMutexLock

(

)

Definition at line 36 of file cmutexlock.cpp.

References unlock().

{
    unlock();
}

Here is the call graph for this function:

---

Member Function Documentation

void PikeAero::CMutexLock::lock

(

CMutex *

mutex = NULL

)

Definition at line 41 of file cmutexlock.cpp.

References disableInterrupts, interruptsEnabled, PikeAero::CMutex::mLocked, mMutex, setInterrupts, and PikeAero::CTaskScheduler::yield().

Referenced by CMutexLock().

{
    if ( mutex != NULL ) mMutex = mutex;
    if ( mMutex != NULL )
    {
        bool gotLock=false;
        while ( !gotLock )
        {
            CTaskScheduler::yield();
            bool irqState = interruptsEnabled();
            disableInterrupts();
            if ( !mMutex->mLocked )
            {
                mMutex->mLocked = true;
                gotLock=true;
            }
            setInterrupts(irqState);
        }
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool PikeAero::CMutexLock::tryLock

(

CMutex *

mutex = NULL

)

Definition at line 71 of file cmutexlock.cpp.

References PikeAero::CMutex::mLocked, and mMutex.

{
    if ( mutex != NULL ) mMutex = mutex;
    if ( mMutex != NULL )
    {
        return mMutex->mLocked;
    }
    return false;
}

void PikeAero::CMutexLock::unlock

(

CMutex *

mutex = NULL

)

Definition at line 62 of file cmutexlock.cpp.

References PikeAero::CMutex::mLocked, and mMutex.

Referenced by ~CMutexLock().

{
    if ( mutex != NULL ) mMutex = mutex;
    if ( mMutex != NULL )
    {
        mMutex->mLocked = false;
    }
}

Here is the caller graph for this function:

---

Field Documentation

CMutex* PikeAero::CMutexLock::mMutex [private]

Definition at line 43 of file cmutexlock.h.

Referenced by CMutexLock(), lock(), tryLock(), and unlock().

---

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

• cmutexlock.h
• cmutexlock.cpp