TunnelInterface.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_SERIAL_TUNNEL_INTERFACE_HPP_
#define ZEP_SERIAL_TUNNEL_INTERFACE_HPP_
 
#include <cstdint>
#include <future>
#include <memory>
#include <string>
#include <vector>
 
#include "../StreamInterface.hpp"
#include "../TimestampInterface.hpp"
#include "TunnelConfig.hpp"
 
namespace zep {
namespace serial {
 
class TunnelCallbackInterface;
 
class TunnelInterface : public StreamInterface {
 public:
  virtual bool GetRequestedConfig(TunnelConfig& config) const noexcept = 0;
 
  virtual std::shared_future<TunnelConfig> GetConfigRequestStatus()
      const noexcept = 0;
 
  virtual void SetAvailable(bool new_value) noexcept = 0;
 
  virtual void SetMaxPacketLength(std::size_t length) = 0;
 
  virtual void ResetQueue() = 0;
 
  virtual void Queue(TimestampInterface::Rep timestamp, const void* bytes,
                     std::size_t length) = 0;
 
  virtual void RegisterCallback(
      const std::shared_ptr<TunnelCallbackInterface>& listener,
      bool use_weak_ptr = false) = 0;
 
  virtual void RegisterCallback(
      std::unique_ptr<TunnelCallbackInterface>&& listener) = 0;
 
  virtual ~TunnelInterface() noexcept = default;
};
 
class TunnelCallbackInterface {
 public:
  enum class EventType {
    kUnknown = 0,
 
    kDisconnected,
 
    kUnlinked,
 
    kDepacketizeError,
 
    kDeactivated,
 
    kActivated,
  };
 
  virtual void OnRequestConfig(const TunnelConfig& config) = 0;
 
  virtual void OnNotifyTunnelEvent(EventType type, const std::string& message) {
  }
 
  virtual void OnReceivePacket(std::vector<std::uint8_t>&& bytes) = 0;
 
  virtual ~TunnelCallbackInterface() noexcept = default;
};
 
}  // namespace serial
}  // namespace zep
 
#endif  // ZEP_SERIAL_TUNNEL_INTERFACE_HPP_