Cpl::System::GlobalLock Class Reference

This class defines an interface for a "Global Lock". More...

Detailed Description

This class defines an interface for a "Global Lock".

A Global Lock provides mutual exclusion and/or a critical section protection similar to a Mutex except that is it intended to be lighter weight and/or have faster performance than a traditional Mutex. However, the performance gain comes with the following constraints:

o Non recursive semantics.  The calling thread CANNOT attempt to acquire
  the lock a second time once it has already acquire the lock.

o The code that is protected by this lock MUST BE VERY SHORT time
  wise and NOT call an operating system methods (e.g. any Cpl::System
  methods).

Why the above the constraints? The GlobalLock interface is intended to be an abstraction for disable/enable interrupts when running on a RTOS platform. So, use GlobalLocks with care and always honor the above constraints.

#include <GlobalLock.h>

Static Public Member Functions
static void	begin (void)
	This method is invoked prior to entering a critical section.
static void	end (void)
	This method is invoke at the end of a critical section.

Member Function Documentation

begin()

static void Cpl::System::GlobalLock::begin ( void  )

static

This method is invoked prior to entering a critical section.

If another thread currently "owns" the lock, the current thread will "wait" until it can obtain ownership before proceeding.

end()

static void Cpl::System::GlobalLock::end ( void  )

static

This method is invoke at the end of a critical section.

This call will release the ownership of the lock.

---

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

• Cpl/System/GlobalLock.h