.. index:: pair: class; BasicFork
.. _doxid-class_basic_fork:

class BasicFork
===============

.. toctree::
	:hidden:

Overview
~~~~~~~~




.. ref-code-block:: cpp
	:class: doxyrest-overview-code-block

	#include <basic_fork.h>
	
	class BasicFork: public :ref:`LaunchCommand<doxid-class_launch_command>` {
	public:
		// methods
	
		virtual pid_t :ref:`launchProcess<doxid-class_basic_fork_1acbf68d0d2ec4a2156251409d821009ba>`(
			const :ref:`nlohmann::json<doxid-engine__json__server_8cpp_1ab701e3ac61a85b337ec5c1abaad6742d>`& launcherConfig,
			const std::string& procCmd,
			const std::vector<std::string>& envParams,
			const std::vector<std::string>& startParams,
			bool appendParentEnv = true,
			int logFD = -1
		);
	
		virtual pid_t :ref:`stopProcess<doxid-class_basic_fork_1aae277dcdfb3c8744fb0bdb22877573f2>`(unsigned int killWait);
		virtual :ref:`ENGINE_RUNNING_STATUS<doxid-class_launch_command_interface_1a8f892914289fc45824ba408070b03056>` :ref:`getProcessStatus<doxid-class_basic_fork_1a32b88a5458bad8e180972f2f664b6838>`();
	};

Inherited Members
-----------------

.. ref-code-block:: cpp
	:class: doxyrest-overview-inherited-code-block

	public:
		// typedefs
	
		typedef std::shared_ptr<T> :ref:`shared_ptr<doxid-class_ptr_templates_1a71a8266f22feaa7154763ceb94e25457>`;
		typedef std::shared_ptr<const T> :ref:`const_shared_ptr<doxid-class_ptr_templates_1ac36bfa374f3b63c85ba97d8cf953ce3b>`;
		typedef std::unique_ptr<T> :ref:`unique_ptr<doxid-class_ptr_templates_1a6d24e150817ba36df80ce3b603b7c665>`;
		typedef std::unique_ptr<const T> :ref:`const_unique_ptr<doxid-class_ptr_templates_1aef0eb44f9c386dbf0de54d0f5afac667>`;

		// enums
	
		enum :ref:`ENGINE_RUNNING_STATUS<doxid-class_launch_command_interface_1a8f892914289fc45824ba408070b03056>`;

		// fields
	
		static constexpr auto :ref:`LaunchType<doxid-class_launch_command_1a685e087bb1092d0af2ff194c82f8f258>` = :ref:`LAUNCH_COMMAND<doxid-basic__fork_8h_1aa53475dce0eeddd9471c0bf490572cdf>`;

		// methods
	
		virtual pid_t :ref:`launchProcess<doxid-class_launch_command_interface_1aa1bac47eaee5e0f765c487d0e24b7459>`(
			const :ref:`nlohmann::json<doxid-engine__json__server_8cpp_1ab701e3ac61a85b337ec5c1abaad6742d>`& launcherConfig,
			const std::string& procCmd,
			const std::vector<std::string>& envParams,
			const std::vector<std::string>& startParams,
			bool appendParentEnv = true,
			int logFD = -1
		) = 0;
	
		virtual pid_t :ref:`stopProcess<doxid-class_launch_command_interface_1a627600e98455a7ecc98412fcaeecce6d>`(unsigned int killWait) = 0;
		virtual :ref:`ENGINE_RUNNING_STATUS<doxid-class_launch_command_interface_1a8f892914289fc45824ba408070b03056>` :ref:`getProcessStatus<doxid-class_launch_command_interface_1a67559c48de23dcd6f2b75f3098d555bc>`();
		virtual std::string_view :ref:`launchType<doxid-class_launch_command_interface_1af7464a527670dca6eee742f649d356b3>`() const = 0;
		virtual std::string_view :ref:`launchType<doxid-class_launch_command_1add06b48328f56f21f9e51760bc89331a>`() const;

.. _details-class_basic_fork:

Detailed Documentation
~~~~~~~~~~~~~~~~~~~~~~



Methods
-------

.. index:: pair: function; launchProcess
.. _doxid-class_basic_fork_1acbf68d0d2ec4a2156251409d821009ba:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual pid_t launchProcess(
		const :ref:`nlohmann::json<doxid-engine__json__server_8cpp_1ab701e3ac61a85b337ec5c1abaad6742d>`& launcherConfig,
		const std::string& procCmd,
		const std::vector<std::string>& envParams,
		const std::vector<std::string>& startParams,
		bool appendParentEnv = true,
		int logFD = -1
	)

Fork a new process for the given engine. Will read environment variables and start params from engineConfig The function should take the environment parameters and start parameters defined in engineConfig, and append any additional strings defined in envParams and startParams before starting the Engine specified in engineConfig. If appendParentEnv is set to true, use the parent environment in the forked child. If set to false, scrub the environment before continuing.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- launcherConfig

		- Configuration specific to the launch command

	*
		- procCmd

		- Process command

	*
		- envParams

		- Additional Environment Variables for Engine process. Will take precedence over default env params if appendParentEnv is true

	*
		- startParams

		- Additional Start parameters

	*
		- appendParentEnv

		- Should parent env variables be appended to Engine process



.. rubric:: Returns:

Returns PID of child process on success

.. index:: pair: function; stopProcess
.. _doxid-class_basic_fork_1aae277dcdfb3c8744fb0bdb22877573f2:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual pid_t stopProcess(unsigned int killWait)

Stop a running engine process.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- killWait

		- Time (in seconds) to wait for process to quit by itself before force killing it. 0 means it will wait indefinetly



.. rubric:: Returns:

Returns 0 on success, negative value on error

.. index:: pair: function; getProcessStatus
.. _doxid-class_basic_fork_1a32b88a5458bad8e180972f2f664b6838:

.. ref-code-block:: cpp
	:class: doxyrest-title-code-block

	virtual :ref:`ENGINE_RUNNING_STATUS<doxid-class_launch_command_interface_1a8f892914289fc45824ba408070b03056>` getProcessStatus()

Get the current engine process status. If status cannot be retrieved, return ENGINE_RUNNING_STATUS::UNKNOWN.



.. rubric:: Returns:

Returns status as enum :ref:`ProcessLauncherInterface::ENGINE_RUNNING_STATUS <doxid-class_process_launcher_interface_1ad958854e32d7a961c7bb07bd23e088b5>`