F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Loading...
Searching...
No Matches
Os::Mutex Class Referencefinal

#include <Os/Mutex.hpp>

Inheritance diagram for Os::Mutex:
Os::MutexInterface

Public Member Functions

 Mutex ()
 Constructor. Mutex is unlocked when created.
 
 ~Mutex () final
 Destructor.
 
MutexHandlegetHandle () override
 return the underlying mutex handle (implementation specific)
 
Status take () override
 lock the mutex and get return status
 
Status release () override
 unlock the mutex and get return status
 
void lock ()
 lock the mutex and assert success
 
void unLock ()
 unlock the mutex and assert success
 
void unlock ()
 alias for unLock to meet BasicLockable requirements
 
- Public Member Functions inherited from Os::MutexInterface
 MutexInterface ()=default
 default constructor
 
virtual ~MutexInterface ()=default
 default virtual destructor
 
 MutexInterface (const MutexInterface &other)=delete
 copy constructor is forbidden
 
 MutexInterface (const MutexInterface *other)=delete
 copy constructor is forbidden
 
MutexInterfaceoperator= (const MutexInterface &other)=delete
 assignment operator is forbidden
 

Additional Inherited Members

- Public Types inherited from Os::MutexInterface
enum  Status { OP_OK , ERROR_BUSY , ERROR_DEADLOCK , ERROR_OTHER }
 
- Static Public Member Functions inherited from Os::MutexInterface
static MutexInterfacegetDelegate (MutexHandleStorage &aligned_new_memory)
 provide a pointer to a Mutex delegate object
 

Detailed Description

Definition at line 50 of file Mutex.hpp.

Constructor & Destructor Documentation

◆ Mutex()

Os::Mutex::Mutex ( )

Constructor. Mutex is unlocked when created.

Definition at line 10 of file Mutex.cpp.

◆ ~Mutex()

Os::Mutex::~Mutex ( )
final

Destructor.

Definition at line 14 of file Mutex.cpp.

Member Function Documentation

◆ getHandle()

MutexHandle * Os::Mutex::getHandle ( )
overridevirtual

return the underlying mutex handle (implementation specific)

Returns
internal mutex handle representation

Implements Os::MutexInterface.

Definition at line 19 of file Mutex.cpp.

◆ lock()

void Os::Mutex::lock ( )

lock the mutex and assert success

Definition at line 34 of file Mutex.cpp.

◆ release()

Mutex::Status Os::Mutex::release ( )
overridevirtual

unlock the mutex and get return status

Implements Os::MutexInterface.

Definition at line 29 of file Mutex.cpp.

◆ take()

Mutex::Status Os::Mutex::take ( )
overridevirtual

lock the mutex and get return status

Implements Os::MutexInterface.

Definition at line 24 of file Mutex.cpp.

◆ unLock()

void Os::Mutex::unLock ( )

unlock the mutex and assert success

Definition at line 40 of file Mutex.cpp.

◆ unlock()

void Os::Mutex::unlock ( )
inline

alias for unLock to meet BasicLockable requirements

Definition at line 63 of file Mutex.hpp.


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