TunnelInterface.hpp

#ifndef ZAO_ENDPOINT_SERIAL_TUNNEL_INTERFACE_HPP_
#define ZAO_ENDPOINT_SERIAL_TUNNEL_INTERFACE_HPP_
 
#include <cassert>
#include <cstdint>
#include <cstring>
#include <future>
#include <memory>
#include <string>
#include <vector>
 
#include "../EventSourceInterface.hpp"
#include "../StreamInterface.hpp"
#include "../TimestampInterface.hpp"
#include "ChunkSinkBufferDequeueResult.hpp"
#include "ChunkSinkBufferEnqueueResult.hpp"
#include "ChunkSinkBufferInterface.hpp"
#include "ChunkSourceBufferDequeueResult.hpp"
#include "ChunkSourceBufferEnqueueResult.hpp"
#include "ChunkSourceBufferInterface.hpp"
#include "TunnelConfig.hpp"
 
namespace zao {
namespace endpoint {
namespace serial {
 
class TunnelCallbackInterface;
 
class TunnelInterface : public StreamInterface,
                        public EventSourceInterface<TunnelCallbackInterface> {
 public:
  virtual bool GetRequestedConfig(TunnelConfig& config) const = 0;
 
  [[deprecated("Please use GetRequestedConfigAsync")]]
  std::shared_future<TunnelConfig> GetConfigRequestStatus() const {
    return GetRequestedConfigAsync();
  }
 
  virtual std::shared_future<TunnelConfig> GetRequestedConfigAsync() const = 0;
 
  virtual void SetAvailable(bool new_value) = 0;
 
  [[deprecated("Please use ConfigureQueue")]]
  void SetMaxPacketLength(std::size_t length) {
    ConfigureQueue(length, 0);
  }
 
  virtual void ConfigureQueue(std::size_t bytes_per_buffer,
                              std::size_t num_of_buffers) = 0;
 
  virtual ChunkSourceBufferDequeueResult DequeueSourceBuffer() = 0;
 
  virtual ChunkSourceBufferEnqueueResult EnqueueSourceBuffer(
      std::unique_ptr<ChunkSourceBufferInterface> buffer) = 0;
 
  virtual ChunkSinkBufferDequeueResult DequeueSinkBuffer() = 0;
 
  virtual ChunkSinkBufferEnqueueResult EnqueueSinkBuffer(
      std::unique_ptr<ChunkSinkBufferInterface> buffer) = 0;
 
  virtual void FlushQueue() = 0;
 
  void ResetQueue() { FlushQueue(); }
 
  [[deprecated("Please use DequeueSourceBuffer/EnqueueSourceBuffer")]]
  void Queue(TimestampInterface::Rep timestamp, const void* bytes,
             std::size_t length) {
    auto result = DequeueSourceBuffer();
    auto buffer = result.TakeBuffer();
    if (!buffer) {
      return;
    }
    assert(buffer->GetCapacity() >= length);
    std::memcpy(buffer->GetPointer(), bytes, length);
    buffer->SetLength(length);
    buffer->SetTimestamp(timestamp);
    EnqueueSourceBuffer(std::move(buffer));
  }
 
  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) {
  }
 
#ifndef LIBZAO_ENDPOINT_INTERNAL
  [[deprecated("Never called when new pull-type API is selected.")]]
#endif
  virtual void OnReceivePacket(std::vector<std::uint8_t>&& bytes) {
    (void)bytes;
  }
 
  virtual ~TunnelCallbackInterface() noexcept = default;
};
 
}  // namespace serial
}  // namespace endpoint
}  // namespace zao
 
#endif  // ZAO_ENDPOINT_SERIAL_TUNNEL_INTERFACE_HPP_