:orphan:

.. index:: pair: group; Command Handler: Process/thread support
.. _doxid-group__rcf__ch__proc:

Command Handler: Process/thread support
=======================================

.. toctree::
	:hidden:

Overview
~~~~~~~~

A set of functions exported by a Test Agent to support interface of Command Handler for Test Agent thread and process manipulations. :ref:`More...<details-group__rcf__ch__proc>`


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

	
	// global functions

	int :ref:`rcf_ch_start_process<doxid-group__rcf__ch__proc_1gab3f63de6c0142aaaff2afdc20a7d75c9>`(pid_t* pid, int priority, const char* rtn, bool do_exec, int argc, void** params);
	int :ref:`rcf_ch_start_thread<doxid-group__rcf__ch__proc_1ga94a737e574b2c40f00381b752d91ce48>`(int* tid, int priority, const char* rtn, bool is_argv, int argc, void** params);
	int :ref:`rcf_ch_kill_process<doxid-group__rcf__ch__proc_1ga924eebe9ef2fda21330b05af9e924c28>`(unsigned int pid);
	int :ref:`rcf_ch_free_proc_data<doxid-group__rcf__ch__proc_1ga2be8c8bfd69477914380a2d4810a8713>`(unsigned int pid);
	int :ref:`rcf_ch_kill_thread<doxid-group__rcf__ch__proc_1gaf7f40e1649c9f0b98632e3fb69add2a4>`(unsigned int tid);

.. _details-group__rcf__ch__proc:

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

A set of functions exported by a Test Agent to support interface of Command Handler for Test Agent thread and process manipulations.

Global Functions
----------------

.. index:: pair: function; rcf_ch_start_process
.. _doxid-group__rcf__ch__proc_1gab3f63de6c0142aaaff2afdc20a7d75c9:

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

	int rcf_ch_start_process(pid_t* pid, int priority, const char* rtn, bool do_exec, int argc, void** params)

Start process on the Test Agent or NUT served by it.



.. rubric:: Parameters:

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

	*
		- pid

		- location of pid of the new task

	*
		- priority

		- priority of the new process or -1 if the priority is not specified in the command

	*
		- rtn

		- routine entry point name. It is expected that a function has the following argument list (int argc, char \*\*argv)

	*
		- do_exec

		- whether to do execve after fork() in a newly created process or just to call ``rtn`` function in a new process

	*
		- argc

		- number of arguments

	*
		- params

		- pointer to array of RCF_MAX_PARAMS length with routine arguments



.. rubric:: Returns:

Status code

.. index:: pair: function; rcf_ch_start_thread
.. _doxid-group__rcf__ch__proc_1ga94a737e574b2c40f00381b752d91ce48:

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

	int rcf_ch_start_thread(int* tid, int priority, const char* rtn, bool is_argv, int argc, void** params)

Start thread on the Test Agent or NUT served by it.



.. rubric:: Parameters:

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

	*
		- tid

		- location of tid of the new task

	*
		- priority

		- priority of the new process or -1 if the priority is not specified in the command

	*
		- rtn

		- routine entry point name

	*
		- is_argv

		- if ``true``, then routine prototype is (int argc, char \*\*argv)

	*
		- argc

		- number of arguments

	*
		- params

		- pointer to array of RCF_MAX_PARAMS length with routine arguments



.. rubric:: Returns:

Status code

.. index:: pair: function; rcf_ch_kill_process
.. _doxid-group__rcf__ch__proc_1ga924eebe9ef2fda21330b05af9e924c28:

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

	int rcf_ch_kill_process(unsigned int pid)

Kill the process on the Test Agent or NUT served by it.



.. rubric:: Parameters:

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

	*
		- pid

		- process identifier



.. rubric:: Returns:

Status code

.. index:: pair: function; rcf_ch_free_proc_data
.. _doxid-group__rcf__ch__proc_1ga2be8c8bfd69477914380a2d4810a8713:

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

	int rcf_ch_free_proc_data(unsigned int pid)

Free process data stored on the Test Agent.



.. rubric:: Parameters:

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

	*
		- pid

		- process identifier



.. rubric:: Returns:

Status code

.. index:: pair: function; rcf_ch_kill_thread
.. _doxid-group__rcf__ch__proc_1gaf7f40e1649c9f0b98632e3fb69add2a4:

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

	int rcf_ch_kill_thread(unsigned int tid)

Kill the thread on the Test Agent or NUT served by it.



.. rubric:: Parameters:

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

	*
		- tid

		- thread identifier



.. rubric:: Returns:

Status code