ApiEventLoggerCommunicationProtocol.hpp

Go to the documentation of this file.

 
#ifndef IV_SRC_COMMS_APIS_EVENTLOGGER_APIDATALOGGERCOMMUNICATIONPROTOCOL_HPP_
#define IV_SRC_COMMS_APIS_EVENTLOGGER_APIDATALOGGERCOMMUNICATIONPROTOCOL_HPP_
#include <comms/ICommunicationProtocol.hpp>
#include <comms/apis/ApiCommunicationDriver.hpp>
#include <comms/apis/IApiCommunicationProtocol.hpp>
#include <containers/CircularQueue.hpp>
 
namespace iv::comms::api::eventLogger
{
class ApiEventLoggerCommunicationProtocol final : public iv::comms::ICommunicationProtocol,
                                                  public iv::comms::api::IApiCommunicationProtocol
{
public:
    ApiEventLoggerCommunicationProtocol(
            const std::shared_ptr<iv::comms::ICommunicationDriver> &driver,
            const std::shared_ptr<iv::model::comms::NetworkData> &networkData,
            const std::weak_ptr<iv::channels::AbstractChannel> &heartbeatChannel,
            const std::weak_ptr<iv::diamar::AppFailuresLoggerManager> &appFailuresLoggerManager, bool sendToCloud);
    ~ApiEventLoggerCommunicationProtocol() override = default;
 
    bool sendValues() override;
    [[nodiscard]] bool isOnline() override;
    [[nodiscard]] iv::comms::api::ApiResponse getValues(const IApiQueryParamsBuilder &queryParams) const override;
 
    [[nodiscard]] iv::comms::api::ApiDeleteResponse
    deleteValues(const IApiQueryParamsBuilder &queryParams) const override;
 
    void registerValue(const std::shared_ptr<iv::comms::api::ILoggerMessage> &message) override;
 
private:
    static constexpr std::size_t m_sendQueueSize {5000};
    std::unique_ptr<iv::containers::CircularQueue<std::shared_ptr<iv::comms::api::eventLogger::EventLoggerMessage>,
                                                  m_sendQueueSize>>
            m_sendQueue;
 
    struct EventsApi
    {
        static constexpr std::string_view route {"/event"};
 
        struct Fields
        {
            static constexpr std::string_view id {"id"};
            static constexpr std::string_view timestamp {"event_timestamp"};
            static constexpr std::string_view message {"event_message"};
            static constexpr std::string_view source {"event_source"};
            static constexpr std::string_view type {"event_type"};
            static constexpr std::string_view category {"event_category"};
            static constexpr std::string_view data {"event_data"};
 
            static constexpr std::string_view cloud {"cloud"};
 
            static constexpr std::string_view ipAddress {"ipAddress"};
            static constexpr std::string_view ipPort {"ipPort"};
 
            static constexpr std::string_view userProfileIn {"userProfileIn"};
            static constexpr std::string_view userProfileOut {"userProfileOut"};
 
            static constexpr std::string_view unitId {"unitId"};
            static constexpr std::string_view channelId {"channelId"};
            static constexpr std::string_view groupId {"groupId"};
 
            static constexpr std::string_view backupName {"backupName"};
        };
        struct Request
        {
            static constexpr std::string_view offset {"offset"};
            static constexpr std::string_view limit {"limit"};
            static constexpr std::string_view category {"category"};
            static constexpr std::string_view source {"source"};
            static constexpr std::string_view startTimestamp {"startTimestamp"};
            static constexpr std::string_view endTimestamp {"endTimestamp"};
        };
        struct Response
        {
            static constexpr std::string_view data {"data"};
        };
    };
};
}// namespace iv::comms::api::eventLogger
#endif//IV_SRC_COMMS_APIS_EVENTLOGGER_APIDATALOGGERCOMMUNICATIONPROTOCOL_HPP_