:orphan: .. index:: pair: group; TAPI Job internal functions (tapi_job_internal) .. _doxid-group__tapi__job__internal: TAPI Job internal functions (tapi_job_internal) =============================================== .. toctree:: :hidden: Overview ~~~~~~~~ Auxiliary functions for internal use in TAPI Job Copyright (C) 2022-2022 OKTET Labs Ltd. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // global functions :ref:`rcf_rpc_server`* :ref:`tapi_job_get_rpcs`(const :ref:`tapi_job_t`* job); unsigned int :ref:`tapi_job_get_id`(const :ref:`tapi_job_t`* job); void :ref:`tapi_job_set_id`(:ref:`tapi_job_t`* job, unsigned int id); const char* :ref:`tapi_job_get_ta`(const :ref:`tapi_job_t`* job); const char* :ref:`tapi_job_get_name`(const :ref:`tapi_job_t`* job); void :ref:`tapi_job_set_name`(:ref:`tapi_job_t`* job, const char* name); bool :ref:`tapi_job_get_silent_pass`(const :ref:`tapi_job_t`* job); .. _details-group__tapi__job__internal: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ Auxiliary functions for internal use in TAPI Job Copyright (C) 2022-2022 OKTET Labs Ltd. All rights reserved. Global Functions ---------------- .. index:: pair: function; tapi_job_get_rpcs .. _doxid-group__tapi__job__internal_1ga07bf56cfc4f40d1665c32ad7571bb163: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`rcf_rpc_server`* tapi_job_get_rpcs(const :ref:`tapi_job_t`* job) Get RPC server on which ``job`` was created. The job must have been created using RPC job factory, otherwise the function calls :ref:`TEST_FAIL() `. The function is primarily intended for internal usage. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - job - Job instance handle * - TEST_FAIL - .. rubric:: Returns: RPC server on which ``job`` was created .. index:: pair: function; tapi_job_get_id .. _doxid-group__tapi__job__internal_1ga535f7ad13310432a78d827cb4f5c27ed: .. ref-code-block:: cpp :class: doxyrest-title-code-block unsigned int tapi_job_get_id(const :ref:`tapi_job_t`* job) Get internal ID of the ``job``. The job must have been created using RPC job factory, otherwise the function calls :ref:`TEST_FAIL() `. The function is primarily intended for internal usage. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - job - Job instance handle * - TEST_FAIL - .. rubric:: Returns: Internal ID of the ``job`` .. index:: pair: function; tapi_job_set_id .. _doxid-group__tapi__job__internal_1ga68b039ff88f16d61f0a6adaafaa7f53a: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_job_set_id(:ref:`tapi_job_t`* job, unsigned int id) Set internal ID of the ``job``. The job must have been created using RPC job factory, otherwise the function calls :ref:`TEST_FAIL() `. The function is primarily intended for internal usage. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - job - Job instance handle * - id - ID to set to the ``job`` * - TEST_FAIL - .. index:: pair: function; tapi_job_get_ta .. _doxid-group__tapi__job__internal_1gae700c142c3a5b9d09f66ffb34f3053e7: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char* tapi_job_get_ta(const :ref:`tapi_job_t`* job) Get name of the Test Agent on which ``job`` was created. The job must have been created using CFG job factory, otherwise the function calls :ref:`TEST_FAIL() `. The function is primarily intended for internal usage. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - job - Job instance handle * - TEST_FAIL - .. rubric:: Returns: Name of the Test Agent on which ``job`` was created .. index:: pair: function; tapi_job_get_name .. _doxid-group__tapi__job__internal_1gab2bc526429c13af694a6e547d3e8ee06: .. ref-code-block:: cpp :class: doxyrest-title-code-block const char* tapi_job_get_name(const :ref:`tapi_job_t`* job) Get name of the ``job``. The job must have been created using CFG job factory, otherwise the function calls :ref:`TEST_FAIL() `. The function is primarily intended for internal usage. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - job - Job instance handle * - TEST_FAIL - .. rubric:: Returns: Name of the ``job`` .. index:: pair: function; tapi_job_set_name .. _doxid-group__tapi__job__internal_1ga5cc9d03a999c8d389cf883f9dbd20468: .. ref-code-block:: cpp :class: doxyrest-title-code-block void tapi_job_set_name(:ref:`tapi_job_t`* job, const char* name) Set name of the ``job``. The corresponding member of tapi_job_t should be freed when the job is not needed anymore. The job must have been created using CFG job factory, otherwise the function calls :ref:`TEST_FAIL() `. The function is primarily intended for internal usage. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - job - Job instance handle * - name - Name to set to the ``job`` * - TEST_FAIL - .. index:: pair: function; tapi_job_get_silent_pass .. _doxid-group__tapi__job__internal_1ga8eea30e7415a6fdf13a980bf1fdd80f6: .. ref-code-block:: cpp :class: doxyrest-title-code-block bool tapi_job_get_silent_pass(const :ref:`tapi_job_t`* job) Get value of the field that manages RPC calls muting. The function is primarily intended for internal usage. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - job - Job instance handle * - TEST_FAIL - .. rubric:: Returns: Status code