ota_cache.hpp

Go to the documentation of this file.

/******************************************************************************
 * # License
 * <b>Copyright 2021 Silicon Laboratories Inc. www.silabs.com</b>
 ******************************************************************************
 * The licensor of this software is Silicon Laboratories Inc. Your use of this
 * software is governed by the terms of Silicon Labs Master Software License
 * Agreement (MSLA) available at
 * www.silabs.com/about-us/legal/master-software-license-agreement. This
 * software is distributed to you in Source Code format and is governed by the
 * sections of the MSLA applicable to Source Code.
 *
 *****************************************************************************/
 
#ifndef OTA_CACHE_HPP
#define OTA_CACHE_HPP
 
// This component
#include "ota.hpp"
 
// Standard library
#include <memory>
#include <map>
#include <vector>
 
// Unify
#include "sys/ctimer.h"
 
using endpoint_cache_t = uint8_t;
 
typedef struct timeout_handler {
  std::string unid;
  std::string subscribe_topic;
  bool state = false;
  uic_ota::image_ready_funct_t image_ready_cb;
  struct ctimer timeout_timer;
} timeout_handler_t;
 
class TimeoutHandler
{
  std::shared_ptr<timeout_handler_t> timeout_data;
 
  public:
  TimeoutHandler() = default;
  TimeoutHandler(timeout_handler_t input_timeout_data) :
    timeout_data {std::make_unique<timeout_handler_t>(input_timeout_data)} {};
  TimeoutHandler &operator=(const TimeoutHandler &) = delete;
  TimeoutHandler(TimeoutHandler &&)                 = delete;
  TimeoutHandler &operator=(TimeoutHandler &&) = delete;
 
  ~TimeoutHandler();
 
  std::string get_unid() const;
  std::string get_subscribe_topic() const;
  bool get_unid_poll_state() const;
  void set_unid_poll_state(bool state) const;
  uic_ota::image_ready_funct_t get_image_ready_cb() const;
  ctimer *get_ctimer_pointer() const;
};
 
namespace image_file_handler
{
// Image meta info received
 
void set_image_meta_info(const std::string &key,
                         const uic_ota::meta_t &meta_info);
 
uic_ota::meta_t get_image_meta_info(const std::string &key);
 
void remove_image_meta_info(const std::string &key);
 
bool check_if_meta_info_received(const std::string &key);
 
// Cached image files
 
void set_images_received_cached_filepath(const std::string &key,
                                         const std::string &filepath);
 
std::string get_image_cached_filepath(const std::string &key);
 
bool is_image_received_and_cached(const std::string &key);
 
void clear_images_cache();
}  // namespace image_file_handler
 
namespace unid_state_handler
{
// Unid poll management
 
void set_unid_poll(std::shared_ptr<TimeoutHandler> timeout_handler);
 
void pop_unid_poll(const std::string &unid);
 
bool get_unid_poll_state(const std::string &unid);
 
void set_unid_poll_state_true(const std::string &unid);
 
bool is_unid_in_poll(const std::string &unid);
 
uic_ota::image_ready_funct_t get_unid_callback(const std::string &unid);
 
bool is_poll_topic_subscribed(const std::string &topic);
 
// Unid management
 
void set_unid_listening(const std::string &uiid, const std::string &unid);
 
std::vector<std::string> get_unids_listening(const std::string &uiid);
 
std::size_t get_unids_listening_count(const std::string &uiid);
 
void remove_unid_listening(const std::string &uiid, const std::string &unid);
 
std::vector<std::string>
  get_uiids_unid_is_listening_to(const std::string &unid);
 
std::map<std::string, std::vector<std::string>, std::less<>>
  get_uiids_and_unids_listening();
 
// Unid MQTT management
 
void set_status_published_cached(const dotdot_unid_t &unid,
                                 const dotdot_endpoint_id_t &ep);
 
bool is_status_published(const dotdot_unid_t &unid,
                         const dotdot_endpoint_id_t &ep);
 
std::map<std::string, std::vector<endpoint_cache_t>, std::less<>>
  get_map_status_published_cached_and_clear();
 
std::vector<endpoint_cache_t>
  get_endpoints_status_published_and_pop(const dotdot_unid_t &unid);
}  // namespace unid_state_handler
 
#endif  //OTA_CACHE_HPP