:orphan:

.. index:: pair: group; Configurator API for Agent job control (tapi_cfg_job)
.. _doxid-group__tapi__cfg__job:

Configurator API for Agent job control (tapi_cfg_job)
=====================================================

.. toctree::
	:hidden:

	enum_cfg_job_exit_status_type_t.rst
	struct_cfg_job_exit_status_t.rst

Overview
~~~~~~~~

Configurator API for Agent job control. :ref:`More...<details-group__tapi__cfg__job>`


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

	
	// typedefs

	typedef enum :ref:`cfg_job_exit_status_type_t<doxid-group__tapi__cfg__job_1ga94b5a787165537547ea3777374e729a6>` :ref:`cfg_job_exit_status_type_t<doxid-group__tapi__cfg__job_1gafd0473bc6f96f4d145708936ceef6bb9>`;
	typedef struct :ref:`cfg_job_exit_status_t<doxid-structcfg__job__exit__status__t>` :ref:`cfg_job_exit_status_t<doxid-group__tapi__cfg__job_1gab693e98c31189c212efa51549cd77647>`;

	// enums

	enum :ref:`cfg_job_exit_status_type_t<doxid-group__tapi__cfg__job_1ga94b5a787165537547ea3777374e729a6>`;

	// structs

	struct :ref:`cfg_job_exit_status_t<doxid-structcfg__job__exit__status__t>`;

	// global variables

	const :ref:`tapi_job_methods_t<doxid-structtapi__job__methods__t>` :ref:`cfg_job_methods<doxid-group__tapi__cfg__job_1ga452147b6f73ac1ff6c3da8b3768cc87b>`;
	:ref:`tapi_job_method_create<doxid-group__tapi__job__methods_1ga23c5a83491412bd57c436b83751b146f>` :ref:`cfg_job_create<doxid-group__tapi__cfg__job_1gaea2ee735735513b83b421bb86de75107>`;
	:ref:`tapi_job_method_start<doxid-group__tapi__job__methods_1ga8d32cb3fcafea43a9c4b41ddf7c5893d>` :ref:`cfg_job_start<doxid-group__tapi__cfg__job_1ga1e25acadb9135609f3b20770c8398d7b>`;
	:ref:`tapi_job_method_kill<doxid-group__tapi__job__methods_1gaf8102ad590269a444dd1f2467103c8e1>` :ref:`cfg_job_kill<doxid-group__tapi__cfg__job_1ga9c57ac38933cb43d05fb9f0b238771fe>`;
	:ref:`tapi_job_method_killpg<doxid-group__tapi__job__methods_1ga07f6b33110a2408a66190d4d0c06a8ca>` :ref:`cfg_job_killpg<doxid-group__tapi__cfg__job_1ga07ec053ed783ba193244c7bd431e8df3>`;
	:ref:`tapi_job_method_wait<doxid-group__tapi__job__methods_1gac80c60db0e97fc61a08a7a97a688ca20>` :ref:`cfg_job_wait<doxid-group__tapi__cfg__job_1gad288f148aa3fbbe1ec9a0f7989f22715>`;
	:ref:`tapi_job_method_stop<doxid-group__tapi__job__methods_1ga1c9a9975b044510cc5c1f94604442368>` :ref:`cfg_job_stop<doxid-group__tapi__cfg__job_1ga96cd5b1735a8f90dbf67249f40b9f2ae>`;
	:ref:`tapi_job_method_destroy<doxid-group__tapi__job__methods_1ga1338f6840b49b2efd82e7fdc78acadd3>` :ref:`cfg_job_destroy<doxid-group__tapi__cfg__job_1gacf1c9ce313571353c1dca7a95cbc2a59>`;
	:ref:`tapi_job_method_set_workdir<doxid-group__tapi__job__methods_1ga1e717c4770a3bd2a5bdba5983f84b720>` :ref:`cfg_job_set_workdir<doxid-group__tapi__cfg__job_1ga1540910245bbfd8036eb1f2619bc603b>`;
	:ref:`tapi_job_method_set_autorestart<doxid-group__tapi__job__methods_1gaaab583fd53084cc880e3f489ce5fdf37>` :ref:`cfg_job_set_autorestart<doxid-group__tapi__cfg__job_1gac8ce8a8535bd285e00e1e50f2a78b3f3>`;
	:ref:`tapi_job_method_get_autorestart<doxid-group__tapi__job__methods_1ga1a6d3ffa3640e9e2351d4313e1c2c624>` :ref:`cfg_job_get_autorestart<doxid-group__tapi__cfg__job_1ga98834c667c25449c23ed52dcd63b08ff>`;
	:ref:`tapi_job_method_recreate<doxid-group__tapi__job__methods_1ga4c20c26419a89e6a9e6779986eb37bc7>` :ref:`cfg_job_recreate<doxid-group__tapi__cfg__job_1ga50238eceb2ccfcdb5ac5fb4b021f0a28>`;

