process.h

Go to the documentation of this file.

// Copyright (c) Space-ng, inc. All rights reserved.
 
#pragma once
 
#include "sol3/asio/strand.h"
#include "sol3/core/async_periodic.h"
#include "sol3/core/msg/stamp.h"
#include "sol3/process_manager/msg/process_manager_config.h"
#include "sol3/process_manager/msg/process_manager_telemetry.h"
 
#include <boost/asio/io_context.hpp>
#include <boost/process/child.hpp>
#include <boost/process/v2.hpp>
#include <boost/process/v2/stdio.hpp>
 
#include <cstdint>
#include <memory>
#include <optional>
 
namespace sol3::process_manager {
 
namespace bpv2 = boost::process::v2;
 
class Process;
 
using ExitHandler = std::function<void(std::shared_ptr<Process> process)>;
 
enum class ProcessInvocationState {
  failed_to_start,  
  running,   
  stopping,  
  stopped,   
};
 
struct ProcessInvocation {
  boost::process::v2::process child;
  std::vector<ExitHandler> exit_handlers;
  core::msg::Stamp started;
  ProcessInvocationState state;
  std::optional<core::msg::Stamp> stopped = std::nullopt;
  bool sent_sigterm = false;
  bool sent_sigkill = false;
  bool auto_restart_disabled = false;
};
 
class IStdioContext {
 public:
  virtual ~IStdioContext() = default;
  virtual bpv2::process_stdio getProcessStdio() = 0;
};
 
class Process : public std::enable_shared_from_this<Process> {
 public:
  static std::shared_ptr<Process> create(
      asio::Strand strand,
      msg::ProcessConfigT config,
      std::optional<ExitHandler> exit_handler = {},
      std::shared_ptr<IStdioContext> stdio_context = {});
 
  void asyncStart(bool reset_restart_count = false);
 
  void asyncRestart(bool reset_restart_count = false);
 
  void asyncStop(std::optional<ExitHandler> on_exit = {});
 
  void asyncSetLifecycleManagement(bool enabled);
 
  msg::ProcessTelemetryT telemetry() const;
 
  msg::ProcessConfigT const& config() const;
 
 private:
  Process(
      asio::Strand strand,
      msg::ProcessConfigT config,
      std::optional<ExitHandler> exit_handler,
      std::shared_ptr<IStdioContext> stdio_context);
 
  void start(bool reset_restarts);
 
  void restart(bool reset_restarts);
 
  void stop(std::optional<ExitHandler> on_exit);
 
  void kill();
 
  msg::ProcessConfigT config_;
  std::vector<ExitHandler> exit_handlers_;
  std::shared_ptr<IStdioContext> process_stdio_;
  bool lifecycle_managed_{false};
  uint16_t restart_count_{0};
  std::optional<ProcessInvocation> current_;
 
  asio::Strand strand_;
  boost::asio::steady_timer restart_timer_;
};
 
}  // namespace sol3::process_manager