Condition.hpp

Go to the documentation of this file.

// ======================================================================
// \title Os/Condition.hpp
// \brief common function definitions for Os::ConditionVariables
// ======================================================================
#include "Os/Mutex.hpp"
#include "Os/Os.hpp"
 
#ifndef OS_CONDITION_HPP_
#define OS_CONDITION_HPP_
 
namespace Os {
 
class ConditionVariableHandle {};
 
class ConditionVariableInterface {
  public:
    ConditionVariableInterface() = default;
    virtual ~ConditionVariableInterface() = default;
 
    ConditionVariableInterface(const ConditionVariableInterface& other) = delete;
 
    virtual ConditionVariableInterface& operator=(const ConditionVariableInterface& other) = delete;
 
    virtual void wait(Os::Mutex& mutex) = 0;
 
    virtual void notify() = 0;
 
    virtual void notifyAll() = 0;
 
    virtual ConditionVariableHandle* getHandle() = 0;
 
    static ConditionVariableInterface* getDelegate(ConditionVariableHandleStorage& aligned_new_memory);
};
 
class ConditionVariable final : public ConditionVariableInterface {
  public:
    ConditionVariable();
 
    ~ConditionVariable() final;
 
    ConditionVariable(const ConditionVariableInterface& other) = delete;
 
    ConditionVariable(const ConditionVariableInterface* other) = delete;
 
    ConditionVariableInterface& operator=(const ConditionVariableInterface& other) override = delete;
 
    void wait(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 file handle. To Os::File and fprime, this type is
    // opaque and thus normal allocation cannot be done. Instead, we allow the implementor to store then 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;                                       
};
}
#endif //OS_CONDITION_HPP_