:orphan:

.. index:: pair: group; Test API to interact with RDMA links
.. _doxid-group__tapi__rdma:

Test API to interact with RDMA links
====================================

.. toctree::
	:hidden:

	struct_tapi_rdma_link_stat.rst
	struct_tapi_rdma_link_stats.rst

Overview
~~~~~~~~

Generic API to interact with RDMA links. :ref:`More...<details-group__tapi__rdma>`


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

	
	// typedefs

	typedef struct :ref:`tapi_rdma_link_stat<doxid-structtapi__rdma__link__stat>` :target:`tapi_rdma_link_stat_t<doxid-group__tapi__rdma_1ga12bb082141954bd7a5b41e1a7dffed0d>`;
	typedef struct :ref:`tapi_rdma_link_stats<doxid-structtapi__rdma__link__stats>` :target:`tapi_rdma_link_stats_t<doxid-group__tapi__rdma_1gaf2cbdebf60b7c0dde3d873c71945cf1f>`;

	// structs

	struct :ref:`tapi_rdma_link_stat<doxid-structtapi__rdma__link__stat>`;
	struct :ref:`tapi_rdma_link_stats<doxid-structtapi__rdma__link__stats>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_rdma_link_get_stats<doxid-group__tapi__rdma_1gac48d8d9a8e43110f28bfdf684ac8b219>`(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, const char* link, :ref:`tapi_rdma_link_stats_t<doxid-structtapi__rdma__link__stats>`** stats);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_rdma_link_diff_stats<doxid-group__tapi__rdma_1ga6ca3bee1b9c74e22f9434c7b53ea9299>`(const :ref:`tapi_rdma_link_stats_t<doxid-structtapi__rdma__link__stats>`* old_stats, const :ref:`tapi_rdma_link_stats_t<doxid-structtapi__rdma__link__stats>`* new_stats, :ref:`tapi_rdma_link_stats_t<doxid-structtapi__rdma__link__stats>`** diff_stats);
	void :ref:`tapi_rdma_link_log_stats<doxid-group__tapi__rdma_1gaf25e5cea970aec19c5bc176cf9ae2fa5>`(:ref:`tapi_rdma_link_stats_t<doxid-structtapi__rdma__link__stats>`* stats, const char* description, const char* pattern, bool non_empty, :ref:`te_log_level<doxid-te__raw__log_8h_1a48dfa90598c674ccedb448786e1252e6>` log_level);
	void :ref:`tapi_rdma_link_free_stats<doxid-group__tapi__rdma_1gac5baf3722e1e0cd081ea15d1ef4b73cb>`(:ref:`tapi_rdma_link_stats_t<doxid-structtapi__rdma__link__stats>`* stats);

.. _details-group__tapi__rdma:

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

Generic API to interact with RDMA links.

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

.. index:: pair: function; tapi_rdma_link_get_stats
.. _doxid-group__tapi__rdma_1gac48d8d9a8e43110f28bfdf684ac8b219:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_rdma_link_get_stats(:ref:`rcf_rpc_server<doxid-structrcf__rpc__server>`* rpcs, const char* link, :ref:`tapi_rdma_link_stats_t<doxid-structtapi__rdma__link__stats>`** stats)

Collect statistics reported by an RDMA link.



.. rubric:: Parameters:

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

	*
		- rpcs

		- RPC server.

	*
		- link

		- Name of the RDMA link.

	*
		- stats

		- Where to store the statistics array.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_rdma_link_diff_stats
.. _doxid-group__tapi__rdma_1ga6ca3bee1b9c74e22f9434c7b53ea9299:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_rdma_link_diff_stats(const :ref:`tapi_rdma_link_stats_t<doxid-structtapi__rdma__link__stats>`* old_stats, const :ref:`tapi_rdma_link_stats_t<doxid-structtapi__rdma__link__stats>`* new_stats, :ref:`tapi_rdma_link_stats_t<doxid-structtapi__rdma__link__stats>`** diff_stats)

Compare two sets of statistics.



.. rubric:: Parameters:

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

	*
		- old_stats

		- Old statistics array.

	*
		- new_stats

		- New statistics array.

	*
		- diff_stats

		- Where to store the statistics diff array.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_rdma_link_log_stats
.. _doxid-group__tapi__rdma_1gaf25e5cea970aec19c5bc176cf9ae2fa5:

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

	void tapi_rdma_link_log_stats(:ref:`tapi_rdma_link_stats_t<doxid-structtapi__rdma__link__stats>`* stats, const char* description, const char* pattern, bool non_empty, :ref:`te_log_level<doxid-te__raw__log_8h_1a48dfa90598c674ccedb448786e1252e6>` log_level)

Log statistics whose name contains a given substring. Use the log level provided by the caller.



.. rubric:: Parameters:

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

	*
		- stats

		- Statistics array.

	*
		- description

		- Description line to be logged before the stats.

	*
		- pattern

		- Substring that must be in the name.

	*
		- non_empty

		- Only log if there is something to log.

	*
		- log_level

		- Log level to use.

.. index:: pair: function; tapi_rdma_link_free_stats
.. _doxid-group__tapi__rdma_1gac5baf3722e1e0cd081ea15d1ef4b73cb:

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

	void tapi_rdma_link_free_stats(:ref:`tapi_rdma_link_stats_t<doxid-structtapi__rdma__link__stats>`* stats)

Free the memory occupied by an array of RDMA link statistics.



.. rubric:: Parameters:

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

	*
		- stats

		- Statistics array.