Class RPCServer

include/mgmt/rpc/server/RPCServer.h:48–87

@brief RPC Server implementation for the JSONRPC Logic. This class holds a transport which implements @see BaseCommInterface Objects of this class can start @see start_thread , stop @see stop_thread the server at any? time. More than one instance of this class can be created as long as they use different transport configuration.

/// Objects of this class can start @see start_thread , stop @see stop_thread the server at any? time. More than one instance of
/// this class can be created as long as they use different transport configuration.
class RPCServer
{
public:
  RPCServer() = default;
  ///
  /// @brief Construct a new Rpc Server object
  ///        This function have one main goal, select the transport type base on the configuration and  initialize it.
  ///
  /// @throw std::runtime_error if:
  ///        1 - It the configured transport isn't valid for the server to create it, then an exception will be thrown.
  ///        2 - The transport layer cannot be initialized.
  /// @param conf the configuration object.
  ///
  RPCServer(config::RPCConfig const &conf);

  /// @brief The destructor will join the thread.
  ~RPCServer();

  /// @brief Returns a descriptive name that was set by the transport. Check @see BaseCommInterface
  std::string_view selected_comm_name() const noexcept;

  /// @brief Thread function that runs the transport.
  void start_thread(std::function<TSThread()> const     &cb_init    = std::function<TSThread()>(),
                    std::function<void(TSThread)> const &cb_destroy = std::function<void(TSThread)>());

  /// @brief Function to stop the transport and join the thread to finish.
  void stop_thread();

private:
  /// @brief Actual thread routine. This will start the socket.
  static void *run_thread(void *);

  std::function<TSThread()>     _init;
  std::function<void(TSThread)> _destroy;
  ink_thread                    _this_thread{ink_thread_null()};
  TSThread                      _rpcThread{nullptr};

  std::thread                              running_thread;
  std::unique_ptr<comm::BaseCommInterface> _socketImpl;
};
} // namespace rpc

extern rpc::RPCServer *jsonrpcServer;