:orphan: .. index:: pair: group; tool functions TAPI .. _doxid-group__tapi__sfnt__pingpong: tool functions TAPI =================== .. toctree:: :hidden: enum_tapi_sfnt_pp_muxer.rst struct_tapi_sfnt_pp_opt.rst struct_tapi_sfnt_pp_report.rst Overview ~~~~~~~~ TAPI to handle sfnt-pingpong tool. :ref:`More...` .. ref-code-block:: cpp :class: doxyrest-overview-code-block // typedefs typedef struct :ref:`tapi_sfnt_pp_opt` :ref:`tapi_sfnt_pp_opt`; typedef struct :ref:`tapi_sfnt_pp_report` :ref:`tapi_sfnt_pp_report`; typedef struct :ref:`tapi_sfnt_pp_app_server_t` :ref:`tapi_sfnt_pp_app_server_t`; typedef struct :ref:`tapi_sfnt_pp_app_client_t` :ref:`tapi_sfnt_pp_app_client_t`; // enums enum :ref:`tapi_sfnt_pp_muxer`; // structs struct :ref:`tapi_sfnt_pp_opt`; struct :ref:`tapi_sfnt_pp_report`; // global variables const :ref:`tapi_sfnt_pp_opt` :ref:`tapi_sfnt_pp_opt_default_opt`; // global functions :ref:`te_errno` :ref:`tapi_sfnt_pp_create_client`(:ref:`tapi_job_factory_t`* factory, const :ref:`tapi_sfnt_pp_opt`* opt, :ref:`tapi_sfnt_pp_app_client_t`** app); :ref:`te_errno` :ref:`tapi_sfnt_pp_create_server`(:ref:`tapi_job_factory_t`* factory, const :ref:`tapi_sfnt_pp_opt`* opt, :ref:`tapi_sfnt_pp_app_server_t`** app); :ref:`te_errno` :ref:`tapi_sfnt_pp_create`(:ref:`tapi_job_factory_t`* client_factory, :ref:`tapi_job_factory_t`* server_factory, const :ref:`tapi_sfnt_pp_opt`* opt, :ref:`tapi_sfnt_pp_app_client_t`** client, :ref:`tapi_sfnt_pp_app_server_t`** server); :ref:`te_errno` :ref:`tapi_sfnt_pp_start_client`(:ref:`tapi_sfnt_pp_app_client_t`* app); :ref:`te_errno` :ref:`tapi_sfnt_pp_start_server`(:ref:`tapi_sfnt_pp_app_server_t`* app); :ref:`te_errno` :ref:`tapi_sfnt_pp_start`(:ref:`tapi_sfnt_pp_app_client_t`* client, :ref:`tapi_sfnt_pp_app_server_t`* server); :ref:`te_errno` :ref:`tapi_sfnt_pp_wait_client`(:ref:`tapi_sfnt_pp_app_client_t`* app, int timeout_ms); :ref:`te_errno` :ref:`tapi_sfnt_pp_wait_server`(:ref:`tapi_sfnt_pp_app_server_t`* app, int timeout_ms); :ref:`te_errno` :ref:`tapi_sfnt_pp_get_report`(:ref:`tapi_sfnt_pp_app_client_t`* app, :ref:`tapi_sfnt_pp_report`** report); :ref:`te_errno` :ref:`tapi_sfnt_pp_kill_client`(:ref:`tapi_sfnt_pp_app_client_t`* app, int signo); :ref:`te_errno` :ref:`tapi_sfnt_pp_kill_server`(:ref:`tapi_sfnt_pp_app_server_t`* app, int signo); :ref:`te_errno` :ref:`tapi_sfnt_pp_destroy_client`(:ref:`tapi_sfnt_pp_app_client_t`* app); :ref:`te_errno` :ref:`tapi_sfnt_pp_destroy_server`(:ref:`tapi_sfnt_pp_app_server_t`* app); :ref:`te_errno` :ref:`tapi_sfnt_pp_mi_report`(const :ref:`tapi_sfnt_pp_report`* report); :ref:`te_errno` :ref:`tapi_sfnt_pp_client_wrapper_add`(:ref:`tapi_sfnt_pp_app_client_t`* app, const char* tool, const char** argv, :ref:`tapi_job_wrapper_priority_t` priority, :ref:`tapi_job_wrapper_t`** wrap); :ref:`te_errno` :ref:`tapi_sfnt_pp_client_add_sched_param`(:ref:`tapi_sfnt_pp_app_client_t`* app, :ref:`tapi_job_sched_param`* sched_param); // macros #define :ref:`TAPI_SFNT_PP_MUXER_MAP_LIST` #define :ref:`TEST_GET_SFNT_PP_MUXER`(var_name_) .. _details-group__tapi__sfnt__pingpong: Detailed Documentation ~~~~~~~~~~~~~~~~~~~~~~ TAPI to handle sfnt-pingpong tool. Copyright (C) 2020-2022 OKTET Labs Ltd. All rights reserved. Typedefs -------- .. index:: pair: typedef; tapi_sfnt_pp_opt .. _doxid-group__tapi__sfnt__pingpong_1ga41f63e55e00b1e1e2bc7c0b191ecf9bb: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_sfnt_pp_opt` tapi_sfnt_pp_opt sfnt-pingping tool specific command line options .. index:: pair: typedef; tapi_sfnt_pp_report .. _doxid-group__tapi__sfnt__pingpong_1gab7fa4be65732fd92a5af5ded3eaa6c2c: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_sfnt_pp_report` tapi_sfnt_pp_report Struct for storage report for one size value. The output of sfnt-pingpong in the form of a table: size mean min median max ile stddev iter 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 So this structure stores the values of a single row. .. index:: pair: typedef; tapi_sfnt_pp_app_server_t .. _doxid-group__tapi__sfnt__pingpong_1ga140a37722392c2b8e273a40bb135064a: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_sfnt_pp_app_server_t` tapi_sfnt_pp_app_server_t sfnt-pingpong server context .. index:: pair: typedef; tapi_sfnt_pp_app_client_t .. _doxid-group__tapi__sfnt__pingpong_1gaeef9613e075918040a5c84768cd90e32: .. ref-code-block:: cpp :class: doxyrest-title-code-block typedef struct :ref:`tapi_sfnt_pp_app_client_t` tapi_sfnt_pp_app_client_t sfnt-pingpong clinet context Global Variables ---------------- .. index:: pair: variable; tapi_sfnt_pp_opt_default_opt .. _doxid-group__tapi__sfnt__pingpong_1ga58470721acf8c042183bc4ca5fca668e: .. ref-code-block:: cpp :class: doxyrest-title-code-block const :ref:`tapi_sfnt_pp_opt` tapi_sfnt_pp_opt_default_opt Default options initializer Global Functions ---------------- .. index:: pair: function; tapi_sfnt_pp_create_client .. _doxid-group__tapi__sfnt__pingpong_1gad8b8024c36e1fc8093bc6b8cd4f73929: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sfnt_pp_create_client(:ref:`tapi_job_factory_t`* factory, const :ref:`tapi_sfnt_pp_opt`* opt, :ref:`tapi_sfnt_pp_app_client_t`** app) Create client app. All needed information to run is in ``opt``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - factory - Job factory. * - opt - Command line options. * - app - Clinet app handle. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_sfnt_pp_create_server .. _doxid-group__tapi__sfnt__pingpong_1ga5d2239554f9c62190c139ce42702ef62: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sfnt_pp_create_server(:ref:`tapi_job_factory_t`* factory, const :ref:`tapi_sfnt_pp_opt`* opt, :ref:`tapi_sfnt_pp_app_server_t`** app) Create server app. All needed information to run is in ``opt``. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - factory - Job factory. * - opt - Command line options. * - app - Clinet app handle. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_sfnt_pp_create .. _doxid-group__tapi__sfnt__pingpong_1gaa1d508c009353a447d3ec93185b9aba2: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sfnt_pp_create(:ref:`tapi_job_factory_t`* client_factory, :ref:`tapi_job_factory_t`* server_factory, const :ref:`tapi_sfnt_pp_opt`* opt, :ref:`tapi_sfnt_pp_app_client_t`** client, :ref:`tapi_sfnt_pp_app_server_t`** server) Create client and server app. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client_factory - Client job factory. * - server_factory - Server job factory. * - opt - Command line options. * - client - Client app handle. * - server - Server app handle. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_sfnt_pp_start_client .. _doxid-group__tapi__sfnt__pingpong_1ga82f3428b3d4a9f4fa9c10836092f3b36: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sfnt_pp_start_client(:ref:`tapi_sfnt_pp_app_client_t`* app) Start client. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - Client app handle. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_sfnt_pp_start_server .. _doxid-group__tapi__sfnt__pingpong_1gaaf7ea6bc3860c629d15921430e0e10f6: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sfnt_pp_start_server(:ref:`tapi_sfnt_pp_app_server_t`* app) Start server. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - Server app handle. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_sfnt_pp_start .. _doxid-group__tapi__sfnt__pingpong_1gafa1e9c4c79f4552c8d4f4b57b124709c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sfnt_pp_start(:ref:`tapi_sfnt_pp_app_client_t`* client, :ref:`tapi_sfnt_pp_app_server_t`* server) Start clinet and server. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - client - Client app handle. * - server - Server app handle. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_sfnt_pp_wait_client .. _doxid-group__tapi__sfnt__pingpong_1ga1ed439ff7ff7395e2cd608071f398e86: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sfnt_pp_wait_client(:ref:`tapi_sfnt_pp_app_client_t`* app, int timeout_ms) Wait for client completion. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - Client app handle. * - timeout_ms - Wait timeout in milliseconds. (negative means :ref:`tapi_job_get_timeout() `) .. rubric:: Returns: Status code. .. index:: pair: function; tapi_sfnt_pp_wait_server .. _doxid-group__tapi__sfnt__pingpong_1ga2bfb3408f80aa5006bdb86908108fb4a: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sfnt_pp_wait_server(:ref:`tapi_sfnt_pp_app_server_t`* app, int timeout_ms) Wait for server completion. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - Server app handle. * - timeout_ms - Wait timeout in milliseconds. (negative means :ref:`tapi_job_get_timeout() `) .. rubric:: Returns: Status code. .. index:: pair: function; tapi_sfnt_pp_get_report .. _doxid-group__tapi__sfnt__pingpong_1gad098b1717b4856710dce789764600879: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sfnt_pp_get_report(:ref:`tapi_sfnt_pp_app_client_t`* app, :ref:`tapi_sfnt_pp_report`** report) Get sfnt-pingpong report. 'report' should be freed by user. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - Clinet app handle. * - report - sfnt-pingpong statistics report. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_sfnt_pp_kill_client .. _doxid-group__tapi__sfnt__pingpong_1ga1c0e2208dad02e5c5d5762596d62a633: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sfnt_pp_kill_client(:ref:`tapi_sfnt_pp_app_client_t`* app, int signo) Send a signal to clinet. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - Client app handle. * - signo - Signal to send to client. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_sfnt_pp_kill_server .. _doxid-group__tapi__sfnt__pingpong_1gaf7e011da29e5fce36bbf6bf727b2790c: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sfnt_pp_kill_server(:ref:`tapi_sfnt_pp_app_server_t`* app, int signo) Send a signal to server. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - Server app handle. * - signo - Signal to send to server. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_sfnt_pp_destroy_client .. _doxid-group__tapi__sfnt__pingpong_1ga06d47c997c570024b07d9c6bcbcbe848: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sfnt_pp_destroy_client(:ref:`tapi_sfnt_pp_app_client_t`* app) Destroy client app. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - Client app handle. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_sfnt_pp_destroy_server .. _doxid-group__tapi__sfnt__pingpong_1gad51596d27155d10c29691fbecb264e28: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sfnt_pp_destroy_server(:ref:`tapi_sfnt_pp_app_server_t`* app) Destroy server app. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - Server app handle. .. rubric:: Returns: Status code. .. index:: pair: function; tapi_sfnt_pp_mi_report .. _doxid-group__tapi__sfnt__pingpong_1ga5e23589801458d3db76b4827fe456569: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sfnt_pp_mi_report(const :ref:`tapi_sfnt_pp_report`* report) Output sfnt-pingpong report via MI logger. .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - report - sfnt-pingpong report .. rubric:: Returns: Status code .. index:: pair: function; tapi_sfnt_pp_client_wrapper_add .. _doxid-group__tapi__sfnt__pingpong_1gab68e08e41b55115c03914f4c55ccd7aa: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sfnt_pp_client_wrapper_add(:ref:`tapi_sfnt_pp_app_client_t`* app, const char* tool, const char** argv, :ref:`tapi_job_wrapper_priority_t` priority, :ref:`tapi_job_wrapper_t`** wrap) Add a wrapper tool/script to sfnt-pinping client .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - Client app handle * - tool - Path to the wrapper tool * - argv - Wrapper arguments (last item should be ``NULL``) * - priority - Wrapper priority * - wrap - Wrapper instance handle .. rubric:: Returns: Status code .. index:: pair: function; tapi_sfnt_pp_client_add_sched_param .. _doxid-group__tapi__sfnt__pingpong_1gaa12a0c013f70f69a72d92ca809a820dc: .. ref-code-block:: cpp :class: doxyrest-title-code-block :ref:`te_errno` tapi_sfnt_pp_client_add_sched_param(:ref:`tapi_sfnt_pp_app_client_t`* app, :ref:`tapi_job_sched_param`* sched_param) Add a scheduling parameters to sfnt-pingping client .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - app - Client app handle. * - sched_param - Array of scheduling parameters. The last element must have the type ``TAPI_JOB_SCHED_END`` and data pointer to ``NULL``. .. rubric:: Returns: Status code Macros ------ .. index:: pair: define; TAPI_SFNT_PP_MUXER_MAP_LIST .. _doxid-group__tapi__sfnt__pingpong_1ga6a710e12051185a4b08147cbf25614d9: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TAPI_SFNT_PP_MUXER_MAP_LIST The list of values allowed for parameter of type 'tapi_sfnt_pp_muxer' .. index:: pair: define; TEST_GET_SFNT_PP_MUXER .. _doxid-group__tapi__sfnt__pingpong_1ga1bb892a104f175af47fab35966e02441: .. ref-code-block:: cpp :class: doxyrest-title-code-block #define TEST_GET_SFNT_PP_MUXER(var_name_) Get the value of parameter of type 'tapi_sfnt_pp_muxer' .. rubric:: Parameters: .. list-table:: :widths: 20 80 * - var_name\_ - Name of the variable used to get the value of "var_name\_" parameter of type 'tapi_sfnt_pp_muxer'