IApiCommunicationProtocol.hpp

Go to the documentation of this file.

#ifndef IAPICOMMUNICATIONPROTOCOL_HPP
#define IAPICOMMUNICATIONPROTOCOL_HPP
 
#include "ApiCommunicationDriver.hpp"
#include "comms/ICommunicationProtocol.hpp"
#include "comms/apis/IApiQueryParamsBuilder.hpp"
#include "comms/apis/structs.hpp"
#include "diamar/AppFailuresLoggerManager.hpp"
 
#include <memory>
 
namespace iv::comms::api
{
 
class IApiCommunicationProtocol
{
public:
    virtual ~IApiCommunicationProtocol() = default;
 
    virtual void registerValue(const std::shared_ptr<iv::comms::api::ILoggerMessage> &message) = 0;
 
    virtual bool sendValues() = 0;
 
    [[nodiscard]] virtual iv::comms::api::ApiResponse getValues(const IApiQueryParamsBuilder &queryParams) const = 0;
 
    [[nodiscard]] virtual iv::comms::api::ApiDeleteResponse
    deleteValues(const IApiQueryParamsBuilder &queryParams) const = 0;
 
    [[nodiscard]] iv::comms::api::ApiPingResponse ping() const;
    [[nodiscard]] bool wipe() const;
 
    [[nodiscard]] bool isEnabled() const;
 
protected:
    bool m_sendToCloud {false};
    bool m_isEnabled {true};
 
    std::shared_ptr<iv::model::comms::NetworkData> m_networkData;
 
    std::weak_ptr<iv::comms::api::ApiCommunicationDriver> m_apiDriver;
    std::weak_ptr<iv::channels::AbstractChannel> m_heartbeatChannel;
    std::weak_ptr<iv::diamar::AppFailuresLoggerManager> m_appFailuresLoggerManager;
 
    struct ValuesApi
    {
        static constexpr std::string_view pingRoute {"/ping"};
        static constexpr std::string_view wipeRoute {"/wipe"};
 
        struct Fields
        {
            static constexpr std::string_view status {"status"};
            static constexpr std::string_view version {"version"};
            static constexpr std::string_view name {"name"};
            static constexpr std::string_view description {"description"};
        };
    };
};
 
}// namespace iv::comms::api
 
#endif//IAPICOMMUNICATIONPROTOCOL_HPP