DelegateMutex.hpp

Go to the documentation of this file.

// ======================================================================
// \title Os/DelegateMutex.hpp
// \brief Define the Os::DelegateMutex class
// ======================================================================
#ifndef OS_DELEGATEMUTEX_HPP_
#define OS_DELEGATEMUTEX_HPP_

#include "Os/MutexInterface.hpp"

namespace Os {

class DelegateMutex final : public MutexInterface {
  public:
    DelegateMutex();         
    ~DelegateMutex() final;  

    DelegateMutex(const DelegateMutex& other) = delete;

    DelegateMutex& operator=(const DelegateMutex& other) = delete;

    MutexHandle* getHandle() override;

    Status take() override;     
    Status release() override;  

  private:
    // This section is used to store the implementation-defined mutex handle. To Os::Mutex and fprime, this type is
    // opaque and thus normal allocation cannot be done. Instead, we allow the implementor to store the handle in
    // the byte-array here and set `m_delegate` to that address for storage.
    //
    alignas(FW_HANDLE_ALIGNMENT) MutexHandleStorage m_handle_storage;  
    MutexInterface& m_delegate;                                        
};

}  // namespace Os

#endif  // OS_DELEGATEMUTEX_HPP_