.. _details-group__tapi__cfg__job:

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

Configurator API for Agent job control. Since the API is based on "/agent/process" Configurator subtree, terms "job" and "process" are used interchangeably in this file.

Copyright (C) 2020-2022 OKTET Labs Ltd. All rights reserved.

Typedefs
--------

.. index:: pair: typedef; cfg_job_exit_status_type_t
.. _doxid-group__tapi__cfg__job_1gafd0473bc6f96f4d145708936ceef6bb9:

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

	typedef enum :ref:`cfg_job_exit_status_type_t<doxid-group__tapi__cfg__job_1ga94b5a787165537547ea3777374e729a6>` cfg_job_exit_status_type_t

Cause of process termination

.. index:: pair: typedef; cfg_job_exit_status_t
.. _doxid-group__tapi__cfg__job_1gab693e98c31189c212efa51549cd77647:

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

	typedef struct :ref:`cfg_job_exit_status_t<doxid-structcfg__job__exit__status__t>` cfg_job_exit_status_t

Structure that represents status of a terminated process

Global Variables
----------------

.. index:: pair: variable; cfg_job_methods
.. _doxid-group__tapi__cfg__job_1ga452147b6f73ac1ff6c3da8b3768cc87b:

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

	const :ref:`tapi_job_methods_t<doxid-structtapi__job__methods__t>` cfg_job_methods

Methods for job created by CFG factory

.. index:: pair: variable; cfg_job_create
.. _doxid-group__tapi__cfg__job_1gaea2ee735735513b83b421bb86de75107:

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

	:ref:`tapi_job_method_create<doxid-group__tapi__job__methods_1ga23c5a83491412bd57c436b83751b146f>` cfg_job_create

Create a job



.. rubric:: See also:

:ref:`tapi_job_method_create <doxid-group__tapi__job__methods_1ga23c5a83491412bd57c436b83751b146f>`

.. index:: pair: variable; cfg_job_start
.. _doxid-group__tapi__cfg__job_1ga1e25acadb9135609f3b20770c8398d7b:

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

	:ref:`tapi_job_method_start<doxid-group__tapi__job__methods_1ga8d32cb3fcafea43a9c4b41ddf7c5893d>` cfg_job_start

Start a job



.. rubric:: See also:

:ref:`tapi_job_method_start <doxid-group__tapi__job__methods_1ga8d32cb3fcafea43a9c4b41ddf7c5893d>`

.. index:: pair: variable; cfg_job_kill
.. _doxid-group__tapi__cfg__job_1ga9c57ac38933cb43d05fb9f0b238771fe:

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

	:ref:`tapi_job_method_kill<doxid-group__tapi__job__methods_1gaf8102ad590269a444dd1f2467103c8e1>` cfg_job_kill

Send a signal to the job



.. rubric:: See also:

:ref:`tapi_job_method_kill <doxid-group__tapi__job__methods_1gaf8102ad590269a444dd1f2467103c8e1>`

.. index:: pair: variable; cfg_job_killpg
.. _doxid-group__tapi__cfg__job_1ga07ec053ed783ba193244c7bd431e8df3:

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

	:ref:`tapi_job_method_killpg<doxid-group__tapi__job__methods_1ga07f6b33110a2408a66190d4d0c06a8ca>` cfg_job_killpg

Send a signal to the job's proccess group



.. rubric:: See also:

:ref:`tapi_job_method_killpg <doxid-group__tapi__job__methods_1ga07f6b33110a2408a66190d4d0c06a8ca>`

