:orphan:

.. index:: pair: group; redis-benchmark tool TAPI (tapi_redis_benchmark)
.. _doxid-group__tapi__redis__benchmark:

redis-benchmark tool TAPI (tapi_redis_benchmark)
================================================

.. toctree::
	:hidden:

	struct_tapi_redis_benchmark_app.rst
	struct_tapi_redis_benchmark_opt.rst
	struct_tapi_redis_benchmark_stat.rst

Overview
~~~~~~~~

TAPI to handle redis-benchmark tool. :ref:`More...<details-group__tapi__redis__benchmark>`


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

	
	// typedefs

	typedef struct :ref:`tapi_redis_benchmark_app<doxid-structtapi__redis__benchmark__app>` :ref:`tapi_redis_benchmark_app<doxid-group__tapi__redis__benchmark_1ga35c21594c64c6065bad1fd1ac2f88987>`;
	typedef struct :ref:`tapi_redis_benchmark_opt<doxid-structtapi__redis__benchmark__opt>` :ref:`tapi_redis_benchmark_opt<doxid-group__tapi__redis__benchmark_1ga27bcd6a7186dfe03ed2c0e3ab56448e2>`;
	typedef struct :ref:`tapi_redis_benchmark_stat<doxid-structtapi__redis__benchmark__stat>` :ref:`tapi_redis_benchmark_stat<doxid-group__tapi__redis__benchmark_1gab3f90a5c86d58a922b8a042f74477120>`;

	// structs

	struct :ref:`tapi_redis_benchmark_app<doxid-structtapi__redis__benchmark__app>`;
	struct :ref:`tapi_redis_benchmark_opt<doxid-structtapi__redis__benchmark__opt>`;
	struct :ref:`tapi_redis_benchmark_stat<doxid-structtapi__redis__benchmark__stat>`;

	// global variables

	const :ref:`tapi_redis_benchmark_opt<doxid-structtapi__redis__benchmark__opt>` :ref:`tapi_redis_benchmark_default_opt<doxid-group__tapi__redis__benchmark_1gab2a1267cf9398563fc404dae11597047>`;

	// global functions

	typedef :ref:`SLIST_HEAD<doxid-group__tapi__redis__benchmark_1ga8241b0777918a4f7380c1f3daf9ea2ce>`(tapi_redis_benchmark_report, :ref:`tapi_redis_benchmark_stat<doxid-structtapi__redis__benchmark__stat>`);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_redis_benchmark_create<doxid-group__tapi__redis__benchmark_1ga18f7f29c89533123d05e5aa3d4bc6ab1>`(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_redis_benchmark_opt<doxid-structtapi__redis__benchmark__opt>`* opt, :ref:`tapi_redis_benchmark_app<doxid-structtapi__redis__benchmark__app>`** app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_redis_benchmark_start<doxid-group__tapi__redis__benchmark_1ga5b21ea01bb074af15d8134a66a3c80e2>`(const :ref:`tapi_redis_benchmark_app<doxid-structtapi__redis__benchmark__app>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_redis_benchmark_wait<doxid-group__tapi__redis__benchmark_1ga9843501ddf8ff5d8fa40fa9eb645a6c0>`(const :ref:`tapi_redis_benchmark_app<doxid-structtapi__redis__benchmark__app>`* app, int timeout_ms);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_redis_benchmark_stop<doxid-group__tapi__redis__benchmark_1ga1c2a93fe556494d1619a959af502829f>`(const :ref:`tapi_redis_benchmark_app<doxid-structtapi__redis__benchmark__app>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_redis_benchmark_kill<doxid-group__tapi__redis__benchmark_1ga0f2ff0956898854498b12abf20752344>`(const :ref:`tapi_redis_benchmark_app<doxid-structtapi__redis__benchmark__app>`* app, int signum);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_redis_benchmark_destroy<doxid-group__tapi__redis__benchmark_1ga0bfb1c744b19a148ce47cf8d16530a31>`(:ref:`tapi_redis_benchmark_app<doxid-structtapi__redis__benchmark__app>`* app);
	void :ref:`tapi_redis_benchmark_destroy_report<doxid-group__tapi__redis__benchmark_1gadde36b1fa9ae4053ef13efcae7ab83fa>`(tapi_redis_benchmark_report* entry);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_redis_benchmark_get_report<doxid-group__tapi__redis__benchmark_1ga1e08093d2584757fc4aecb7b4f6435f7>`(:ref:`tapi_redis_benchmark_app<doxid-structtapi__redis__benchmark__app>`* app, tapi_redis_benchmark_report* report);
	:ref:`tapi_redis_benchmark_stat<doxid-structtapi__redis__benchmark__stat>`* :ref:`tapi_redis_benchmark_report_get_stat<doxid-group__tapi__redis__benchmark_1gaf5e8bd4132dc5f8fb8ea59b1ee6221c5>`(tapi_redis_benchmark_report* report, const char* test_name);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_redis_benchmark_report_mi_log<doxid-group__tapi__redis__benchmark_1gac6780a480acd36d41945f58f8d7db538>`(:ref:`te_mi_logger<doxid-group__te__tools__te__mi__log_1gaec19168a124d0845de6936405b58a4f5>`* logger, tapi_redis_benchmark_report* report);

	// macros

	#define :target:`TAPI_REDIS_BENCHMARK_RECEIVE_TIMEOUT_MS<doxid-group__tapi__redis__benchmark_1gaa358dc150da7fc3a3877d80ae1a08615>`
	#define :target:`TAPI_REDIS_BENCHMARK_TIMEOUT_MS<doxid-group__tapi__redis__benchmark_1ga30bb9a94e5a91a1d544f6713a7e49ff5>`

.. _details-group__tapi__redis__benchmark:

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

TAPI to handle redis-benchmark tool.

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

Typedefs
--------

.. index:: pair: typedef; tapi_redis_benchmark_app
.. _doxid-group__tapi__redis__benchmark_1ga35c21594c64c6065bad1fd1ac2f88987:

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

	typedef struct :ref:`tapi_redis_benchmark_app<doxid-structtapi__redis__benchmark__app>` tapi_redis_benchmark_app

Redis-benchmark tool information.

.. index:: pair: typedef; tapi_redis_benchmark_opt
.. _doxid-group__tapi__redis__benchmark_1ga27bcd6a7186dfe03ed2c0e3ab56448e2:

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

	typedef struct :ref:`tapi_redis_benchmark_opt<doxid-structtapi__redis__benchmark__opt>` tapi_redis_benchmark_opt

Specific redis-benchmark options.

.. index:: pair: typedef; tapi_redis_benchmark_stat
.. _doxid-group__tapi__redis__benchmark_1gab3f90a5c86d58a922b8a042f74477120:

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

	typedef struct :ref:`tapi_redis_benchmark_stat<doxid-structtapi__redis__benchmark__stat>` tapi_redis_benchmark_stat

List node with redis-benchmark statistics.

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

.. index:: pair: variable; tapi_redis_benchmark_default_opt
.. _doxid-group__tapi__redis__benchmark_1gab2a1267cf9398563fc404dae11597047:

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

	const :ref:`tapi_redis_benchmark_opt<doxid-structtapi__redis__benchmark__opt>` tapi_redis_benchmark_default_opt

Default redis-benchmark options initializer.

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

.. index:: pair: function; SLIST_HEAD
.. _doxid-group__tapi__redis__benchmark_1ga8241b0777918a4f7380c1f3daf9ea2ce:

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

	typedef SLIST_HEAD(tapi_redis_benchmark_report, :ref:`tapi_redis_benchmark_stat<doxid-structtapi__redis__benchmark__stat>`)

Test stat list entry.

.. index:: pair: function; tapi_redis_benchmark_create
.. _doxid-group__tapi__redis__benchmark_1ga18f7f29c89533123d05e5aa3d4bc6ab1:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_redis_benchmark_create(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_redis_benchmark_opt<doxid-structtapi__redis__benchmark__opt>`* opt, :ref:`tapi_redis_benchmark_app<doxid-structtapi__redis__benchmark__app>`** app)

