device_mqtt.hpp

Go to the documentation of this file.

// (C) Copyright 2025, SECO Mind Srl
//
// SPDX-License-Identifier: Apache-2.0
 
#ifndef ASTARTE_DEVICE_SDK_DEVICE_MQTT_H
#define ASTARTE_DEVICE_SDK_DEVICE_MQTT_H

 
#include <chrono>
#include <filesystem>
#include <list>
#include <memory>
#include <optional>
#include <string>
#include <string_view>
 
#include "astarte_device_sdk/data.hpp"
#include "astarte_device_sdk/device.hpp"
#include "astarte_device_sdk/mqtt/config.hpp"
#include "astarte_device_sdk/mqtt/errors.hpp"
#include "astarte_device_sdk/msg.hpp"
#include "astarte_device_sdk/object.hpp"
#include "astarte_device_sdk/ownership.hpp"
#include "astarte_device_sdk/property.hpp"
#include "astarte_device_sdk/stored_property.hpp"

namespace astarte::device::mqtt {

class DeviceMqtt : public Device {
 public:
  [[nodiscard]] static auto create(Config cfg) -> astarte_tl::expected<DeviceMqtt, Error>;

  ~DeviceMqtt() override;

  DeviceMqtt(DeviceMqtt& other) = delete;

  auto operator=(DeviceMqtt& other) -> DeviceMqtt& = delete;

  DeviceMqtt(DeviceMqtt&& other) = default;

  auto operator=(DeviceMqtt&& other) -> DeviceMqtt& = default;

  auto add_interface_from_file(const std::filesystem::path& json_file)
      -> astarte_tl::expected<void, Error> override;

  auto add_interface_from_str(std::string_view json) -> astarte_tl::expected<void, Error> override;

  auto remove_interface(const std::string& interface_name)
      -> astarte_tl::expected<void, Error> override;

  auto connect() -> astarte_tl::expected<void, Error> override;

  [[nodiscard]] auto is_connected() const -> bool override;

  auto disconnect() -> astarte_tl::expected<void, Error> override;

  auto send_individual(std::string_view interface_name, std::string_view path, const Data& data,
                       const std::chrono::system_clock::time_point* timestamp)
      -> astarte_tl::expected<void, Error> override;

  auto send_object(std::string_view interface_name, std::string_view path,
                   const DatastreamObject& object,
                   const std::chrono::system_clock::time_point* timestamp)
      -> astarte_tl::expected<void, Error> override;

  auto set_property(std::string_view interface_name, std::string_view path, const Data& data)
      -> astarte_tl::expected<void, Error> override;

  auto unset_property(std::string_view interface_name, std::string_view path)
      -> astarte_tl::expected<void, Error> override;

  auto poll_incoming(const std::chrono::milliseconds& timeout) -> std::optional<Message> override;

  auto get_all_properties(const std::optional<Ownership>& ownership)
      -> astarte_tl::expected<std::list<StoredProperty>, Error> override;

  auto get_properties(std::string_view interface_name)
      -> astarte_tl::expected<std::list<StoredProperty>, Error> override;

  auto get_property(std::string_view interface_name, std::string_view path)
      -> astarte_tl::expected<PropertyIndividual, Error> override;
 
 private:
  struct DeviceMqttImpl;
  std::shared_ptr<DeviceMqttImpl> astarte_device_impl_;

  explicit DeviceMqtt(std::shared_ptr<DeviceMqttImpl> impl);
};
 
}  // namespace astarte::device::mqtt
 
#endif  // ASTARTE_DEVICE_SDK_DEVICE_MQTT_H