ITransport.h

Go to the documentation of this file.

//
// Copyright (c) 2023 SICK AG, Waldkirch
//
// SPDX-License-Identifier: Unlicense
 
#pragma once
 
#include <cstddef>
#include <cstdint>
#include <vector>
 
#if !defined(_WIN32)
// we assume something Linux'ish here
#  include <sys/types.h> // for ssize_t
#endif
 
namespace visionary {
 
class ITransport
{
public:
  using ByteBuffer = std::vector<std::uint8_t>;
 
#if defined(_WIN32)
  using send_return_t = int;
  using recv_return_t = int;
#else
  using send_return_t = ssize_t;
  using recv_return_t = ssize_t;
#endif
 
  virtual ~ITransport() = default; // destructor, use it to call destructor of the inherit classes
 
  virtual int shutdown()     = 0;
  virtual int getLastError() = 0;
 
  template <typename T>
  send_return_t send(const std::vector<T>& buffer)
  {
    return send(reinterpret_cast<const char*>(buffer.data()), buffer.size() * sizeof(T));
  }
 
  virtual recv_return_t recv(ByteBuffer& buffer, std::size_t maxBytesToReceive) = 0;
 
  virtual recv_return_t read(ByteBuffer& buffer, std::size_t nBytesToReceive) = 0;
 
protected:
  virtual send_return_t send(const char* pData, size_t size) = 0;
};
 
} // namespace visionary