:orphan:

.. index:: pair: struct; tapi_job_methods_t
.. _doxid-structtapi__job__methods__t:

struct tapi_job_methods_t
=========================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Methods to operate TAPI Job instances :ref:`More...<details-structtapi__job__methods__t>`


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

	#include <tapi_job_methods.h>
	
	struct tapi_job_methods_t {
		// fields
	
		:ref:`tapi_job_method_create<doxid-group__tapi__job__methods_1ga23c5a83491412bd57c436b83751b146f>`* :ref:`create<doxid-structtapi__job__methods__t_1a7451793ce81b8d914a3d138dce6d3218>`;
		:ref:`tapi_job_method_start<doxid-group__tapi__job__methods_1ga8d32cb3fcafea43a9c4b41ddf7c5893d>`* :ref:`start<doxid-structtapi__job__methods__t_1a77b958d20f2cc22c257df16ab9946f68>`;
		:ref:`tapi_job_method_allocate_channels<doxid-group__tapi__job__methods_1gad7a5d99921de1c9f6cd1eebeb9a04a1e>`* :ref:`allocate_channels<doxid-structtapi__job__methods__t_1a9a5f5a4ce5d136f2479eaadf542d0686>`;
		:ref:`tapi_job_method_kill<doxid-group__tapi__job__methods_1gaf8102ad590269a444dd1f2467103c8e1>`* :ref:`kill<doxid-structtapi__job__methods__t_1aefdfa00a4499be881397218a3524058d>`;
		:ref:`tapi_job_method_killpg<doxid-group__tapi__job__methods_1ga07f6b33110a2408a66190d4d0c06a8ca>`* :ref:`killpg<doxid-structtapi__job__methods__t_1aba01aeb02cee683602f473903ae17b93>`;
		:ref:`tapi_job_method_wait<doxid-group__tapi__job__methods_1gac80c60db0e97fc61a08a7a97a688ca20>`* :ref:`wait<doxid-structtapi__job__methods__t_1aed8b232ca318e9df02a2fb47ee6645f6>`;
		:ref:`tapi_job_method_stop<doxid-group__tapi__job__methods_1ga1c9a9975b044510cc5c1f94604442368>`* :ref:`stop<doxid-structtapi__job__methods__t_1a11fa52d1d8cb036025e47bd074039e52>`;
		:ref:`tapi_job_method_destroy<doxid-group__tapi__job__methods_1ga1338f6840b49b2efd82e7fdc78acadd3>`* :ref:`destroy<doxid-structtapi__job__methods__t_1a0c5a6c5b7fc95debb5e4a9aaef71cf28>`;
		:ref:`tapi_job_method_wrapper_add<doxid-group__tapi__job__methods_1ga1a52c6791b2e4e4de3fba49c0b7476b2>`* :ref:`wrapper_add<doxid-structtapi__job__methods__t_1aa2d3d6d6f551d13aafbc683a21e48887>`;
		:ref:`tapi_job_method_wrapper_delete<doxid-group__tapi__job__methods_1gaedebe51989501175c249bdebd8c9c560>`* :ref:`wrapper_delete<doxid-structtapi__job__methods__t_1ababeb222414260ffbcc687e9c576fe6d>`;
		:ref:`tapi_job_method_add_exec_param<doxid-group__tapi__job__methods_1ga1b35ba7a6aa609c8eaa975bbaaac9c38>`* :ref:`add_exec_param<doxid-structtapi__job__methods__t_1adb3d2f82952ae44e6fb6a8da2727e804>`;
		:ref:`tapi_job_method_set_autorestart<doxid-group__tapi__job__methods_1gaaab583fd53084cc880e3f489ce5fdf37>`* :ref:`set_autorestart<doxid-structtapi__job__methods__t_1aab9d7b17b74b1d76ae0ba2122c7c6dce>`;
		:ref:`tapi_job_method_set_workdir<doxid-group__tapi__job__methods_1ga1e717c4770a3bd2a5bdba5983f84b720>`* :ref:`set_workdir<doxid-structtapi__job__methods__t_1a7c38a3995fd410e6c3f14c6f510462d1>`;
		:ref:`tapi_job_method_get_autorestart<doxid-group__tapi__job__methods_1ga1a6d3ffa3640e9e2351d4313e1c2c624>`* :ref:`get_autorestart<doxid-structtapi__job__methods__t_1a6c071c403ffeff4f932bd5cb2c9684d1>`;
		:ref:`tapi_job_method_recreate<doxid-group__tapi__job__methods_1ga4c20c26419a89e6a9e6779986eb37bc7>`* :ref:`recreate<doxid-structtapi__job__methods__t_1a11445734ef1413a907a626e9f261df4d>`;
	};
.. _details-structtapi__job__methods__t:

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

Methods to operate TAPI Job instances

Fields
------

.. index:: pair: variable; create
.. _doxid-structtapi__job__methods__t_1a7451793ce81b8d914a3d138dce6d3218:

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

	:ref:`tapi_job_method_create<doxid-group__tapi__job__methods_1ga23c5a83491412bd57c436b83751b146f>`* create

