DelegateConditionVariable.hpp

Go to the documentation of this file.

// ======================================================================
// \title Os/DelegateConditionVariable.hpp
// \brief Define the Os::DelegateConditionVariable class
// ======================================================================
#ifndef OS_DELEGATECONDITIONVARIABLE_HPP_
#define OS_DELEGATECONDITIONVARIABLE_HPP_

#include "Os/ConditionVariableInterface.hpp"

namespace Os {

class DelegateConditionVariable final : public ConditionVariableInterface {
  public:
    DelegateConditionVariable();

    ~DelegateConditionVariable() final;

    DelegateConditionVariable(const ConditionVariableInterface& other) = delete;

    DelegateConditionVariable(const ConditionVariableInterface* other) = delete;

    ConditionVariableInterface& operator=(const ConditionVariableInterface& other) override = delete;

    Status pend(Os::Mutex& mutex) override;

    void notify() override;

    void notifyAll() override;

    ConditionVariableHandle* getHandle() override;

  private:
    Os::Mutex* m_lock = nullptr;

    // This section is used to store the implementation-defined condition variable handle. To Os::ConditionVariable
    // 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 `handle` to that address for storage.
    alignas(FW_HANDLE_ALIGNMENT)
        ConditionVariableHandleStorage m_handle_storage;  
    ConditionVariableInterface& m_delegate;               
};

}  // namespace Os

#endif  // OS_DELEGATECONDITIONVARIABLE_HPP_