rtcObject.hpp

Go to the documentation of this file.

 
#ifndef RTCTK_RTCSUPERVISOR_RTCOBJECT_HPP
#define RTCTK_RTCSUPERVISOR_RTCOBJECT_HPP
 
#include <rtctk/componentFramework/logger.hpp>
 
#include <Rtctkif.hpp>
#include <Stdif.hpp>
 
#include <optional>
#include <string>
 
#include <fmt/format.h>
 
namespace rtctk::rtcSupervisor {
 
struct RtcObjectInfo {
    // cppcheck-suppress-begin unusedStructMember
 
    std::string name;
 
    std::string rr_uri;
 
    std::string ps_uri;
 
    // cppcheck-suppress-end unusedStructMember
};
 
enum class RtcCommand : uint8_t {
    STOP,
    INIT,
    RESET,
    ENABLE,
    DISABLE,
    EXIT,
    GET_STATE,
    GET_VERSION,
    UPDATE,
    CLEAR_ALERTS,
    RECOVER,  // optional command
};
 
class RtcObjectIf {
public:
    virtual ~RtcObjectIf() = default;
 
    virtual RtcObjectInfo GetInfo() const = 0;
 
    virtual void RunAsync(RtcCommand cmd) = 0;
 
    virtual std::string WaitAsync(std::optional<unsigned> timeout) = 0;
};
 
class RtcObject : public RtcObjectIf {
public:
    explicit RtcObject(const RtcObjectInfo& obj_info);
    ~RtcObject() override = default;
    RtcObjectInfo GetInfo() const override;
    void RunAsync(RtcCommand cmd) override;
    std::string WaitAsync(std::optional<unsigned> timeout) override;
 
private:
    // cppcheck-suppress-begin unusedStructMember
 
    log4cplus::Logger& m_logger;
 
    RtcObjectInfo m_info;
    // reference to the name for convenience purpose
    const std::string& m_name;
 
    std::shared_ptr<stdif::StdCmdsAsync> m_stdif_async;
    std::shared_ptr<rtctkif::UpdateCmdsAsync> m_ucif_async;
    std::shared_ptr<rtctkif::AlertCmdsAsync> m_acif_async;
    std::shared_ptr<rtctkif::RecoverCmdsAsync> m_rcif_async;
 
    elt::mal::future<std::string> m_reply_future;
 
    // cppcheck-suppress-end unusedStructMember
};
 
}  // namespace rtctk::rtcSupervisor
 
template <>
struct fmt::formatter<rtctk::rtcSupervisor::RtcCommand> : formatter<string_view> {
    template <typename FormatContext>
    auto format(rtctk::rtcSupervisor::RtcCommand c, FormatContext& ctx) const {
        string_view name = "unknown";
        switch (c) {
        case rtctk::rtcSupervisor::RtcCommand::STOP:
            name = "STOP";
            break;
        case rtctk::rtcSupervisor::RtcCommand::INIT:
            name = "INIT";
            break;
        case rtctk::rtcSupervisor::RtcCommand::RESET:
            name = "RESET";
            break;
        case rtctk::rtcSupervisor::RtcCommand::ENABLE:
            name = "ENABLE";
            break;
        case rtctk::rtcSupervisor::RtcCommand::DISABLE:
            name = "DISABLE";
            break;
        case rtctk::rtcSupervisor::RtcCommand::EXIT:
            name = "EXIT";
            break;
        case rtctk::rtcSupervisor::RtcCommand::GET_STATE:
            name = "GET_STATE";
            break;
        case rtctk::rtcSupervisor::RtcCommand::GET_VERSION:
            name = "GET_VERSION";
            break;
        case rtctk::rtcSupervisor::RtcCommand::UPDATE:
            name = "UPDATE";
            break;
        case rtctk::rtcSupervisor::RtcCommand::CLEAR_ALERTS:
            name = "CLEAR_ALERTS";
            break;
        case rtctk::rtcSupervisor::RtcCommand::RECOVER:
            name = "RECOVER";
            break;
        }
        return formatter<string_view>::format(name, ctx);
    }  // format
};  // struct fmt::formatter
 
#endif  // RTCTK_RTCSUPERVISOR_RTCOBJECT_HPP