Method that creates a job on backend side

.. index:: pair: variable; start
.. _doxid-structtapi__job__methods__t_1a77b958d20f2cc22c257df16ab9946f68:

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

	:ref:`tapi_job_method_start<doxid-group__tapi__job__methods_1ga8d32cb3fcafea43a9c4b41ddf7c5893d>`* start

Method that starts a job

.. index:: pair: variable; allocate_channels
.. _doxid-structtapi__job__methods__t_1a9a5f5a4ce5d136f2479eaadf542d0686:

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

	:ref:`tapi_job_method_allocate_channels<doxid-group__tapi__job__methods_1gad7a5d99921de1c9f6cd1eebeb9a04a1e>`* allocate_channels

Method that allocates channels

.. index:: pair: variable; kill
.. _doxid-structtapi__job__methods__t_1aefdfa00a4499be881397218a3524058d:

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

	:ref:`tapi_job_method_kill<doxid-group__tapi__job__methods_1gaf8102ad590269a444dd1f2467103c8e1>`* kill

Method that sends a signal to a job

.. index:: pair: variable; killpg
.. _doxid-structtapi__job__methods__t_1aba01aeb02cee683602f473903ae17b93:

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

	:ref:`tapi_job_method_killpg<doxid-group__tapi__job__methods_1ga07f6b33110a2408a66190d4d0c06a8ca>`* killpg

Method that sends a signal to job's process group

.. index:: pair: variable; wait
.. _doxid-structtapi__job__methods__t_1aed8b232ca318e9df02a2fb47ee6645f6:

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

	:ref:`tapi_job_method_wait<doxid-group__tapi__job__methods_1gac80c60db0e97fc61a08a7a97a688ca20>`* wait

Method that waits for the job completion

.. index:: pair: variable; stop
.. _doxid-structtapi__job__methods__t_1a11fa52d1d8cb036025e47bd074039e52:

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

	:ref:`tapi_job_method_stop<doxid-group__tapi__job__methods_1ga1c9a9975b044510cc5c1f94604442368>`* stop

Method that stops a job

.. index:: pair: variable; destroy
.. _doxid-structtapi__job__methods__t_1a0c5a6c5b7fc95debb5e4a9aaef71cf28:

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

	:ref:`tapi_job_method_destroy<doxid-group__tapi__job__methods_1ga1338f6840b49b2efd82e7fdc78acadd3>`* destroy

Method that destroys a job on backend side

.. index:: pair: variable; wrapper_add
.. _doxid-structtapi__job__methods__t_1aa2d3d6d6f551d13aafbc683a21e48887:

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

	:ref:`tapi_job_method_wrapper_add<doxid-group__tapi__job__methods_1ga1a52c6791b2e4e4de3fba49c0b7476b2>`* wrapper_add

Method that adds a wrapper for the specified job

.. index:: pair: variable; wrapper_delete
.. _doxid-structtapi__job__methods__t_1ababeb222414260ffbcc687e9c576fe6d:

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

	:ref:`tapi_job_method_wrapper_delete<doxid-group__tapi__job__methods_1gaedebe51989501175c249bdebd8c9c560>`* wrapper_delete

Method that deletes the wrapper instance handle

.. index:: pair: variable; add_exec_param
.. _doxid-structtapi__job__methods__t_1adb3d2f82952ae44e6fb6a8da2727e804:

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

	:ref:`tapi_job_method_add_exec_param<doxid-group__tapi__job__methods_1ga1b35ba7a6aa609c8eaa975bbaaac9c38>`* add_exec_param

Method that adds a process parameters for the specified job

.. index:: pair: variable; set_autorestart
.. _doxid-structtapi__job__methods__t_1aab9d7b17b74b1d76ae0ba2122c7c6dce:

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

	:ref:`tapi_job_method_set_autorestart<doxid-group__tapi__job__methods_1gaaab583fd53084cc880e3f489ce5fdf37>`* set_autorestart

Method that sets the autorestart timeout

.. index:: pair: variable; set_workdir
.. _doxid-structtapi__job__methods__t_1a7c38a3995fd410e6c3f14c6f510462d1:

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

	:ref:`tapi_job_method_set_workdir<doxid-group__tapi__job__methods_1ga1e717c4770a3bd2a5bdba5983f84b720>`* set_workdir

Method that sets the working dir (aka chdir)

.. index:: pair: variable; get_autorestart
.. _doxid-structtapi__job__methods__t_1a6c071c403ffeff4f932bd5cb2c9684d1:

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

	:ref:`tapi_job_method_get_autorestart<doxid-group__tapi__job__methods_1ga1a6d3ffa3640e9e2351d4313e1c2c624>`* get_autorestart

Method that obtains the autorestart timeout

.. index:: pair: variable; recreate
.. _doxid-structtapi__job__methods__t_1a11445734ef1413a907a626e9f261df4d:

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

	:ref:`tapi_job_method_recreate<doxid-group__tapi__job__methods_1ga4c20c26419a89e6a9e6779986eb37bc7>`* recreate

Method that recreates a job