:orphan:

.. index:: pair: struct; tapi_wrk_opt
.. _doxid-structtapi__wrk__opt:

struct tapi_wrk_opt
===================

.. toctree::
	:hidden:

Overview
~~~~~~~~

wrk tool specific command line options :ref:`More...<details-structtapi__wrk__opt>`


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

	#include <tapi_wrk.h>
	
	struct tapi_wrk_opt {
		// fields
	
		:ref:`te_log_level<doxid-te__raw__log_8h_1a48dfa90598c674ccedb448786e1252e6>` :ref:`stdout_log_level<doxid-structtapi__wrk__opt_1acb62f8ef9ff1dbf1fc282b287ecd66c0>`;
		:ref:`te_log_level<doxid-te__raw__log_8h_1a48dfa90598c674ccedb448786e1252e6>` :ref:`stderr_log_level<doxid-structtapi__wrk__opt_1acd3e38f77edd0abc36c692681ddb2624>`;
		unsigned int :ref:`connections<doxid-structtapi__wrk__opt_1a20ca037d1659fd1cfb74b3e2f6502faf>`;
		unsigned int :ref:`n_threads<doxid-structtapi__wrk__opt_1af4d8a30758c8745655b0cd08e2ec15b3>`;
		unsigned int :ref:`duration_s<doxid-structtapi__wrk__opt_1ae4f6c0c0ddd818c61af332b28513211f>`;
		unsigned int :ref:`timeout_ms<doxid-structtapi__wrk__opt_1ad8fc42d4069f49b881627e2019d1bbbb>`;
		const char* :ref:`script_content<doxid-structtapi__wrk__opt_1aa4257ece874d3cdb37a5e8b97c636b5e>`;
		const char* :ref:`script_path<doxid-structtapi__wrk__opt_1a01dc8dcf0e1dbbe72cf638d12c12e927>`;
		size_t :ref:`n_script_args<doxid-structtapi__wrk__opt_1a46fc1efcc0a026b6517aa7af3ed41f07>`;
		const char* :ref:`script_args<doxid-structtapi__wrk__opt_1acdd22c82008b2f61b619259c798db90e>`[TAPI_WRK_SCRIPT_ARGS_MAX];
		size_t :ref:`n_headers<doxid-structtapi__wrk__opt_1ad6b46330213137ba8528d8468856e691>`;
		const char* :ref:`headers<doxid-structtapi__wrk__opt_1ab5d6724c76c68ee2061b253d16bdbe76>`[TAPI_WRK_HEADERS_MAX];
		bool :ref:`latency<doxid-structtapi__wrk__opt_1a55e740da6ea4c50e34b2760eabef0064>`;
		const char* :ref:`host<doxid-structtapi__wrk__opt_1a11a87aafef0659fe70ba5d8b192befcd>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`rate<doxid-structtapi__wrk__opt_1a1121298e0637eb37cb22dcd3ff1abe2e>`;
		const char* :ref:`affinity<doxid-structtapi__wrk__opt_1ae5cbdd6e51723ff58c2ff067987b4788>`;
	};
.. _details-structtapi__wrk__opt:

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

wrk tool specific command line options

Fields
------

.. index:: pair: variable; stdout_log_level
.. _doxid-structtapi__wrk__opt_1acb62f8ef9ff1dbf1fc282b287ecd66c0:

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

	:ref:`te_log_level<doxid-te__raw__log_8h_1a48dfa90598c674ccedb448786e1252e6>` stdout_log_level

Standard output logging level (default is ``TE_LL_RING``).

.. index:: pair: variable; stderr_log_level
.. _doxid-structtapi__wrk__opt_1acd3e38f77edd0abc36c692681ddb2624:

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

	:ref:`te_log_level<doxid-te__raw__log_8h_1a48dfa90598c674ccedb448786e1252e6>` stderr_log_level

Standard error logging level (default is ``TE_LL_ERROR``).

.. index:: pair: variable; connections
.. _doxid-structtapi__wrk__opt_1a20ca037d1659fd1cfb74b3e2f6502faf:

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

	unsigned int connections

Number of connections to keep open

.. index:: pair: variable; n_threads
.. _doxid-structtapi__wrk__opt_1af4d8a30758c8745655b0cd08e2ec15b3:

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

	unsigned int n_threads

Number of threads to use

.. index:: pair: variable; duration_s
.. _doxid-structtapi__wrk__opt_1ae4f6c0c0ddd818c61af332b28513211f:

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

	unsigned int duration_s

Duration of test in seconds

.. index:: pair: variable; timeout_ms
.. _doxid-structtapi__wrk__opt_1ad8fc42d4069f49b881627e2019d1bbbb:

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

	unsigned int timeout_ms

Socket/request timeout in milliseconds

.. index:: pair: variable; script_content
.. _doxid-structtapi__wrk__opt_1aa4257ece874d3cdb37a5e8b97c636b5e:

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

	const char* script_content

Load Lua script file. The file is created in TA only if script content is not NULL.

.. index:: pair: variable; script_path
.. _doxid-structtapi__wrk__opt_1a01dc8dcf0e1dbbe72cf638d12c12e927:

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

	const char* script_path

The file path is auto-generated only if the path is ``NULL`` AND script_content is not ``NULL``.

.. index:: pair: variable; n_script_args
.. _doxid-structtapi__wrk__opt_1a46fc1efcc0a026b6517aa7af3ed41f07:

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

	size_t n_script_args

Number of actual arguments in *script_args*.

.. index:: pair: variable; script_args
.. _doxid-structtapi__wrk__opt_1acdd22c82008b2f61b619259c798db90e:

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

	const char* script_args[TAPI_WRK_SCRIPT_ARGS_MAX]

Script arguments.

.. index:: pair: variable; n_headers
.. _doxid-structtapi__wrk__opt_1ad6b46330213137ba8528d8468856e691:

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

	size_t n_headers

Number of actual headers in *headers*

.. index:: pair: variable; headers
.. _doxid-structtapi__wrk__opt_1ab5d6724c76c68ee2061b253d16bdbe76:

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

	const char* headers[TAPI_WRK_HEADERS_MAX]

Request headers in "Name: Value" format (note the space).

.. index:: pair: variable; latency
.. _doxid-structtapi__wrk__opt_1a55e740da6ea4c50e34b2760eabef0064:

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

	bool latency

Print latency statistics

.. index:: pair: variable; host
.. _doxid-structtapi__wrk__opt_1a11a87aafef0659fe70ba5d8b192befcd:

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

	const char* host

Host to connect to

.. index:: pair: variable; rate
.. _doxid-structtapi__wrk__opt_1a1121298e0637eb37cb22dcd3ff1abe2e:

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

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` rate

wrk2: work rate (throughput) in requests/sec (total).

.. index:: pair: variable; affinity
.. _doxid-structtapi__wrk__opt_1ae5cbdd6e51723ff58c2ff067987b4788:

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

	const char* affinity

wrk2/patched: affinity list (for example 0,2,4,6).