eventDefinitions.hpp

Go to the documentation of this file.

 
#ifndef RTCTK_COMPONENTFRAMEWORK_EVENTDEFINITIONS_HPP
#define RTCTK_COMPONENTFRAMEWORK_EVENTDEFINITIONS_HPP
 
#include <rtctk/componentFramework/jsonPayload.hpp>
 
#include <boost/core/demangle.hpp>
#include <chrono>
 
namespace rtctk::componentFramework {
// Suppressing warnings about duplicate ToJson methods. We are not using polymorphism on purpose.
// cppcheck-suppress-begin duplInheritedMember
 
template <typename T>
std::string PrettyTypeName() {
    return boost::core::demangle((typeid(T).name()));
}
 
inline uint64_t GetTimestamp() {
    using namespace std::chrono;
    return duration_cast<nanoseconds>(system_clock::now().time_since_epoch()).count();
}
 
 
struct AbstractEvent {
    AbstractEvent() = delete;
 
    explicit AbstractEvent(const JsonPayload& payload)
        : origin(payload["origin"]), time(payload["time"]) {
    }
 
    explicit AbstractEvent(const std::string& origin) : origin(origin), time(GetTimestamp()) {
    }
 
    JsonPayload ToJson() const {
        JsonPayload payload;
        payload["type"] = std::vector<std::string>();
        payload["origin"] = origin;
        payload["time"] = time;
        return payload;
    }
 
    std::string origin;  // which component performed computation
    uint64_t time;       // when was computation performed
};
 
 
struct ComputationEvent : AbstractEvent {
    inline static const std::string TOPIC_NAME = "computation_topic";
 
    ComputationEvent(const std::string& origin, const std::string& item, const std::string& state)
        : AbstractEvent(origin), item(item), state(state) {
    }
 
    ComputationEvent(const std::string& origin, const std::string& item)
        : ComputationEvent(origin, item, "finished") {
    }
 
    explicit ComputationEvent(const JsonPayload& payload)
        : AbstractEvent(payload), item(payload["item"]), state(payload["state"]) {
    }
 
    JsonPayload ToJson() const {
        auto payload = AbstractEvent::ToJson();
        payload["type"].push_back(PrettyTypeName<ComputationEvent>());
        payload["item"] = item;
        payload["state"] = state;
        return payload;
    }
 
    std::string item;   // what was computed
    std::string state;  // was computaton started, finished, failed
};
 
struct ComputationStartedEvent : ComputationEvent {
    ComputationStartedEvent(const std::string& origin, const std::string& item)
        : ComputationEvent(origin, item, "started") {
    }
 
    explicit ComputationStartedEvent(const JsonPayload& payload) : ComputationEvent(payload) {
    }
 
    JsonPayload ToJson() const {
        auto payload = ComputationEvent::ToJson();
        payload["type"].push_back(PrettyTypeName<ComputationStartedEvent>());
        return payload;
    }
};
 
struct ComputationFinishedEvent : ComputationEvent {
    ComputationFinishedEvent(const std::string& origin, const std::string& item)
        : ComputationEvent(origin, item, "finished") {
    }
 
    ComputationFinishedEvent(const std::string& origin,
                             const std::string& item,
                             const JsonPayload& result)
        : ComputationEvent(origin, item, "finished"), result(result) {
    }
 
    explicit ComputationFinishedEvent(const JsonPayload& payload)
        : ComputationEvent(payload), result(payload["result"]) {
    }
 
    JsonPayload ToJson() const {
        auto payload = ComputationEvent::ToJson();
        payload["type"].push_back(PrettyTypeName<ComputationFinishedEvent>());
        payload["result"] = result;
        return payload;
    }
 
    JsonPayload result;
};
 
 
struct ConfigurationEvent : AbstractEvent {
    inline static const std::string TOPIC_NAME = "configuration_topic";
 
    ConfigurationEvent(const std::string& origin, const std::string& item, const std::string& state)
        : AbstractEvent(origin), items({item}), state(state) {
    }
 
    ConfigurationEvent(const std::string& origin,
                       const std::vector<std::string>& items,
                       const std::string& state)
        : AbstractEvent(origin), items(items), state(state) {
    }
 
    explicit ConfigurationEvent(const JsonPayload& payload)
        : AbstractEvent(payload), items(payload["items"]), state(payload["state"]) {
    }
 
