:orphan:

.. index:: pair: struct; tapi_job_simple_desc_t
.. _doxid-structtapi__job__simple__desc__t:

struct tapi_job_simple_desc_t
=============================

.. toctree::
	:hidden:

Overview
~~~~~~~~

A simplified description of a job. :ref:`More...<details-structtapi__job__simple__desc__t>`


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

	#include <tapi_job.h>
	
	struct tapi_job_simple_desc_t {
		// fields
	
		const char* :ref:`name<doxid-structtapi__job__simple__desc__t_1a9045ef9241ba1c599f294ad824ee6652>`;
		const char* :ref:`spawner<doxid-structtapi__job__simple__desc__t_1a6d82139632287c43e7d613c64d62cd22>`;
		const char* :ref:`program<doxid-structtapi__job__simple__desc__t_1a832f253834a0fcf04341f538e89c724c>`;
		const char** :ref:`argv<doxid-structtapi__job__simple__desc__t_1a2290d245898c8c0379e33d4ec7254768>`;
		const char** :ref:`env<doxid-structtapi__job__simple__desc__t_1a8259366bfd976d05a7ad74552e439612>`;
		:ref:`tapi_job_t<doxid-group__tapi__job_1gac201e01acbab3a86a0f8d51b0d446aca>`** :ref:`job_loc<doxid-structtapi__job__simple__desc__t_1a251a33da855f7b68d14fcdb14c462fb1>`;
		:ref:`tapi_job_channel_t<doxid-group__tapi__job_1ga91bc512c5a63505cbb40c396039c84e0>`** :ref:`stdin_loc<doxid-structtapi__job__simple__desc__t_1a4d62ea5dbb45b677fc1234ac1cda11ce>`;
		:ref:`tapi_job_channel_t<doxid-group__tapi__job_1ga91bc512c5a63505cbb40c396039c84e0>`** :ref:`stdout_loc<doxid-structtapi__job__simple__desc__t_1a08c83b5f2799e046fb254a615bf99e30>`;
		:ref:`tapi_job_channel_t<doxid-group__tapi__job_1ga91bc512c5a63505cbb40c396039c84e0>`** :ref:`stderr_loc<doxid-structtapi__job__simple__desc__t_1a38a89116becfcb675d89bd3b5fb1c71b>`;
		:ref:`tapi_job_simple_filter_t<doxid-structtapi__job__simple__filter__t>`* :ref:`filters<doxid-structtapi__job__simple__desc__t_1a199e46ba4a417694889160c82675c148>`;
	};
.. _details-structtapi__job__simple__desc__t:

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

A simplified description of a job. The caller is expected to fill the fields one is interested in and leave others ``NULL``.

Fields
------

.. index:: pair: variable; name
.. _doxid-structtapi__job__simple__desc__t_1a9045ef9241ba1c599f294ad824ee6652:

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

	const char* name

Name of the job. Might be useful for jobs created by CFG factory (see :ref:`tapi_job_create_named() <doxid-group__tapi__job_1ga43871b14ab178085fa7fc08d15366c8c>`).

.. index:: pair: variable; spawner
.. _doxid-structtapi__job__simple__desc__t_1a6d82139632287c43e7d613c64d62cd22:

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

	const char* spawner

Spawner type

.. index:: pair: variable; program
.. _doxid-structtapi__job__simple__desc__t_1a832f253834a0fcf04341f538e89c724c:

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

	const char* program

Program path

.. index:: pair: variable; argv
.. _doxid-structtapi__job__simple__desc__t_1a2290d245898c8c0379e33d4ec7254768:

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

	const char** argv

Program argument vector

.. index:: pair: variable; env
.. _doxid-structtapi__job__simple__desc__t_1a8259366bfd976d05a7ad74552e439612:

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

	const char** env

Program environment

.. index:: pair: variable; job_loc
.. _doxid-structtapi__job__simple__desc__t_1a251a33da855f7b68d14fcdb14c462fb1:

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

	:ref:`tapi_job_t<doxid-group__tapi__job_1gac201e01acbab3a86a0f8d51b0d446aca>`** job_loc

Location for a job handle var

.. index:: pair: variable; stdin_loc
.. _doxid-structtapi__job__simple__desc__t_1a4d62ea5dbb45b677fc1234ac1cda11ce:

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

	:ref:`tapi_job_channel_t<doxid-group__tapi__job_1ga91bc512c5a63505cbb40c396039c84e0>`** stdin_loc

Location for a channel handle connected to stdin

.. index:: pair: variable; stdout_loc
.. _doxid-structtapi__job__simple__desc__t_1a08c83b5f2799e046fb254a615bf99e30:

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

	:ref:`tapi_job_channel_t<doxid-group__tapi__job_1ga91bc512c5a63505cbb40c396039c84e0>`** stdout_loc

Location for a channel handle connected to stdout

.. index:: pair: variable; stderr_loc
.. _doxid-structtapi__job__simple__desc__t_1a38a89116becfcb675d89bd3b5fb1c71b:

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

	:ref:`tapi_job_channel_t<doxid-group__tapi__job_1ga91bc512c5a63505cbb40c396039c84e0>`** stderr_loc

Location for a channel handle connected to stderr

.. index:: pair: variable; filters
.. _doxid-structtapi__job__simple__desc__t_1a199e46ba4a417694889160c82675c148:

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

	:ref:`tapi_job_simple_filter_t<doxid-structtapi__job__simple__filter__t>`* filters

Vector of filters. If not ``NULL``, the last element should have *use_stdout* and *use_stderr* set to ``false``