NetBurner 3.3.8a
PDF Version
OSLockAndCritObj Class Reference

A simple wrapper class that helps utilize OS_CRIT objects to lock tasks and enter critical sections more effectively. More...

#include <nbrtos.h>

Public Member Functions

 OSLockAndCritObj (OS_CRIT &ocrit)
 Initialize the OSCriticalSectionObj object, and then call LockAndEnter() on the OS_CRIT object that is passed in. More...
 
 ~OSLockAndCritObj ()
 Call LeaveAndUnlock() on the OSCriticalSectionObj object, then destruct.
 

Detailed Description

A simple wrapper class that helps utilize OS_CRIT objects to lock tasks and enter critical sections more effectively.

When an OSCriticalSectionObj is constructed it calls LockAndEnter() on the OS_CRIT object that is passed in, and will wait indefinitely to claim the section. When the object is deconstructed, it calls LeaveAndUnlock() on the OS_CRIT object.

See also
OS_CRIT::LockAndEnter()
OS_CRIT::LeaveAndUnlock()

Constructor & Destructor Documentation

◆ OSLockAndCritObj()

OSLockAndCritObj::OSLockAndCritObj ( OS_CRIT ocrit)
inline

Initialize the OSCriticalSectionObj object, and then call LockAndEnter() on the OS_CRIT object that is passed in.

Parameters
ocritThe object that will be used to enter and leave the critical section.

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