signalk_put_request.h

Go to the documentation of this file.

#ifndef _signalk_put_request_H_
#define _signalk_put_request_H_
 
#include <ArduinoJson.h>
 
#include <functional>
#include <map>
 
#include "sensesp/system/configurable.h"
#include "sensesp/system/valueconsumer.h"
 
namespace sensesp {
 
class SKRequest {
 public:
  static String send_request(DynamicJsonDocument& request,
                             std::function<void(DynamicJsonDocument&)> callback,
                             uint32_t timeout = 5000);
 
  static void handle_response(DynamicJsonDocument& response);
 
 protected:
  class PendingRequest {
   public:
    String request_id;
    std::function<void(DynamicJsonDocument&)> callback;
    DelayReaction* timeout_cleanup;
  };
 
  static std::map<String, PendingRequest*> request_map;
 
  static void remove_request(String request_id);
 
  static PendingRequest* get_request(String request_id);
};
 
class SKPutRequestBase : public SKRequest, public Configurable {
 public:
  SKPutRequestBase(String sk_path, String config_path = "",
                   uint32_t timeout = 5000);
 
  // For reading and writing the configuration
  virtual void get_configuration(JsonObject& doc) override;
  virtual bool set_configuration(const JsonObject& config) override;
  virtual String get_config_schema() override;
 
  String get_sk_path() { return sk_path; }
 
  bool request_pending();
 
 protected:
  void send_put_request();
 
  virtual void set_put_value(JsonObject& put_data) = 0;
 
  virtual void on_response(DynamicJsonDocument& response);
 
  String sk_path;
  uint32_t timeout;
  String pending_request_id_;
};
 
template <typename T>
class SKPutRequest : public SKPutRequestBase, public ValueConsumer<T> {
 public:
  SKPutRequest(String sk_path, String config_path = "",
               bool ignore_duplicates = true, uint32_t timeout = 5000)
      : SKPutRequestBase(sk_path, config_path, timeout),
        ignore_duplicates{ignore_duplicates} {}
 
  virtual void set_input(T new_value, uint8_t input_channel = 0) override {
    if (ignore_duplicates && new_value == value) {
      return;
    }
    if (!request_pending()) {
      this->value = new_value;
      send_put_request();
    } else {
      debugW("Ignoring PUT request (previous request still outstanding)");
    }
  };
 
  virtual void set_put_value(JsonObject& put_data) override {
    put_data["value"] = value;
  };
 
 protected:
  T value;
  bool ignore_duplicates;
};
 
typedef SKPutRequest<float> FloatSKPutRequest;
typedef SKPutRequest<int> IntSKPutRequest;
typedef SKPutRequest<bool> BoolSKPutRequest;
typedef SKPutRequest<String> StringSKPutRequest;
 
}  // namespace sensesp
 
#endif