F´ Flight Software - C/C++ Documentation
A framework for building embedded system applications to NASA flight quality standards.
Public Member Functions | List of all members
Os::Stub::Mutex::StubMutex Class Reference

stub implementation of Os::Mutex More...

#include <Os/Stub/Mutex.hpp>

Inheritance diagram for Os::Stub::Mutex::StubMutex:
Os::MutexInterface

Public Member Functions

 StubMutex ()=default
 constructor More...
 
 ~StubMutex () override=default
 destructor More...
 
MutexHandle * getHandle () override
 return the underlying mutex handle (implementation specific) More...
 
Status take () override
 lock the mutex and get return status More...
 
Status release () override
 unlock the mutex and get return status More...
 
- Public Member Functions inherited from Os::MutexInterface
 MutexInterface ()=default
 default constructor More...
 
virtual ~MutexInterface ()=default
 default virtual destructor More...
 
 MutexInterface (const MutexInterface &other)=delete
 copy constructor is forbidden More...
 
 MutexInterface (const MutexInterface *other)=delete
 copy constructor is forbidden More...
 
MutexInterface & operator= (const MutexInterface &other)=delete
 assignment operator is forbidden More...
 

Additional Inherited Members

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

Detailed Description

stub implementation of Os::Mutex

Stub implementation of MutexInterface for use as a delegate class handling error-only file operations.

Definition at line 19 of file Mutex.hpp.

Constructor & Destructor Documentation

◆ StubMutex()

Os::Stub::Mutex::StubMutex::StubMutex ( )
default

constructor

◆ ~StubMutex()

Os::Stub::Mutex::StubMutex::~StubMutex ( )
overridedefault

destructor

Member Function Documentation

◆ getHandle()

MutexHandle * Os::Stub::Mutex::StubMutex::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.

◆ release()

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

unlock the mutex and get return status

Implements Os::MutexInterface.

Definition at line 15 of file Mutex.cpp.

◆ take()

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

lock the mutex and get return status

Implements Os::MutexInterface.

Definition at line 11 of file Mutex.cpp.

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