    JsonPayload ToJson() const {
        auto payload = AbstractEvent::ToJson();
        payload["type"].push_back(PrettyTypeName<ConfigurationEvent>());
        payload["items"] = items;
        payload["state"] = state;
        return payload;
    }
 
    std::vector<std::string> items;  // what was configured
    std::string state;               // was configuration scheduled, started, finished, failed
};
 
struct ConfigurationUpdatedEvent : ConfigurationEvent {
    ConfigurationUpdatedEvent(const std::string& origin, const std::string& item)
        : ConfigurationEvent(origin, item, "updated") {
    }
 
    ConfigurationUpdatedEvent(const std::string& origin, const std::vector<std::string>& items)
        : ConfigurationEvent(origin, items, "updated") {
    }
 
    explicit ConfigurationUpdatedEvent(const JsonPayload& payload) : ConfigurationEvent(payload) {
    }
 
    JsonPayload ToJson() const {
        auto payload = ConfigurationEvent::ToJson();
        payload["type"].push_back(PrettyTypeName<ConfigurationUpdatedEvent>());
        return payload;
    }
};
 
struct ConfigurationRetrievedEvent : ConfigurationEvent {
    ConfigurationRetrievedEvent(const std::string& origin, const std::string& item)
        : ConfigurationEvent(origin, item, "retrieved") {
    }
 
    ConfigurationRetrievedEvent(const std::string& origin, const std::vector<std::string>& items)
        : ConfigurationEvent(origin, items, "retrieved") {
    }
 
    explicit ConfigurationRetrievedEvent(const JsonPayload& payload) : ConfigurationEvent(payload) {
    }
 
    JsonPayload ToJson() const {
        auto payload = ConfigurationEvent::ToJson();
        payload["type"].push_back(PrettyTypeName<ConfigurationRetrievedEvent>());
        return payload;
    }
};
 
struct HrtcConfigurationScheduledEvent : ConfigurationEvent {
    HrtcConfigurationScheduledEvent(const std::string& origin,
                                    const std::string& item,
                                    const std::string& hrtc_origin,
                                    uint64_t hrtc_timestamp,
                                    uint64_t hrtc_sample_id)
        : ConfigurationEvent(origin, item, "scheduled")
        , hrtc_origin(hrtc_origin)
        , hrtc_timestamp(hrtc_timestamp)
        , hrtc_sample_id(hrtc_sample_id) {
    }
 
    explicit HrtcConfigurationScheduledEvent(const JsonPayload& payload)
        : ConfigurationEvent(payload)
        , hrtc_origin(payload["hrtc_origin"])
        , hrtc_timestamp(payload["hrtc_timestamp"])
        , hrtc_sample_id(payload["hrtc_sample_id"]) {
    }
 
    JsonPayload ToJson() const {
        auto payload = ConfigurationEvent::ToJson();
        payload["type"].push_back(PrettyTypeName<HrtcConfigurationScheduledEvent>());
        payload["hrtc_origin"] = hrtc_origin;
        payload["hrtc_timestamp"] = hrtc_timestamp;
        payload["hrtc_sample_id"] = hrtc_sample_id;
        return payload;
    }
 
    std::string hrtc_origin;
    uint64_t hrtc_timestamp;
    uint64_t hrtc_sample_id;
};
 
struct HrtcConfigurationAppliedEvent : ConfigurationEvent {
    HrtcConfigurationAppliedEvent(const std::string& origin,
                                  const std::string& item,
                                  const std::string& hrtc_origin,
                                  uint64_t hrtc_timestamp,
                                  uint64_t hrtc_sample_id)
        : ConfigurationEvent(origin, item, "applied")
        , hrtc_origin(hrtc_origin)
        , hrtc_timestamp(hrtc_timestamp)
        , hrtc_sample_id(hrtc_sample_id) {
    }
 
    explicit HrtcConfigurationAppliedEvent(const JsonPayload& payload)
        : ConfigurationEvent(payload)
        , hrtc_origin(payload["hrtc_origin"])
        , hrtc_timestamp(payload["hrtc_timestamp"])
        , hrtc_sample_id(payload["hrtc_sample_id"]) {
    }
 
    JsonPayload ToJson() const {
        auto payload = ConfigurationEvent::ToJson();
        payload["type"].push_back(PrettyTypeName<HrtcConfigurationAppliedEvent>());
        payload["hrtc_origin"] = hrtc_origin;
        payload["hrtc_timestamp"] = hrtc_timestamp;
        payload["hrtc_sample_id"] = hrtc_sample_id;
        return payload;
    }
 
