.. index:: pair: class; ProcessLauncherInterface
.. _doxid-class_process_launcher_interface:

class ProcessLauncherInterface
==============================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Functions for all process launchers. :ref:`More...<details-class_process_launcher_interface>`


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

	#include <process_launcher.h>
	
	class ProcessLauncherInterface: public :ref:`PtrTemplates<doxid-class_ptr_templates>` {
	public:
		// typedefs
	
		typedef :ref:`LaunchCommandInterface::ENGINE_RUNNING_STATUS<doxid-class_launch_command_interface_1a8f892914289fc45824ba408070b03056>` :target:`ENGINE_RUNNING_STATUS<doxid-class_process_launcher_interface_1ad958854e32d7a961c7bb07bd23e088b5>`;

		// fields
	
		static constexpr auto :target:`UNKNOWN<doxid-class_process_launcher_interface_1a8ce968ad8b7e9a8fd23b20032133cd11>` = LaunchCommandInterface::ENGINE_RUNNING_STATUS::UNKNOWN;
		static constexpr auto :target:`RUNNING<doxid-class_process_launcher_interface_1a29b24978e039d71a362509c857124e1a>` = LaunchCommandInterface::ENGINE_RUNNING_STATUS::RUNNING;
		static constexpr auto :target:`STOPPED<doxid-class_process_launcher_interface_1a57eb1ac4597c3c830bf9c876447e819e>` = LaunchCommandInterface::ENGINE_RUNNING_STATUS::STOPPED;

		// methods
	
		virtual std::string :ref:`launcherName<doxid-class_process_launcher_interface_1a525cd3685e3eff9a4d1ef17bf4ba06ab>`() const = 0;
		virtual :ref:`ProcessLauncherInterface::unique_ptr<doxid-class_ptr_templates_1a6d24e150817ba36df80ce3b603b7c665>` :ref:`createLauncher<doxid-class_process_launcher_interface_1a87f91cf3ab18586e9836f3c9215df6fd>`(int logFD = -1) = 0;
	
		virtual pid_t :ref:`launchProcess<doxid-class_process_launcher_interface_1af7dddf137ef184baf929d0d96f23de06>`(
			:ref:`nlohmann::json<doxid-engine__json__server_8cpp_1ab701e3ac61a85b337ec5c1abaad6742d>` procConfig,
			bool appendParentEnv = true
		) = 0;
	
		virtual pid_t :ref:`stopProcess<doxid-class_process_launcher_interface_1aaa751375567c0aae9f7a94604e03f2cf>`(unsigned int killWait) = 0;
		virtual :ref:`ENGINE_RUNNING_STATUS<doxid-class_launch_command_interface_1a8f892914289fc45824ba408070b03056>` :ref:`getProcessStatus<doxid-class_process_launcher_interface_1afecd8b121e9b5df59a47584a93809b94>`();
		:ref:`LaunchCommandInterface<doxid-class_launch_command_interface>`* :ref:`launchCommand<doxid-class_process_launcher_interface_1adde0e1c47dd675a2bf4e0d64cd8fea8f>`() const;
		void :ref:`setFileDescriptor<doxid-class_process_launcher_interface_1a64934c530d30a87b389f93402a36f80e>`(int logFD);
	};

	// direct descendants

	template <
		class PROCESS_LAUNCHER,
		const char* LAUNCHER_TYPE,
		class ... LAUNCHER_COMMANDS
	>
	class :ref:`ProcessLauncher<doxid-class_process_launcher>`;

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>`;

.. _details-class_process_launcher_interface:

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

Functions for all process launchers.

Methods
-------

.. index:: pair: function; launcherName
.. _doxid-class_process_launcher_interface_1a525cd3685e3eff9a4d1ef17bf4ba06ab:

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

	virtual std::string launcherName() const = 0

Get name of launcher.

.. index:: pair: function; createLauncher
.. _doxid-class_process_launcher_interface_1a87f91cf3ab18586e9836f3c9215df6fd:

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

	virtual :ref:`ProcessLauncherInterface::unique_ptr<doxid-class_ptr_templates_1a6d24e150817ba36df80ce3b603b7c665>` createLauncher(int logFD = -1) = 0

Create a new process launcher.



.. rubric:: Parameters:

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

	*
		- logFD

		- File descriptor to route stdout and stderror outputs in launched process

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

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

	virtual pid_t launchProcess(
		:ref:`nlohmann::json<doxid-engine__json__server_8cpp_1ab701e3ac61a85b337ec5c1abaad6742d>` procConfig,
		bool appendParentEnv = true
	) = 0

Fork a new process. Will read environment variables and start params from procConfig.



.. rubric:: Parameters:

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

	*
		- procConfig

		- Process Configuration. Env variables and start params take precedence over envParams and startParams

	*
		- appendParentEnv

		- Should parent env variables be appended to child process



.. rubric:: Returns:

Returns Process ID of child process on success

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

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

	virtual pid_t stopProcess(unsigned int killWait) = 0

Stop a running 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 indefinitely



.. rubric:: Returns:

Returns child PID on success, negative value on error

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

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

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

Get the current 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>`

.. index:: pair: function; launchCommand
.. _doxid-class_process_launcher_interface_1adde0e1c47dd675a2bf4e0d64cd8fea8f:

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

	:ref:`LaunchCommandInterface<doxid-class_launch_command_interface>`* launchCommand() const

Get Launch Command. If launchProcess has not yet been called, return nullptr.

.. index:: pair: function; setFileDescriptor
.. _doxid-class_process_launcher_interface_1a64934c530d30a87b389f93402a36f80e:

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

	void setFileDescriptor(int logFD)

Sets the file descriptor that will be used by the launched process to write stdout and stderror.



.. rubric:: Parameters:

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

	*
		- logFD

		- File descriptor to route stdout and stderror outputs in launched process