Create redis-benchmark app.



.. rubric:: Parameters:

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

	*
		- factory

		- job factory

	*
		- opt

		- redis-benchmark options

	*
		- app

		- redis-benchmark app handle



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_redis_benchmark_start
.. _doxid-group__tapi__redis__benchmark_1ga5b21ea01bb074af15d8134a66a3c80e2:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_redis_benchmark_start(const :ref:`tapi_redis_benchmark_app<doxid-structtapi__redis__benchmark__app>`* app)

Start redis-benchmark.



.. rubric:: Parameters:

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

	*
		- app

		- redis-benchmark app handle



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_redis_benchmark_wait
.. _doxid-group__tapi__redis__benchmark_1ga9843501ddf8ff5d8fa40fa9eb645a6c0:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_redis_benchmark_wait(const :ref:`tapi_redis_benchmark_app<doxid-structtapi__redis__benchmark__app>`* app, int timeout_ms)

Wait for redis-benchmark completion.



.. rubric:: Parameters:

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

	*
		- app

		- redis-benchmark app handle

	*
		- timeout_ms

		- wait timeout in milliseconds



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_redis_benchmark_stop
.. _doxid-group__tapi__redis__benchmark_1ga1c2a93fe556494d1619a959af502829f:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_redis_benchmark_stop(const :ref:`tapi_redis_benchmark_app<doxid-structtapi__redis__benchmark__app>`* app)

