:orphan:

.. index:: pair: group; tool functions TAPI
.. _doxid-group__tapi__wrk:

tool functions TAPI
===================

.. toctree::
	:hidden:

	struct_tapi_wrk_app.rst
	struct_tapi_wrk_latency_percentile.rst
	struct_tapi_wrk_opt.rst
	struct_tapi_wrk_report.rst
	struct_tapi_wrk_socket_errors.rst
	struct_tapi_wrk_thread_stats.rst

Overview
~~~~~~~~

TAPI to handle wrk tool. :ref:`More...<details-group__tapi__wrk>`


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

	
	// typedefs

	typedef struct :ref:`tapi_wrk_opt<doxid-structtapi__wrk__opt>` :ref:`tapi_wrk_opt<doxid-group__tapi__wrk_1ga8e04045139f70f5e21ce99ce8e949c5c>`;
	typedef struct :ref:`tapi_wrk_thread_stats<doxid-structtapi__wrk__thread__stats>` :ref:`tapi_wrk_thread_stats<doxid-group__tapi__wrk_1gacf431d2e6a6bf2f17c942c9954e75585>`;
	typedef struct :ref:`tapi_wrk_latency_percentile<doxid-structtapi__wrk__latency__percentile>` :ref:`tapi_wrk_latency_percentile<doxid-group__tapi__wrk_1gaa01ff7d9f00371314a0b6a28e573afa4>`;
	typedef struct :ref:`tapi_wrk_socket_errors<doxid-structtapi__wrk__socket__errors>` :ref:`tapi_wrk_socket_errors<doxid-group__tapi__wrk_1ga91924c609eeafc887efb2ab3666ff8bb>`;
	typedef struct :ref:`tapi_wrk_report<doxid-structtapi__wrk__report>` :ref:`tapi_wrk_report<doxid-group__tapi__wrk_1gaf21217bcc431604219932efffdb40288>`;
	typedef struct :ref:`tapi_wrk_app<doxid-structtapi__wrk__app>` :ref:`tapi_wrk_app<doxid-group__tapi__wrk_1ga57f77813656417332a015424f848afc9>`;

	// structs

	struct :ref:`tapi_wrk_app<doxid-structtapi__wrk__app>`;
	struct :ref:`tapi_wrk_latency_percentile<doxid-structtapi__wrk__latency__percentile>`;
	struct :ref:`tapi_wrk_opt<doxid-structtapi__wrk__opt>`;
	struct :ref:`tapi_wrk_report<doxid-structtapi__wrk__report>`;
	struct :ref:`tapi_wrk_socket_errors<doxid-structtapi__wrk__socket__errors>`;
	struct :ref:`tapi_wrk_thread_stats<doxid-structtapi__wrk__thread__stats>`;

	// global variables

	const :ref:`tapi_wrk_opt<doxid-structtapi__wrk__opt>` :ref:`tapi_wrk_default_opt<doxid-group__tapi__wrk_1ga31336f4bda39e3bb37571d7c6a289a1b>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_wrk_create<doxid-group__tapi__wrk_1gab53883739a170cdac029346a552d0942>`(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_wrk_opt<doxid-structtapi__wrk__opt>`* opt, :ref:`tapi_wrk_app<doxid-structtapi__wrk__app>`** app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_wrk_start<doxid-group__tapi__wrk_1gaf1801e6e36e9f7b8ed5b03a0f7812e37>`(:ref:`tapi_wrk_app<doxid-structtapi__wrk__app>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_wrk_wait<doxid-group__tapi__wrk_1ga330acec9ac57c2585ec2cb5a70d9640a>`(:ref:`tapi_wrk_app<doxid-structtapi__wrk__app>`* app, int timeout_ms);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_wrk_get_report<doxid-group__tapi__wrk_1ga30870e98ec7348d81e2d45a60202d422>`(:ref:`tapi_wrk_app<doxid-structtapi__wrk__app>`* app, :ref:`tapi_wrk_report<doxid-structtapi__wrk__report>`* report);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_wrk_kill<doxid-group__tapi__wrk_1ga636ac9cf7c70a03f1a19d86cea432fc2>`(:ref:`tapi_wrk_app<doxid-structtapi__wrk__app>`* app, int signo);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_wrk_destroy<doxid-group__tapi__wrk_1ga0d9b128ed24a7a62a5b991fc41b16a54>`(:ref:`tapi_wrk_app<doxid-structtapi__wrk__app>`* app);
	void :ref:`tapi_wrk_report_mi_log<doxid-group__tapi__wrk_1ga96bbe51042e404147085015671e52223>`(:ref:`te_mi_logger<doxid-group__te__tools__te__mi__log_1gaec19168a124d0845de6936405b58a4f5>`* logger, const :ref:`tapi_wrk_report<doxid-structtapi__wrk__report>`* report);

	// macros

	#define :ref:`TAPI_WRK_HEADERS_MAX<doxid-group__tapi__wrk_1ga93cea110fba72948d57ed09759adb27e>`
	#define :ref:`TAPI_WRK_LATENCY_DISTR_ENTRIES<doxid-group__tapi__wrk_1ga5cf18c9a60e26a32bcad6f30aeff4ac3>`
	#define :ref:`TAPI_WRK_SCRIPT_ARGS_MAX<doxid-group__tapi__wrk_1ga8c6bc543c5d2fbf4be4f01ad80f11118>`

.. _details-group__tapi__wrk:

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

TAPI to handle wrk tool.

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

Typedefs
--------

.. index:: pair: typedef; tapi_wrk_opt
.. _doxid-group__tapi__wrk_1ga8e04045139f70f5e21ce99ce8e949c5c:

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

	typedef struct :ref:`tapi_wrk_opt<doxid-structtapi__wrk__opt>` tapi_wrk_opt

wrk tool specific command line options

.. index:: pair: typedef; tapi_wrk_thread_stats
.. _doxid-group__tapi__wrk_1gacf431d2e6a6bf2f17c942c9954e75585:

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

	typedef struct :ref:`tapi_wrk_thread_stats<doxid-structtapi__wrk__thread__stats>` tapi_wrk_thread_stats

Statistics for a single thread in wrk

.. index:: pair: typedef; tapi_wrk_latency_percentile
.. _doxid-group__tapi__wrk_1gaa01ff7d9f00371314a0b6a28e573afa4:

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

	typedef struct :ref:`tapi_wrk_latency_percentile<doxid-structtapi__wrk__latency__percentile>` tapi_wrk_latency_percentile

Entry of latency distribution statistics

.. index:: pair: typedef; tapi_wrk_socket_errors
.. _doxid-group__tapi__wrk_1ga91924c609eeafc887efb2ab3666ff8bb:

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

	typedef struct :ref:`tapi_wrk_socket_errors<doxid-structtapi__wrk__socket__errors>` tapi_wrk_socket_errors

Statistics of socket errors

.. index:: pair: typedef; tapi_wrk_report
.. _doxid-group__tapi__wrk_1gaf21217bcc431604219932efffdb40288:

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

	typedef struct :ref:`tapi_wrk_report<doxid-structtapi__wrk__report>` tapi_wrk_report

Statistics report of wrk

.. index:: pair: typedef; tapi_wrk_app
.. _doxid-group__tapi__wrk_1ga57f77813656417332a015424f848afc9:

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

	typedef struct :ref:`tapi_wrk_app<doxid-structtapi__wrk__app>` tapi_wrk_app

Information of a wrk tool

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

.. index:: pair: variable; tapi_wrk_default_opt
.. _doxid-group__tapi__wrk_1ga31336f4bda39e3bb37571d7c6a289a1b:

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

	const :ref:`tapi_wrk_opt<doxid-structtapi__wrk__opt>` tapi_wrk_default_opt

Default options initializer

Global Functions
----------------

.. index:: pair: function; tapi_wrk_create
.. _doxid-group__tapi__wrk_1gab53883739a170cdac029346a552d0942:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_wrk_create(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_wrk_opt<doxid-structtapi__wrk__opt>`* opt, :ref:`tapi_wrk_app<doxid-structtapi__wrk__app>`** app)

Create wrk app. All needed information to run wrk is in ``opt``



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- factory

		- Job factory.

	*
		- opt

		- Options of wrk tool.

	*
		- app

		- wrk app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_wrk_start
.. _doxid-group__tapi__wrk_1gaf1801e6e36e9f7b8ed5b03a0f7812e37:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_wrk_start(:ref:`tapi_wrk_app<doxid-structtapi__wrk__app>`* app)

Start wrk.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- wrk app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_wrk_wait
.. _doxid-group__tapi__wrk_1ga330acec9ac57c2585ec2cb5a70d9640a:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_wrk_wait(:ref:`tapi_wrk_app<doxid-structtapi__wrk__app>`* app, int timeout_ms)

Wait for wrk completion.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- wrk app handle.

	*
		- timeout_ms

		- Wait timeout in milliseconds.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_wrk_get_report
.. _doxid-group__tapi__wrk_1ga30870e98ec7348d81e2d45a60202d422:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_wrk_get_report(:ref:`tapi_wrk_app<doxid-structtapi__wrk__app>`* app, :ref:`tapi_wrk_report<doxid-structtapi__wrk__report>`* report)

Get wrk report.

Field 'arguments' in the ``report`` points to a new allocated string that should be freed by user.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- wrk app handle.

	*
		- report

		- wrk statistics report.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_wrk_kill
.. _doxid-group__tapi__wrk_1ga636ac9cf7c70a03f1a19d86cea432fc2:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_wrk_kill(:ref:`tapi_wrk_app<doxid-structtapi__wrk__app>`* app, int signo)

Send a signal to wrk.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- wrk app handle.

	*
		- signo

		- Signal to send to wrk.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_wrk_destroy
.. _doxid-group__tapi__wrk_1ga0d9b128ed24a7a62a5b991fc41b16a54:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_wrk_destroy(:ref:`tapi_wrk_app<doxid-structtapi__wrk__app>`* app)

Destroy wrk app.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- app

		- wrk app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_wrk_report_mi_log
.. _doxid-group__tapi__wrk_1ga96bbe51042e404147085015671e52223:

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

	void tapi_wrk_report_mi_log(:ref:`te_mi_logger<doxid-group__te__tools__te__mi__log_1gaec19168a124d0845de6936405b58a4f5>`* logger, const :ref:`tapi_wrk_report<doxid-structtapi__wrk__report>`* report)

Add wrk report to MI logger.



.. rubric:: Parameters:

.. list-table::
	:widths: 20 80

	*
		- logger

		- MI logger entity

	*
		- report

		- wrk statistics report.

Macros
------

.. index:: pair: define; TAPI_WRK_HEADERS_MAX
.. _doxid-group__tapi__wrk_1ga93cea110fba72948d57ed09759adb27e:

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

	#define TAPI_WRK_HEADERS_MAX

Maximum number of headers that can be set in wrk options

.. index:: pair: define; TAPI_WRK_LATENCY_DISTR_ENTRIES
.. _doxid-group__tapi__wrk_1ga5cf18c9a60e26a32bcad6f30aeff4ac3:

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

	#define TAPI_WRK_LATENCY_DISTR_ENTRIES

Number of entries in wrk latency distibution statistics

.. index:: pair: define; TAPI_WRK_SCRIPT_ARGS_MAX
.. _doxid-group__tapi__wrk_1ga8c6bc543c5d2fbf4be4f01ad80f11118:

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

	#define TAPI_WRK_SCRIPT_ARGS_MAX

Maximum number of arguments that can be passed to the Lua script