ClientInterface.hpp

/*
 * Copyright (c) 2022-2023, Soliton Systems K.K. All rights reserved.
 * Use in source and binary forms, with or without modification, 
 * is permitted provided that the following a condition is met:
 *
 * Use is permitted only in accordance with the terms and 
 * conditions set forth in the Software License Agreement available 
 * at https://zao-sdk.org/license-agreement/.
 */
#ifndef ZEP_CLIENT_INTERFACE_HPP_
#define ZEP_CLIENT_INTERFACE_HPP_
 
#include <cstdint>
#include <future>
#include <memory>
#include <string>
 
#include "audio/FactoryInterface.hpp"
#include "control/FactoryInterface.hpp"
#include "serial/FactoryInterface.hpp"
#include "video/FactoryInterface.hpp"
 
namespace spdlog { class logger; }
 
namespace zep {
 
class TimestampInterface;
class ClientCallbackInterface;
 
class ClientInterface {
 public:
  virtual void SetLinkPath(const std::string& link_path) = 0;
 
  virtual const std::string& GetLinkPath() const noexcept = 0;
 
  virtual void StartLink() = 0;
 
  virtual void StopLink() = 0;
 
  virtual bool IsLinked() const noexcept = 0;
 
  virtual std::shared_future<std::string> GetLinkStatus() const = 0;
 
  virtual bool IsConnectedToCloud() const noexcept = 0;
 
  virtual std::shared_future<void /*TODO*/> GetCloudConnectionStatus()
      const = 0;
 
  virtual std::unique_ptr<video::FactoryInterface> CreateVideoFactory() = 0;
 
  virtual std::unique_ptr<audio::FactoryInterface> CreateAudioFactory() = 0;
 
  virtual std::unique_ptr<serial::FactoryInterface> CreateSerialFactory() = 0;
 
  virtual std::unique_ptr<control::FactoryInterface> CreateControlFactory() = 0;
 
  virtual std::shared_ptr<TimestampInterface> CreateTimestamp(
      std::intmax_t numerator, std::intmax_t denominator) = 0;
 
  template <class Ratio>
  std::shared_ptr<TimestampInterface> CreateTimestamp() {
    return CreateTimestamp(Ratio::num, Ratio::den);
  }
 
  virtual void RegisterCallback(
      const std::shared_ptr<ClientCallbackInterface>& listener,
      bool use_weak_ptr = false) = 0;
 
  virtual void RegisterCallback(
      std::unique_ptr<ClientCallbackInterface>&& listener) = 0;
 
  virtual ~ClientInterface() noexcept = default;
};
 
class ClientCallbackInterface {
 public:
  virtual void OnLink() {}
 
  virtual void OnUnlink(bool stopped) {}
 
  virtual void OnConnectCloud(/*TODO*/) {}
 
  virtual void OnDisconnectCloud() {}
 
  virtual ~ClientCallbackInterface() noexcept = default;
};
 
}  // namespace zep
 
#endif  // ZEP_CLIENT_INTERFACE_HPP_