Stop redis-benchmark. It can be started over with :ref:`tapi_redis_benchmark_start <doxid-group__tapi__redis__benchmark_1ga5b21ea01bb074af15d8134a66a3c80e2>`.



.. rubric:: Parameters:

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

	*
		- app

		- redis-benchmark app handle



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_redis_benchmark_kill
.. _doxid-group__tapi__redis__benchmark_1ga0f2ff0956898854498b12abf20752344:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_redis_benchmark_kill(const :ref:`tapi_redis_benchmark_app<doxid-structtapi__redis__benchmark__app>`* app, int signum)

Send a signal to redis-benchmark.



.. rubric:: Parameters:

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

	*
		- app

		- redis-benchmark app handle

	*
		- signum

		- signal to send



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_redis_benchmark_destroy
.. _doxid-group__tapi__redis__benchmark_1ga0bfb1c744b19a148ce47cf8d16530a31:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_redis_benchmark_destroy(:ref:`tapi_redis_benchmark_app<doxid-structtapi__redis__benchmark__app>`* app)

Destroy redis-benchmark.



.. rubric:: Parameters:

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

	*
		- app

		- redis-benchmark app handle



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_redis_benchmark_destroy_report
.. _doxid-group__tapi__redis__benchmark_1gadde36b1fa9ae4053ef13efcae7ab83fa:

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

	void tapi_redis_benchmark_destroy_report(tapi_redis_benchmark_report* entry)

Empty redis-benchmark report list and free it entries.



.. rubric:: Parameters:

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

	*
		- entry

		- report list entry

.. index:: pair: function; tapi_redis_benchmark_get_report
.. _doxid-group__tapi__redis__benchmark_1ga1e08093d2584757fc4aecb7b4f6435f7:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_redis_benchmark_get_report(:ref:`tapi_redis_benchmark_app<doxid-structtapi__redis__benchmark__app>`* app, tapi_redis_benchmark_report* report)

Get redis-benchmark report.



.. rubric:: Parameters:

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

	*
		- app

		- redis-benchmark app handle

	*
		- report

		- redis-benchmark statistics report



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_redis_benchmark_report_get_stat
.. _doxid-group__tapi__redis__benchmark_1gaf5e8bd4132dc5f8fb8ea59b1ee6221c5:

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

	:ref:`tapi_redis_benchmark_stat<doxid-structtapi__redis__benchmark__stat>`* tapi_redis_benchmark_report_get_stat(tapi_redis_benchmark_report* report, const char* test_name)

Get redis-benchmark statistics for a test name.



.. rubric:: Parameters:

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

	*
		- report

		- redis-benchmark report

	*
		- test_name

		- test name



.. rubric:: Returns:

redis-benchmark statistic or ``NULL`` in case of failure

.. index:: pair: function; tapi_redis_benchmark_report_mi_log
.. _doxid-group__tapi__redis__benchmark_1gac6780a480acd36d41945f58f8d7db538:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_redis_benchmark_report_mi_log(:ref:`te_mi_logger<doxid-group__te__tools__te__mi__log_1gaec19168a124d0845de6936405b58a4f5>`* logger, tapi_redis_benchmark_report* report)

Add redis-benchmark report to MI logger.



.. rubric:: Parameters:

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

	*
		- report

		- redis-benchmark statistics report



.. rubric:: Returns:

Status code.