:orphan:

.. index:: pair: group; Network statistics access
.. _doxid-group__tapi__conf__stats:

Network statistics access
=========================

.. toctree::
	:hidden:

	struct_tapi_cfg_if_stats.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_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_stats<doxid-structtapi__cfg__if__stats>`;
	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 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_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);

.. _details-group__tapi__conf__stats:

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



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_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