:orphan:

.. index:: pair: group; Interface statistics
.. _doxid-group__tapi__conf__stats:

Interface statistics
====================

.. toctree::
	:hidden:

	struct_tapi_cfg_if_irq_per_cpu.rst
	struct_tapi_cfg_if_irq_stats.rst
	struct_tapi_cfg_if_stats.rst
	struct_tapi_cfg_if_xstat.rst
	struct_tapi_cfg_if_xstats.rst
	struct_tapi_cfg_net_stats.rst
	struct_tapi_cfg_net_stats_icmp.rst
	struct_tapi_cfg_net_stats_ipv4.rst

Overview
~~~~~~~~




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

	
	// typedefs

	typedef struct :ref:`tapi_cfg_if_stats<doxid-structtapi__cfg__if__stats>` :target:`tapi_cfg_if_stats<doxid-group__tapi__conf__stats_1gac62e39b5a0799791c044da078e28e8d3>`;
	typedef struct :ref:`tapi_cfg_if_xstat<doxid-structtapi__cfg__if__xstat>` :target:`tapi_cfg_if_xstat<doxid-group__tapi__conf__stats_1gaa5b34a464335e2abff2afef537c27742>`;
	typedef struct :ref:`tapi_cfg_if_xstats<doxid-structtapi__cfg__if__xstats>` :target:`tapi_cfg_if_xstats<doxid-group__tapi__conf__stats_1gad42a06d8913494969bc394d709decfc9>`;
	typedef struct :ref:`tapi_cfg_if_irq_per_cpu<doxid-structtapi__cfg__if__irq__per__cpu>` :target:`tapi_cfg_if_irq_per_cpu<doxid-group__tapi__conf__stats_1gae9924dff2053fbaf0eef39b90f488a80>`;
	typedef struct :ref:`tapi_cfg_if_irq_stats<doxid-structtapi__cfg__if__irq__stats>` :target:`tapi_cfg_if_irq_stats<doxid-group__tapi__conf__stats_1ga2a707f01bbd183359304654f35dca12d>`;
	typedef struct :ref:`tapi_cfg_net_stats_ipv4<doxid-structtapi__cfg__net__stats__ipv4>` :target:`tapi_cfg_net_stats_ipv4<doxid-group__tapi__conf__stats_1gac627bdf6a88ddbb1bb2509f5b3a50b32>`;
	typedef struct :ref:`tapi_cfg_net_stats_icmp<doxid-structtapi__cfg__net__stats__icmp>` :target:`tapi_cfg_net_stats_icmp<doxid-group__tapi__conf__stats_1ga20ce8ed7dbeb79f7bac54991830d79a6>`;
	typedef struct :ref:`tapi_cfg_net_stats<doxid-structtapi__cfg__net__stats>` :target:`tapi_cfg_net_stats<doxid-group__tapi__conf__stats_1ga543989ed6bcad94a00256ef75555c99b>`;

	// structs

	struct :ref:`tapi_cfg_if_irq_per_cpu<doxid-structtapi__cfg__if__irq__per__cpu>`;
	struct :ref:`tapi_cfg_if_irq_stats<doxid-structtapi__cfg__if__irq__stats>`;
	struct :ref:`tapi_cfg_if_stats<doxid-structtapi__cfg__if__stats>`;
	struct :ref:`tapi_cfg_if_xstat<doxid-structtapi__cfg__if__xstat>`;
	struct :ref:`tapi_cfg_if_xstats<doxid-structtapi__cfg__if__xstats>`;
	struct :ref:`tapi_cfg_net_stats<doxid-structtapi__cfg__net__stats>`;
	struct :ref:`tapi_cfg_net_stats_icmp<doxid-structtapi__cfg__net__stats__icmp>`;
	struct :ref:`tapi_cfg_net_stats_ipv4<doxid-structtapi__cfg__net__stats__ipv4>`;

	// global variables

	:ref:`te_vec_item_destroy_fn<doxid-group__te__tools__te__vec_1ga6a03d5a2b2b7195e87f466dd8f2b7fd0>` :ref:`tapi_cfg_stats_free_irqs_vec<doxid-group__tapi__conf__stats_1ga2a98babaaac4929c2eddd879574461b3>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_stats_if_stats_get<doxid-group__tapi__conf__stats_1ga3ac26525f2460ab24cad8ef8df610ddc>`(const char* ta, const char* ifname, :ref:`tapi_cfg_if_stats<doxid-structtapi__cfg__if__stats>`* stats);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_stats_if_stats_print<doxid-group__tapi__conf__stats_1gaf828369c2b4394d8df3fb25217780e9d>`(const char* ta, const char* ifname, :ref:`tapi_cfg_if_stats<doxid-structtapi__cfg__if__stats>`* stats);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_stats_if_stats_print_diff<doxid-group__tapi__conf__stats_1ga9dade7c07a24c7c4c6b83405cbf6ff2a>`(const :ref:`tapi_cfg_if_stats<doxid-structtapi__cfg__if__stats>`* stats, const :ref:`tapi_cfg_if_stats<doxid-structtapi__cfg__if__stats>`* prev, const char* descr_fmt, ...);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_stats_if_xstats_get<doxid-group__tapi__conf__stats_1ga6ab7a875d0f1983d224d4e4855d8700c>`(const char* ta, const char* ifname, :ref:`tapi_cfg_if_xstats<doxid-structtapi__cfg__if__xstats>`* stats);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_stats_if_xstats_print_diff<doxid-group__tapi__conf__stats_1gaab0465cb4a89072a3fea4d830e37236b>`(const :ref:`tapi_cfg_if_xstats<doxid-structtapi__cfg__if__xstats>`* stats, const :ref:`tapi_cfg_if_xstats<doxid-structtapi__cfg__if__xstats>`* prev, const char* descr_fmt, ...);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_stats_if_xstats_print<doxid-group__tapi__conf__stats_1ga4e5fa1adcf7373a50830f7b234c15c76>`(const char* ta, const char* ifname, :ref:`tapi_cfg_if_xstats<doxid-structtapi__cfg__if__xstats>`* xstats);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_stats_if_irq_stats_get<doxid-group__tapi__conf__stats_1gae5284cfe7cb21e9a49efb70a2a7d53ba>`(const char* ta, const char* ifname, :ref:`te_vec<doxid-structte__vec>`* irq_stats);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_stats_if_irq_print_diff<doxid-group__tapi__conf__stats_1gaa58acbe25206124e2c3adabaf01d4475>`(const :ref:`te_vec<doxid-structte__vec>`* stats, const :ref:`te_vec<doxid-structte__vec>`* prev, const char* descr_fmt, ...);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_stats_if_irq_print<doxid-group__tapi__conf__stats_1ga992797e5860bc18990da499240e81d52>`(const char* ta, const char* ifname, :ref:`te_vec<doxid-structte__vec>`* irq_stats);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_stats_net_stats_get<doxid-group__tapi__conf__stats_1ga767aa189b4706e351fd45d393d8ef8de>`(const char* ta, :ref:`tapi_cfg_net_stats<doxid-structtapi__cfg__net__stats>`* stats);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_stats_net_stats_print<doxid-group__tapi__conf__stats_1ga0c48db95e9fe2e8357ab9a08b775ec6b>`(const char* ta, :ref:`tapi_cfg_net_stats<doxid-structtapi__cfg__net__stats>`* stats);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_stats_net_stats_print_diff<doxid-group__tapi__conf__stats_1gafa85d532693a36552cf285c12b734e17>`(const :ref:`tapi_cfg_net_stats<doxid-structtapi__cfg__net__stats>`* stats, const :ref:`tapi_cfg_net_stats<doxid-structtapi__cfg__net__stats>`* prev, const char* descr_fmt, ...);

.. _details-group__tapi__conf__stats:

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



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

.. index:: pair: variable; tapi_cfg_stats_free_irqs_vec
.. _doxid-group__tapi__conf__stats_1ga2a98babaaac4929c2eddd879574461b3:

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

	:ref:`te_vec_item_destroy_fn<doxid-group__te__tools__te__vec_1ga6a03d5a2b2b7195e87f466dd8f2b7fd0>` tapi_cfg_stats_free_irqs_vec

Release sources grabbed for IRQ per CPU statistics.

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

.. index:: pair: function; tapi_cfg_stats_if_stats_get
.. _doxid-group__tapi__conf__stats_1ga3ac26525f2460ab24cad8ef8df610ddc:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_stats_if_stats_get(const char* ta, const char* ifname, :ref:`tapi_cfg_if_stats<doxid-structtapi__cfg__if__stats>`* stats)

Get IfTable statistics for the certain network interface.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent to gather statistics on

	*
		- ifname

		- Network interface to gather statistics of

	*
		- stats

		- Resulted interface statistics structure



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_stats_if_stats_print
.. _doxid-group__tapi__conf__stats_1gaf828369c2b4394d8df3fb25217780e9d:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_stats_if_stats_print(const char* ta, const char* ifname, :ref:`tapi_cfg_if_stats<doxid-structtapi__cfg__if__stats>`* stats)

Print IfTable statistics for the certain network interface.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent to gather statistics on

	*
		- ifname

		- Network interface to gather statistics of

	*
		- stats

		- Gathered interface statistics structure to print



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_stats_if_stats_print_diff
.. _doxid-group__tapi__conf__stats_1ga9dade7c07a24c7c4c6b83405cbf6ff2a:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_stats_if_stats_print_diff(const :ref:`tapi_cfg_if_stats<doxid-structtapi__cfg__if__stats>`* stats, const :ref:`tapi_cfg_if_stats<doxid-structtapi__cfg__if__stats>`* prev, const char* descr_fmt, ...)

Print IfTable statistics difference with provided description.



.. rubric:: Parameters:

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

	*
		- stats

		- Interface statistics.

	*
		- prev

		- Previous interface statistics or ``NULL``.

	*
		- descr_fmt

		- Description format string with arguments.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_cfg_stats_if_xstats_get
.. _doxid-group__tapi__conf__stats_1ga6ab7a875d0f1983d224d4e4855d8700c:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_stats_if_xstats_get(const char* ta, const char* ifname, :ref:`tapi_cfg_if_xstats<doxid-structtapi__cfg__if__xstats>`* stats)

Get ethtool statistics for the certain network interface.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent to gather statistics on

	*
		- ifname

		- Network interface to gather statistics of

	*
		- xstats

		- Resulted interface extended statistics structure



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_stats_if_xstats_print_diff
.. _doxid-group__tapi__conf__stats_1gaab0465cb4a89072a3fea4d830e37236b:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_stats_if_xstats_print_diff(const :ref:`tapi_cfg_if_xstats<doxid-structtapi__cfg__if__xstats>`* stats, const :ref:`tapi_cfg_if_xstats<doxid-structtapi__cfg__if__xstats>`* prev, const char* descr_fmt, ...)

Print ethtool statistics difference with provided description.



.. rubric:: Parameters:

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

	*
		- stats

		- Interface statistics from ethtool.

	*
		- prev

		- Previous interface statistics from ethtool or ``NULL``.

	*
		- descr_fmt

		- Description format string with arguments.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_cfg_stats_if_xstats_print
.. _doxid-group__tapi__conf__stats_1ga4e5fa1adcf7373a50830f7b234c15c76:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_stats_if_xstats_print(const char* ta, const char* ifname, :ref:`tapi_cfg_if_xstats<doxid-structtapi__cfg__if__xstats>`* xstats)

Print ethtool statistics for the certain network interface.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent to gather statistics on

	*
		- ifname

		- Network interface to gather statistics of

	*
		- stats

		- Gathered extended interface statistics structure to print



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_stats_if_irq_stats_get
.. _doxid-group__tapi__conf__stats_1gae5284cfe7cb21e9a49efb70a2a7d53ba:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_stats_if_irq_stats_get(const char* ta, const char* ifname, :ref:`te_vec<doxid-structte__vec>`* irq_stats)

Get IRQ per CPU statistics for the certain network interface.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent to gather statistics on

	*
		- ifname

		- Network interface to gather statistics of

	*
		- irq_stats

		- Resulted IRQ per CPU statistics structure



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_stats_if_irq_print_diff
.. _doxid-group__tapi__conf__stats_1gaa58acbe25206124e2c3adabaf01d4475:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_stats_if_irq_print_diff(const :ref:`te_vec<doxid-structte__vec>`* stats, const :ref:`te_vec<doxid-structte__vec>`* prev, const char* descr_fmt, ...)

Print IRQ per CPU difference with provided description.



.. rubric:: Parameters:

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

	*
		- stats

		- IRQ per CPU statistics

	*
		- prev

		- Previous IRQ per CPU statistics ``NULL``

	*
		- descr_fmt

		- Description format string with arguments



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_stats_if_irq_print
.. _doxid-group__tapi__conf__stats_1ga992797e5860bc18990da499240e81d52:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_stats_if_irq_print(const char* ta, const char* ifname, :ref:`te_vec<doxid-structte__vec>`* irq_stats)

Print IRQ per CPU statistics for the certain network interface.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent to gather statistics on

	*
		- ifname

		- Network interface to gather statistics of

	*
		- irq_stats

		- Gathered IRQ per CPU interface statistics structure to print



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_stats_net_stats_get
.. _doxid-group__tapi__conf__stats_1ga767aa189b4706e351fd45d393d8ef8de:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_stats_net_stats_get(const char* ta, :ref:`tapi_cfg_net_stats<doxid-structtapi__cfg__net__stats>`* stats)

Get /proc/net/snmp like statistics for the host, where Test Agent is running.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent to gather statistics on

	*
		- stats

		- Resulted host statistics structure



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_stats_net_stats_print
.. _doxid-group__tapi__conf__stats_1ga0c48db95e9fe2e8357ab9a08b775ec6b:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_stats_net_stats_print(const char* ta, :ref:`tapi_cfg_net_stats<doxid-structtapi__cfg__net__stats>`* stats)

Print /proc/net/snmp like statistics for the host, where Test Agent is running.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent to gether statistics on

	*
		- stats

		- Gathered host statistics structure to print



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_stats_net_stats_print_diff
.. _doxid-group__tapi__conf__stats_1gafa85d532693a36552cf285c12b734e17:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_stats_net_stats_print_diff(const :ref:`tapi_cfg_net_stats<doxid-structtapi__cfg__net__stats>`* stats, const :ref:`tapi_cfg_net_stats<doxid-structtapi__cfg__net__stats>`* prev, const char* descr_fmt, ...)

Print /proc/net/snmp like statistics difference with provided description.



.. rubric:: Parameters:

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

	*
		- stats

		- Network statistics.

	*
		- prev

		- Previous network statistics or ``NULL``.

	*
		- descr_fmt

		- Description format string with arguments.



.. rubric:: Returns:

Status code.