.. index:: pair: variable; cfg_job_wait
.. _doxid-group__tapi__cfg__job_1gad288f148aa3fbbe1ec9a0f7989f22715:

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

	:ref:`tapi_job_method_wait<doxid-group__tapi__job__methods_1gac80c60db0e97fc61a08a7a97a688ca20>` cfg_job_wait

Wait for a job completion

Negative ``timeout_ms`` blocks the test execution until the job changes its status. Zero return value may also mean that the job was never started.



.. rubric:: See also:

:ref:`tapi_job_method_wait <doxid-group__tapi__job__methods_1gac80c60db0e97fc61a08a7a97a688ca20>`

.. index:: pair: variable; cfg_job_stop
.. _doxid-group__tapi__cfg__job_1ga96cd5b1735a8f90dbf67249f40b9f2ae:

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

	:ref:`tapi_job_method_stop<doxid-group__tapi__job__methods_1ga1c9a9975b044510cc5c1f94604442368>` cfg_job_stop

Stop a job

Parameters ``signo`` and ``term_timeout_ms`` are ignored, use ``-1`` to avoid warnings



.. rubric:: See also:

:ref:`tapi_job_method_stop <doxid-group__tapi__job__methods_1ga1c9a9975b044510cc5c1f94604442368>`

.. index:: pair: variable; cfg_job_destroy
.. _doxid-group__tapi__cfg__job_1gacf1c9ce313571353c1dca7a95cbc2a59:

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

	:ref:`tapi_job_method_destroy<doxid-group__tapi__job__methods_1ga1338f6840b49b2efd82e7fdc78acadd3>` cfg_job_destroy

Destroy a job

Parameter ``term_timeout_ms`` is ignored, use ``-1`` to avoid warning



.. rubric:: See also:

:ref:`tapi_job_method_destroy <doxid-group__tapi__job__methods_1ga1338f6840b49b2efd82e7fdc78acadd3>`

.. index:: pair: variable; cfg_job_set_workdir
.. _doxid-group__tapi__cfg__job_1ga1540910245bbfd8036eb1f2619bc603b:

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

	:ref:`tapi_job_method_set_workdir<doxid-group__tapi__job__methods_1ga1e717c4770a3bd2a5bdba5983f84b720>` cfg_job_set_workdir

Set new working directory for a job.

This function should be called before the job is started.



.. rubric:: See also:

:ref:`tapi_job_method_set_workdir <doxid-group__tapi__job__methods_1ga1e717c4770a3bd2a5bdba5983f84b720>`

.. index:: pair: variable; cfg_job_set_autorestart
.. _doxid-group__tapi__cfg__job_1gac8ce8a8535bd285e00e1e50f2a78b3f3:

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

	:ref:`tapi_job_method_set_autorestart<doxid-group__tapi__job__methods_1gaaab583fd53084cc880e3f489ce5fdf37>` cfg_job_set_autorestart

Set autorestart timeout for a job

This function should be called before the job is started



.. rubric:: See also:

:ref:`tapi_job_method_set_autorestart <doxid-group__tapi__job__methods_1gaaab583fd53084cc880e3f489ce5fdf37>`

.. index:: pair: variable; cfg_job_get_autorestart
.. _doxid-group__tapi__cfg__job_1ga98834c667c25449c23ed52dcd63b08ff:

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

	:ref:`tapi_job_method_get_autorestart<doxid-group__tapi__job__methods_1ga1a6d3ffa3640e9e2351d4313e1c2c624>` cfg_job_get_autorestart

Get autorestart timeout of a job



.. rubric:: See also:

:ref:`tapi_job_method_get_autorestart <doxid-group__tapi__job__methods_1ga1a6d3ffa3640e9e2351d4313e1c2c624>`

.. index:: pair: variable; cfg_job_recreate
.. _doxid-group__tapi__cfg__job_1ga50238eceb2ccfcdb5ac5fb4b021f0a28:

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

	:ref:`tapi_job_method_recreate<doxid-group__tapi__job__methods_1ga4c20c26419a89e6a9e6779986eb37bc7>` cfg_job_recreate

Retrieve information about a job from Configurator

At this moment the function only checks that a process corresponding to the job exists, but later it might be extended to extract additional job data



.. rubric:: See also:

:ref:`tapi_job_method_recreate <doxid-group__tapi__job__methods_1ga4c20c26419a89e6a9e6779986eb37bc7>`