:orphan:

.. index:: pair: struct; tapi_perf_report
.. _doxid-structtapi__perf__report:

struct tapi_perf_report
=======================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Network throughput test tool report. :ref:`More...<details-structtapi__perf__report>`


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

	#include <tapi_performance.h>
	
	struct tapi_perf_report {
		// fields
	
		uint64_t :ref:`bytes<doxid-structtapi__perf__report_1a3f1ba86bdb57e49f849db17d7e13ed29>`;
		uint64_t :ref:`rx_bytes<doxid-structtapi__perf__report_1ae3fe6efb543109271b12a7c80cda5d92>`;
		uint64_t :ref:`tx_bytes<doxid-structtapi__perf__report_1a6188c1b31af61af32738455e2e6075b6>`;
		double :ref:`seconds<doxid-structtapi__perf__report_1a632a5a41667e0c7080e4931f5a3b5a2d>`;
		double :ref:`rx_seconds<doxid-structtapi__perf__report_1a8cf0f832fb8038f31e7e27a374504976>`;
		double :ref:`tx_seconds<doxid-structtapi__perf__report_1aed5f49522888aad9807f4f2bb5cddcf5>`;
		double :ref:`bits_per_second<doxid-structtapi__perf__report_1a58d10c02c7030d570791c4b060f95467>`;
		double :ref:`rx_bits_per_second<doxid-structtapi__perf__report_1a84262bbcf416999d3a4ed2976ffd628a>`;
		double :ref:`tx_bits_per_second<doxid-structtapi__perf__report_1ad108acae5993cbdf2cdd32fc740584be>`;
		size_t :ref:`zero_intervals<doxid-structtapi__perf__report_1a09546617951040c1583c2ec10f81de6b>`;
		double :ref:`min_bps_per_stream<doxid-structtapi__perf__report_1a4a0ba10689cfb5b5eded8117b665834d>`;
		uint64_t :ref:`retransmits<doxid-structtapi__perf__report_1aa6f8bea5b7e1b25b057567bf7a9a0fd9>`;
		uint64_t :ref:`udp_packets<doxid-structtapi__perf__report_1ad267d7a92cc9a14abce525f7ccaf6549>`;
		uint64_t :ref:`udp_lost_packets<doxid-structtapi__perf__report_1a27c9f37d901f538ee6e27181768b2823>`;
		double :ref:`udp_lost_percent<doxid-structtapi__perf__report_1a855abb309ed705fc6fc00638b4c99819>`;
		uint32_t :ref:`errors<doxid-structtapi__perf__report_1afc4b6f6815ee9d2973c429ed2eeaab3f>`[TAPI_PERF_ERROR_MAX];
	};
.. _details-structtapi__perf__report:

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

Network throughput test tool report.

Fields
------

.. index:: pair: variable; bytes
.. _doxid-structtapi__perf__report_1a3f1ba86bdb57e49f849db17d7e13ed29:

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

	uint64_t bytes

Number of bytes for iperf2 and backward compatibility

.. index:: pair: variable; rx_bytes
.. _doxid-structtapi__perf__report_1ae3fe6efb543109271b12a7c80cda5d92:

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

	uint64_t rx_bytes

Number of bytes was received

.. index:: pair: variable; tx_bytes
.. _doxid-structtapi__perf__report_1a6188c1b31af61af32738455e2e6075b6:

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

	uint64_t tx_bytes

Number of bytes was transmitted

.. index:: pair: variable; seconds
.. _doxid-structtapi__perf__report_1a632a5a41667e0c7080e4931f5a3b5a2d:

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

	double seconds

Number of seconds was expired during test for iper2 and backward compatibility

.. index:: pair: variable; rx_seconds
.. _doxid-structtapi__perf__report_1a8cf0f832fb8038f31e7e27a374504976:

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

	double rx_seconds

Number of seconds was expired during receive test

.. index:: pair: variable; tx_seconds
.. _doxid-structtapi__perf__report_1aed5f49522888aad9807f4f2bb5cddcf5:

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

	double tx_seconds

Number of seconds was expired during transmit test

.. index:: pair: variable; bits_per_second
.. _doxid-structtapi__perf__report_1a58d10c02c7030d570791c4b060f95467:

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

	double bits_per_second

Throughput for iperf2 and backward compatibility

.. index:: pair: variable; rx_bits_per_second
.. _doxid-structtapi__perf__report_1a84262bbcf416999d3a4ed2976ffd628a:

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

	double rx_bits_per_second

Receive throughput

.. index:: pair: variable; tx_bits_per_second
.. _doxid-structtapi__perf__report_1ad108acae5993cbdf2cdd32fc740584be:

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

	double tx_bits_per_second

Transmit throughput

.. index:: pair: variable; zero_intervals
.. _doxid-structtapi__perf__report_1a09546617951040c1583c2ec10f81de6b:

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

	size_t zero_intervals

Number of zero intervals

.. index:: pair: variable; min_bps_per_stream
.. _doxid-structtapi__perf__report_1a4a0ba10689cfb5b5eded8117b665834d:

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

	double min_bps_per_stream

Minimal rate observed for any stream at the end of report

.. index:: pair: variable; retransmits
.. _doxid-structtapi__perf__report_1aa6f8bea5b7e1b25b057567bf7a9a0fd9:

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

	uint64_t retransmits

Number of retransmits

.. index:: pair: variable; udp_packets
.. _doxid-structtapi__perf__report_1ad267d7a92cc9a14abce525f7ccaf6549:

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

	uint64_t udp_packets

Number of UDP packets was transmitted

.. index:: pair: variable; udp_lost_packets
.. _doxid-structtapi__perf__report_1a27c9f37d901f538ee6e27181768b2823:

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

	uint64_t udp_lost_packets

Number of UDP packets lost

.. index:: pair: variable; udp_lost_percent
.. _doxid-structtapi__perf__report_1a855abb309ed705fc6fc00638b4c99819:

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

	double udp_lost_percent

UDP packet loss percentage

.. index:: pair: variable; errors
.. _doxid-structtapi__perf__report_1afc4b6f6815ee9d2973c429ed2eeaab3f:

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

	uint32_t errors[TAPI_PERF_ERROR_MAX]

Errors counters.