Revert constness for Interface. Does nto work because getters are non const in dependencies.

Author: MathewHDYT

README.md

@@ -530,11 +530,11 @@ class Custom_HTTP_Client : public IHTTP_Client {
     }
 
 #if THINGSBOARD_ENABLE_STL
-    std::string get_response_body() const override {
+    std::string get_response_body() override {
         return std::string();
     }
 #else
-    String get_response_body() const override {
+    String get_response_body() override {
         return String();
     }
 
@@ -587,11 +587,11 @@ class Custom_MQTT_Client : public IMQTT_Client {
         return true;
     }
 
-    uint16_t get_receive_buffer_size() const override {
+    uint16_t get_receive_buffer_size() override {
         return 0U;
     }
 
-    uint16_t get_send_buffer_size() const override {
+    uint16_t get_send_buffer_size() override {
         return 0U;
     }
 

src/Arduino_HTTP_Client.cpp

@@ -36,10 +36,10 @@ int Arduino_HTTP_Client::get(char const * url_path) {
 }
 
 #if THINGSBOARD_ENABLE_STL
-std::string Arduino_HTTP_Client::get_response_body() const {
+std::string Arduino_HTTP_Client::get_response_body() {
     return m_http_client.responseBody().c_str();
 #else
-String Arduino_HTTP_Client::get_response_body() const {
+String Arduino_HTTP_Client::get_response_body() {
     return m_http_client.responseBody();
 #endif // THINGSBOARD_ENABLE_STL
 }

src/Arduino_HTTP_Client.h

@@ -39,9 +39,9 @@ class Arduino_HTTP_Client : public IHTTP_Client {
     int get(char const * url_path) override;
 
 #if THINGSBOARD_ENABLE_STL
-    std::string get_response_body() const override;
+    std::string get_response_body() override;
 #else
-    String get_response_body() const override;
+    String get_response_body() override;
 #endif // THINGSBOARD_ENABLE_STL
 
   private:

src/Arduino_MQTT_Client.cpp

@@ -26,11 +26,11 @@ bool Arduino_MQTT_Client::set_buffer_size(uint16_t receive_buffer_size, uint16_t
     return m_mqtt_client.setBufferSize(receive_buffer_size, send_buffer_size);
 }
 
-uint16_t Arduino_MQTT_Client::get_receive_buffer_size() const {
+uint16_t Arduino_MQTT_Client::get_receive_buffer_size() {
     return m_mqtt_client.getReceiveBufferSize();
 }
 
-uint16_t Arduino_MQTT_Client::get_send_buffer_size() const {
+uint16_t Arduino_MQTT_Client::get_send_buffer_size() {
     return m_mqtt_client.getSendBufferSize();
 }
 

src/Arduino_MQTT_Client.h

@@ -41,9 +41,9 @@ class Arduino_MQTT_Client : public IMQTT_Client {
 
     bool set_buffer_size(uint16_t receive_buffer_size, uint16_t send_buffer_size) override;
 
-    uint16_t get_receive_buffer_size() const override;
+    uint16_t get_receive_buffer_size() override;
 
-    uint16_t get_send_buffer_size() const override;
+    uint16_t get_send_buffer_size() override;
 
     void set_server(char const * domain, uint16_t port) override;
 

src/Attribute_Request_Callback.h

@@ -132,7 +132,7 @@ class Attribute_Request_Callback : public Callback<void, JsonObjectConst const &
     }
 
     /// @brief Sets the amount of microseconds until we expect to have received a response
-    /// @note The default value of 0, means the timeout timer is never started and therefore the timeout callback never called
+    /// @note The value of 0, means the timeout timer is never started and therefore the timeout callback never called
     /// @param timeout_microseconds Timeout time until timeout callback is called
     void Set_Timeout(uint64_t const & timeout_microseconds) {
         m_timeout_microseconds = timeout_microseconds;
@@ -156,7 +156,7 @@ class Attribute_Request_Callback : public Callback<void, JsonObjectConst const &
     }
 
     /// @brief Stops the internal timeout timer, is called as soon as an answer is received from the cloud.
-    /// If this method is not called in time the initally subscribed callback will be used to inform the user of the timeout instead.
+    /// If this method is not called in time the initally subscribed callback will be used to inform the user of the timeout instead
     /// @note Is not mean to be called explicitly by the user, because it is instead called when necessary by internal methods that handle the class instance
     void Stop_Timeout_Timer() {
         m_timeout_callback.detach();

src/Espressif_MQTT_Client.h

@@ -228,15 +228,15 @@ class Espressif_MQTT_Client : public IMQTT_Client {
         return update_configuration();
     }
 
-    uint16_t get_receive_buffer_size() const override {
+    uint16_t get_receive_buffer_size() override {
 #if ESP_IDF_VERSION_MAJOR < 5
         return m_mqtt_configuration.buffer_size;
 #else
         return m_mqtt_configuration.buffer.size;
 #endif // ESP_IDF_VERSION_MAJOR < 5
     }
 
-    uint16_t get_send_buffer_size() const override {
+    uint16_t get_send_buffer_size() override {
 #if ESP_IDF_VERSION_MAJOR < 5
         return m_mqtt_configuration.out_buffer_size;
 #else

src/IHTTP_Client.h

@@ -69,9 +69,9 @@ class IHTTP_Client {
     /// should be called after calling get_response_status_code() and ensuring the request was successful
     /// @return Response body of a request
 #if THINGSBOARD_ENABLE_STL
-    virtual std::string get_response_body() const = 0;
+    virtual std::string get_response_body() = 0;
 #else
-    virtual String get_response_body() const = 0;
+    virtual String get_response_body() = 0;
 #endif // THINGSBOARD_ENABLE_STL
 };
 

src/IMQTT_Client.h

@@ -64,11 +64,11 @@ class IMQTT_Client {
 
     /// @brief Gets the previously set size of the internal buffer size meant for incoming MQTT data
     /// @return Internal size of the buffer
-    virtual uint16_t get_receive_buffer_size() const = 0;
+    virtual uint16_t get_receive_buffer_size() = 0;
 
     /// @brief Gets the previously set size of the internal buffer size meant for outgoing MQTT data
     /// @return Internal size of the buffer
-    virtual uint16_t get_send_buffer_size() const = 0;
+    virtual uint16_t get_send_buffer_size() = 0;
 
     /// @brief Configures the server and port that the client should connect with over MQTT
     /// @note Should be called atleast once before calling connect() so the target server and port to connect too have been configured

src/Provision_Callback.h

@@ -112,47 +112,57 @@ class Provision_Callback : public Callback<void, JsonDocument const &> {
     void Set_Device_Access_Token(char const * access_token);
 
     /// @brief Gets the basic MQTT credentials username, that will be used by the provisioned device
-    /// @return Basic MQTT credentials username
+    /// @return Non owning pointer to the basic MQTT credentials username.
+    /// Owned by the user that passed it originally in the constructor or with the @ref Set_Credentials_Username method
     char const * Get_Credentials_Username() const;
 
     /// @brief Sets the basic MQTT credentials username, that will be used by the provisioned device
-    /// @param username Basic MQTT credentials username
+    /// @param username Non owning pointer to the basic MQTT credentials username.
+    /// Additionally it has to be kept alive by the user until the @ref Provision_Request method has been called with this instance as the argument, because that method copies the data into the outgoing MQTT buffer to create the provision request
     void Set_Credentials_Username(char const * username);
 
     /// @brief Gets the basic MQTT credentials password, that will be used by the provisioned device
-    /// @return Basic MQTT credentials password
+    /// @return Non owning pointer to the basic MQTT credentials password
+    /// Owned by the user that passed it originally in the constructor or with the @ref Set_Credentials_Password method
     char const * Get_Credentials_Password() const;
 
     /// @brief Sets the basic MQTT credentials password, that will be used by the provisioned device
-    /// @param password Basic MQTT credentials password
+    /// @param password Non owning pointer to the basic MQTT credentials password.
+    /// Additionally it has to be kept alive by the user until the @ref Provision_Request method has been called with this instance as the argument, because that method copies the data into the outgoing MQTT buffer to create the provision request
     void Set_Credentials_Password(char const * password);
 
-    /// @brief Gets the basic MQTT credentials client_id, that will be used by the provisioned device
-    /// @return Basic MQTT credentials client_id
+    /// @brief Gets the basic MQTT credentials client ID, that will be used by the provisioned device
+    /// @return Non owning pointer to the basic MQTT credentials client ID.
+    /// Owned by the user that passed it originally in the constructor or with the @ref Set_Credentials_Client_ID method
     char const * Get_Credentials_Client_ID() const;
 
-    /// @brief Sets the basic MQTT credentials client_id, that will be used by the provisioned device
-    /// @param client_id Basic MQTT credentials client_id
+    /// @brief Sets the basic MQTT credentials client ID, that will be used by the provisioned device
+    /// @param client_id Non owning pointer to the basic MQTT credentials client ID.
+    /// Additionally it has to be kept alive by the user until the @ref Provision_Request method has been called with this instance as the argument, because that method copies the data into the outgoing MQTT buffer to create the provision request
     void Set_Credentials_Client_ID(char const * client_id);
 
     /// @brief Gets the public X.509 certificate hash, that will be used by the provisioned device
-    /// @return Public X.509 certificate hash
+    /// @return Non owning pointer to the public X.509 certificate hash.
+    /// Owned by the user that passed it originally in the constructor or with the @ref Set_Certificate_Hash method
     char const * Get_Certificate_Hash() const;
 
     /// @brief Sets the public X.509 certificate hash, that will be used by the provisioned device
-    /// @param hash Public X.509 certificate hash
+    /// @param hash Non owning pointer to the public X.509 certificate hash.
+    /// Additionally it has to be kept alive by the user until the @ref Provision_Request method has been called with this instance as the argument, because that method copies the data into the outgoing MQTT buffer to create the provision request
     void Set_Certificate_Hash(char const * hash);
 
     /// @brief Gets the string containing the used credentials type that decides which provisioning method is actually used,
-    /// by the Provision_Callback and therefore decides what response we will receive from the server
-    /// @return String containing the used credentials type
+    /// by the @ref Provision_Callback and therefore decides what response we will receive from the server
+    /// @return Owning pointer to th string containing the used credentials type.
+    /// Simply points to a compile time string constant saved into static memory
     char const * Get_Credentials_Type() const;
 
     /// @brief Gets the amount of microseconds until we expect to have received a response
     /// @return Timeout time until timeout callback is called
     uint64_t const & Get_Timeout() const;
 
     /// @brief Sets the amount of microseconds until we expect to have received a response
+    /// @note The value of 0, means the timeout timer is never started and therefore the timeout callback never called
     /// @param timeout_microseconds Timeout time until timeout callback is called
     void Set_Timeout(uint64_t const & timeout_microseconds);
 
@@ -162,14 +172,16 @@ class Provision_Callback : public Callback<void, JsonDocument const &> {
 #endif // !THINGSBOARD_USE_ESP_TIMER
 
     /// @brief Starts the internal timeout timer if we actually received a configured valid timeout time and a valid callback.
-    /// Is called as soon as the request is actually sent
+    /// @note The timeout time is valid if it is not 0 and the callback is valid if it is not a nullptr.
+    /// Is not mean to be called explicitly by the user, because it is instead called when necessary by internal methods that handle the class instance
     void Start_Timeout_Timer();
 
-    /// @brief Stops the internal timeout timer, is called as soon as an answer is received from the cloud
-    /// if it isn't we call the previously subscribed callback instead
+    /// @brief Stops the internal timeout timer, is called as soon as an answer is received from the cloud.
+    /// If this method is not called in time the initally subscribed callback will be used to inform the user of the timeout instead
+    /// @note Is not mean to be called explicitly by the user, because it is instead called when necessary by internal methods that handle the class instance
     void Stop_Timeout_Timer();
 
-    /// @brief Sets the callback method that will be called upon request timeout (did not receive a response in the given timeout time)
+    /// @brief Sets the callback method that will be called upon request timeout (did not receive a response from the cloud in the given timeout time)
     /// @param timeout_callback Callback function that will be called
     void Set_Timeout_Callback(Callback_Watchdog::function timeout_callback);