IAPI_Implementation.h

Go to the documentation of this file.

#ifndef IAPI_Implementation_h
#define IAPI_Implementation_h
 
// Local include.
#include "Callback.h"
#include "Constants.h"
#include "DefaultLogger.h"
#include "API_Process_Type.h"
 
// Library include.
#if THINGSBOARD_ENABLE_STL
#include <algorithm>
#endif // THINGSBOARD_ENABLE_STL
#if THINGSBOARD_ENABLE_CXX20
#include <ranges>
#endif // THINGSBOARD_ENABLE_CXX20
 
// Log messages.
#if !THINGSBOARD_ENABLE_DYNAMIC
char constexpr MAX_SUBSCRIPTIONS_EXCEEDED[] = "Too many (%s) subscriptions, increase (%s) or unsubscribe";
#endif // !THINGSBOARD_ENABLE_DYNAMIC
char constexpr MAX_SUBSCRIPTIONS_TEMPLATE_NAME[] = "MaxSubscriptions";
char constexpr SUBSCRIBE_TOPIC_FAILED[] = "Subscribing the given topic (%s) failed";
char constexpr REQUEST_ID_NULL[] = "Internal request id is NULL";
// RPC data keys.
char constexpr RPC_METHOD_KEY[] = "method";
char constexpr RPC_PARAMS_KEY[] = "params";
// Shared attribute update API topics.
char constexpr ATTRIBUTE_TOPIC[] = "v1/devices/me/attributes";
// Shared attribute request keys.
char constexpr SHARED_RESPONSE_KEY[] = "shared";
// Publish data topics.
char constexpr TELEMETRY_TOPIC[] = "v1/devices/me/telemetry";
 
 
class IAPI_Implementation {
  public:
    virtual ~IAPI_Implementation() {}
 
    virtual API_Process_Type Get_Process_Type() const = 0;
 
    virtual void Process_Response(char const * topic, uint8_t * payload, uint32_t length) = 0;
 
    virtual void Process_Json_Response(char const * topic, JsonDocument const & data) = 0;
 
    virtual bool Is_Response_Topic_Matching(char const * topic) const = 0;
 
    virtual bool Unsubscribe() = 0;
 
    virtual bool Resubscribe_Permanent_Subscriptions() = 0;
 
#if !THINGSBOARD_USE_ESP_TIMER
    virtual void loop() = 0;
#endif // !THINGSBOARD_USE_ESP_TIMER
 
    virtual void Initialize() = 0;
 
    virtual void Set_Client_Callbacks(Callback<void, IAPI_Implementation &>::function subscribe_api_callback, Callback<bool, char const * const, JsonDocument const &>::function send_json_callback, Callback<bool, char const * const, char const * const>::function send_json_string_callback, Callback<bool, char const * const>::function subscribe_topic_callback, Callback<bool, char const * const>::function unsubscribe_topic_callback, Callback<uint16_t>::function get_receive_size_callback, Callback<uint16_t>::function get_send_size_callback, Callback<bool, uint16_t, uint16_t>::function set_buffer_size_callback, Callback<size_t *>::function get_request_id_callback) = 0;
};
 
#endif // IAPI_Implementation_h