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::Posix::Mutex::PosixMutex Class Reference

Posix implementation of Os::Mutex. More...

#include <Os/Posix/Mutex.hpp>

Inheritance diagram for Os::Posix::Mutex::PosixMutex:
Os::MutexInterface

Public Member Functions

 PosixMutex ()
 constructor More...
 
 ~PosixMutex () override
 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

Posix implementation of Os::Mutex.

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

Definition at line 22 of file Mutex.hpp.

Constructor & Destructor Documentation

◆ PosixMutex()

Os::Posix::Mutex::PosixMutex::PosixMutex ( )

constructor

Definition at line 13 of file Mutex.cpp.

◆ ~PosixMutex()

Os::Posix::Mutex::PosixMutex::~PosixMutex ( )
override

destructor

Definition at line 31 of file Mutex.cpp.

Member Function Documentation

◆ getHandle()

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

return the underlying mutex handle (implementation specific)

Returns
internal mutex handle representation

Implements Os::MutexInterface.

Definition at line 46 of file Mutex.cpp.

◆ release()

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

unlock the mutex and get return status

Implements Os::MutexInterface.

Definition at line 41 of file Mutex.cpp.

◆ take()

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

lock the mutex and get return status

Implements Os::MutexInterface.

Definition at line 36 of file Mutex.cpp.

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