Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
OSMutex Class Reference

This class provides a mutex API. More...

#include <OS.hxx>

Public Member Functions

 OSMutex (bool recursive=false)
 Initialize a mutex.
 
void lock ()
 Lock a mutex.
 
void unlock ()
 Unlock a mutex.
 
 ~OSMutex ()
 Destructor.
 

Private Member Functions

 DISALLOW_COPY_AND_ASSIGN (OSMutex)
 

Private Attributes

os_mutex_t handle
 Private mutex handle.
 

Friends

class OSMutexLock
 

Detailed Description

This class provides a mutex API.

Definition at line 426 of file OS.hxx.

Constructor & Destructor Documentation

◆ OSMutex()

OSMutex::OSMutex ( bool  recursive = false)
inline

Initialize a mutex.

Parameters
recursivefalse creates a normal mutex, true creates a recursive mutex

Definition at line 432 of file OS.hxx.

◆ ~OSMutex()

OSMutex::~OSMutex ( )
inline

Destructor.

Definition at line 459 of file OS.hxx.

Member Function Documentation

◆ lock()

void OSMutex::lock ( )
inline

Lock a mutex.

Definition at line 446 of file OS.hxx.

◆ unlock()

void OSMutex::unlock ( )
inline

Unlock a mutex.

Definition at line 453 of file OS.hxx.

Friends And Related Symbol Documentation

◆ OSMutexLock

friend class OSMutexLock
friend

Definition at line 467 of file OS.hxx.

Member Data Documentation

◆ handle

os_mutex_t OSMutex::handle
private

Private mutex handle.

Definition at line 469 of file OS.hxx.


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