tcp_connection.h

Go to the documentation of this file.

// Copyright (c) Space-ng, inc. All rights reserved.
 
#pragma once
 
#include "sol3/net/connection_handler.h"
#include "sol3/net/framer.h"
#include "sol3/net/tcp_connection_id.h"
#include "sol3/net/tcp_telemetry.h"
#include "sol3/net/write_queue.h"
 
#include <boost/asio/any_io_executor.hpp>
#include <boost/asio/ip/tcp.hpp>
#include <boost/asio/strand.hpp>
 
namespace sol3::net {
 
struct TcpConnectionConfig {
  TcpConnectionId id;
  size_t read_buffer_bytes{};
  bool automatic_read{true};
  bool graceful_eof{false};
  std::chrono::steady_clock::duration sample_kernel_queue_period;
};
 
class TcpConnection : public std::enable_shared_from_this<TcpConnection> {
 public:
  using tcp = boost::asio::ip::tcp;
 
  TcpConnection(
      TcpConnectionConfig const& config,
      boost::asio::io_context& io,
      tcp::socket&& socket,
      std::unique_ptr<IFramer>&& framer,
      std::weak_ptr<IConnectionHandler> handler,
      TcpTelemetry& server_telemetry);
 
  ~TcpConnection() { close(); }
 
  void start();
  void sendFrame(std::shared_ptr<std::vector<uint8_t> const> frame);
  void close();
  void requestRead();
  std::string localEndpoint() const;
  std::string remoteEndpoint() const;
  TcpConnectionId id() const { return config_.id; }
  bool isOpen() const { return !closed_; }
 
 private:
  void doRead();
  void doWrite();
 
  // Sample the kernel queues periodically.
  // Ensures telemetry is not stale on a quiescent connection.
  void doSampleKernelQueue();
 
  TcpConnectionConfig config_;
  boost::asio::io_context& io_;
  boost::asio::strand<boost::asio::any_io_executor> strand_;
  tcp::socket socket_;
  std::unique_ptr<IFramer> framer_;
  std::weak_ptr<IConnectionHandler> handler_;
  TcpTelemetry& telemetry_;
  boost::asio::steady_timer sample_kernel_queue_timer_;
  bool is_reading_{false};
  std::atomic<bool> closing_{false};
  std::atomic<bool> closed_{false};
 
  // Bytes read from the socket
  std::vector<uint8_t> read_buffer_;
 
  // Queued data to write to the socket
  WriteQueue send_queue_;
};
 
}  // namespace sol3::net