:orphan:

.. index:: pair: struct; tapi_perf_opts
.. _doxid-structtapi__perf__opts:

struct tapi_perf_opts
=====================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Network throughput test tool options :ref:`More...<details-structtapi__perf__opts>`


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

	#include <tapi_performance.h>
	
	struct tapi_perf_opts {
		// fields
	
		char* :ref:`host<doxid-structtapi__perf__opts_1a8e3238b1c0231dfa344118706ca3fba8>`;
		char* :ref:`src_host<doxid-structtapi__perf__opts_1aaaa58329bf11799ec6d9e413ba5a3ea1>`;
		int :ref:`port<doxid-structtapi__perf__opts_1a977494292040fdc16ad832da1e64e341>`;
		:ref:`rpc_socket_proto<doxid-te__rpc__sys__socket_8h_1ae7332b60b383ee93a90fa26e224ab739>` :ref:`ipversion<doxid-structtapi__perf__opts_1a46ba9b53300e875cb643b045c081f343>`;
		:ref:`rpc_socket_proto<doxid-te__rpc__sys__socket_8h_1ae7332b60b383ee93a90fa26e224ab739>` :ref:`protocol<doxid-structtapi__perf__opts_1a9750592fc0c3c8071cbba939200fa6fd>`;
		int64_t :ref:`bandwidth_bits<doxid-structtapi__perf__opts_1ae70a385ef9c149ebf92c5de2a30dc774>`;
		int64_t :ref:`num_bytes<doxid-structtapi__perf__opts_1a7833c2f238f4be60921aa19ca6e885b2>`;
		int32_t :ref:`duration_sec<doxid-structtapi__perf__opts_1acd58a6918ae385a61780ee1746d5229d>`;
		int32_t :ref:`interval_sec<doxid-structtapi__perf__opts_1a3a9dbfadc51a22a7b1bbba974fc096ff>`;
		int32_t :ref:`length<doxid-structtapi__perf__opts_1aa90ec8600f1f5bee3a5f87c923eed571>`;
		int16_t :ref:`streams<doxid-structtapi__perf__opts_1ae8ca5f6aeff609920d88e168bd996f7a>`;
		bool :ref:`reverse<doxid-structtapi__perf__opts_1a284ad118bd64805e0272df2fdaff824d>`;
		bool :ref:`dual<doxid-structtapi__perf__opts_1ac59c75d9edf488f1d41a869e7257e4a9>`;
	};
.. _details-structtapi__perf__opts:

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

Network throughput test tool options

Fields
------

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

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

	char* host

Destination host (server)

.. index:: pair: variable; src_host
.. _doxid-structtapi__perf__opts_1aaaa58329bf11799ec6d9e413ba5a3ea1:

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

	char* src_host

Source host (client)

.. index:: pair: variable; port
.. _doxid-structtapi__perf__opts_1a977494292040fdc16ad832da1e64e341:

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

	int port

Port to listen on/connect to

.. index:: pair: variable; ipversion
.. _doxid-structtapi__perf__opts_1a46ba9b53300e875cb643b045c081f343:

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

	:ref:`rpc_socket_proto<doxid-te__rpc__sys__socket_8h_1ae7332b60b383ee93a90fa26e224ab739>` ipversion

IP version

.. index:: pair: variable; protocol
.. _doxid-structtapi__perf__opts_1a9750592fc0c3c8071cbba939200fa6fd:

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

	:ref:`rpc_socket_proto<doxid-te__rpc__sys__socket_8h_1ae7332b60b383ee93a90fa26e224ab739>` protocol

Transport protocol

.. index:: pair: variable; bandwidth_bits
.. _doxid-structtapi__perf__opts_1ae70a385ef9c149ebf92c5de2a30dc774:

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

	int64_t bandwidth_bits

Target bandwidth (bits/sec)

.. index:: pair: variable; num_bytes
.. _doxid-structtapi__perf__opts_1a7833c2f238f4be60921aa19ca6e885b2:

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

	int64_t num_bytes

Number of bytes to transmit (instead of time)

.. index:: pair: variable; duration_sec
.. _doxid-structtapi__perf__opts_1acd58a6918ae385a61780ee1746d5229d:

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

	int32_t duration_sec

Time in seconds to transmit for

.. index:: pair: variable; interval_sec
.. _doxid-structtapi__perf__opts_1a3a9dbfadc51a22a7b1bbba974fc096ff:

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

	int32_t interval_sec

Pause in seconds between periodic bandwidth reports. Warning! It can affect report processing

.. index:: pair: variable; length
.. _doxid-structtapi__perf__opts_1aa90ec8600f1f5bee3a5f87c923eed571:

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

	int32_t length

Length of buffer to read or write

.. index:: pair: variable; streams
.. _doxid-structtapi__perf__opts_1ae8ca5f6aeff609920d88e168bd996f7a:

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

	int16_t streams

Number of parallel client streams

.. index:: pair: variable; reverse
.. _doxid-structtapi__perf__opts_1a284ad118bd64805e0272df2fdaff824d:

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

	bool reverse

Whether run in reverse mode (server sends, client receives), or not

.. index:: pair: variable; dual
.. _doxid-structtapi__perf__opts_1ac59c75d9edf488f1d41a869e7257e4a9:

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

	bool dual

Bidirectional mode