    std::string hrtc_origin;
    uint64_t hrtc_timestamp;
    uint64_t hrtc_sample_id;
};
 
 
struct CoordinationEvent : AbstractEvent {
    inline static const std::string TOPIC_NAME = "coordination_topic";
 
    explicit CoordinationEvent(const std::string& origin) : AbstractEvent(origin) {
    }
 
    explicit CoordinationEvent(const JsonPayload& payload) : AbstractEvent(payload) {
    }
 
    JsonPayload ToJson() const {
        auto payload = AbstractEvent::ToJson();
        payload["type"].push_back(PrettyTypeName<CoordinationEvent>());
        return payload;
    }
};
 
struct StateChangedEvent : CoordinationEvent {
    StateChangedEvent(const std::string& origin,
                      const std::string& entity,
                      const std::string& state)
        : CoordinationEvent(origin), entity(entity), state(state) {
    }
 
    StateChangedEvent(const std::string& origin, const std::string& state)
        : StateChangedEvent(origin, origin, state) {
    }
 
    explicit StateChangedEvent(const JsonPayload& payload)
        : CoordinationEvent(payload), entity(payload["entity"]), state(payload["state"]) {
    }
 
    JsonPayload ToJson() const {
        auto payload = CoordinationEvent::ToJson();
        payload["type"].push_back(PrettyTypeName<StateChangedEvent>());
        payload["state"] = state;
        payload["entity"] = entity;
        return payload;
    }
 
    std::string entity;
    std::string state;
};
 
struct HrtcStateChangedEvent : StateChangedEvent {
    HrtcStateChangedEvent(const std::string& origin,
                          const std::string& entity,
                          const std::string& state,
                          uint64_t hrtc_timestamp,
                          uint64_t hrtc_sample_id)
        : StateChangedEvent(origin, entity, state)
        , hrtc_timestamp(hrtc_timestamp)
        , hrtc_sample_id(hrtc_sample_id) {
    }
 
    explicit HrtcStateChangedEvent(const JsonPayload& payload)
        : StateChangedEvent(payload)
        , hrtc_timestamp(payload["hrtc_timestamp"])
        , hrtc_sample_id(payload["hrtc_sample_id"]) {
    }
 
    JsonPayload ToJson() const {
        auto payload = StateChangedEvent::ToJson();
        payload["type"].push_back(PrettyTypeName<HrtcStateChangedEvent>());
        payload["hrtc_timestamp"] = hrtc_timestamp;
        payload["hrtc_sample_id"] = hrtc_sample_id;
        return payload;
    }
 
    uint64_t hrtc_timestamp;
    uint64_t hrtc_sample_id;
};
 
struct AlertStatusEvent : AbstractEvent {
    // cppcheck-suppress unusedStructMember
    inline static const std::string TOPIC_NAME = "alert_status_topic";
 
    struct Alert {
        std::string origin;
 
        std::string id;
 
        std::string description;
 
        std::uint64_t since;
    };
 
    AlertStatusEvent(bool st, std::vector<Alert> ac, const std::string& origin)
        : AbstractEvent(origin), status(st), active_alerts(std::move(ac)) {
    }
 
    explicit AlertStatusEvent(const JsonPayload& json) : AbstractEvent(json) {
        json["status"].get_to(status);
        for (auto&& active : json["active_alerts"]) {
            Alert alert;
            active["id"].get_to(alert.id);
            active["description"].get_to(alert.description);
            active["origin"].get_to(alert.origin);
            active["since"].get_to(alert.since);
            active_alerts.push_back(alert);
        }
    }
 
    JsonPayload ToJson() const {
        auto payload = AbstractEvent::ToJson();
        payload["type"].push_back(PrettyTypeName<AlertStatusEvent>());
        payload["status"] = status;
        JsonPayload json_active;
        for (auto&& alert : active_alerts) {
            // cppcheck-suppress useStlAlgorithm
            json_active.push_back(JsonPayload{{"origin", alert.origin},
                                              {"id", alert.id},
                                              {"description", alert.description},
                                              {"since", alert.since}});
        }
        payload["active_alerts"] = std::move(json_active);
        return payload;
    }
 
    bool status;
    std::vector<Alert> active_alerts;
};
 
// cppcheck-suppress-end duplInheritedMember
}  // namespace rtctk::componentFramework
 
#endif  // RTCTK_COMPONENTFRAMEWORK_EVENTDEFINITIONS_HPP