CountingSemaphore.hpp

Go to the documentation of this file.

// ======================================================================
// \title Os/CountingSemaphore.hpp
// \brief common function definitions for Os::CountingSemaphore
// ======================================================================
#ifndef OS_COUNTING_SEMAPHORE_HPP_
#define OS_COUNTING_SEMAPHORE_HPP_
#include "Fw/Time/TimeInterval.hpp"
#include "Os/Os.hpp"

namespace Os {

class CountingSemaphoreHandle {};

class CountingSemaphoreInterface {
  public:
    enum Status {
        OP_OK,                  
        ERROR_TIMEOUT,          
        ERROR_INVALID,          
        ERROR_NOT_IMPLEMENTED,  
        NOT_SUPPORTED,          
        ERROR_OTHER             
    };

    CountingSemaphoreInterface() = default;

    virtual ~CountingSemaphoreInterface() = default;

    CountingSemaphoreInterface(const CountingSemaphoreInterface& other) = delete;

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

    virtual Status wait() = 0;

    virtual Status waitTimeout(const Fw::TimeInterval& interval) = 0;

    virtual Status tryWait() = 0;

    virtual Status post() = 0;

    virtual CountingSemaphoreHandle* getHandle() = 0;

    static CountingSemaphoreInterface* getDelegate(CountingSemaphoreHandleStorage& aligned_new_memory,
                                                   U32 initial_count);
};

class CountingSemaphore final : public CountingSemaphoreInterface {
  public:
    explicit CountingSemaphore(U32 initial_count);  

    ~CountingSemaphore() final;  

    CountingSemaphore(const CountingSemaphoreInterface& other) = delete;

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

    Status wait() override;  

    Status waitTimeout(const Fw::TimeInterval& interval) override;  

    Status tryWait() override;

    Status post() override;

    CountingSemaphoreHandle* getHandle() override;

  private:
    alignas(FW_HANDLE_ALIGNMENT) CountingSemaphoreHandleStorage m_handle_storage;
    CountingSemaphoreInterface& m_delegate;
};
}  // namespace Os
#endif  // OS_COUNTING_SEMAPHORE_HPP_