:orphan:

.. index:: pair: group; ping tool TAPI (tapi_ping)
.. _doxid-group__tapi__ping:

ping tool TAPI (tapi_ping)
==========================

.. toctree::
	:hidden:

	struct_tapi_ping_opt.rst
	struct_tapi_ping_report.rst
	struct_tapi_ping_rtt_stats.rst

Overview
~~~~~~~~

TAPI to handle ping tool. :ref:`More...<details-group__tapi__ping>`


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

	
	// typedefs

	typedef struct :ref:`tapi_ping_opt<doxid-structtapi__ping__opt>` :ref:`tapi_ping_opt<doxid-group__tapi__ping_1ga5b6e2720f0099006d4e06f083a076631>`;
	typedef struct :ref:`tapi_ping_rtt_stats<doxid-structtapi__ping__rtt__stats>` :target:`tapi_ping_rtt_stats<doxid-group__tapi__ping_1ga60ab403dfdc18f28bbd7fca23df6ec03>`;
	typedef struct :ref:`tapi_ping_report<doxid-structtapi__ping__report>` :ref:`tapi_ping_report<doxid-group__tapi__ping_1ga2495ef7527eff8d118391faef8c74b63>`;
	typedef struct :ref:`tapi_ping_app<doxid-group__tapi__ping_1ga29b755aa97cf243f0aed9f58a89c38ab>` :ref:`tapi_ping_app<doxid-group__tapi__ping_1ga29b755aa97cf243f0aed9f58a89c38ab>`;

	// structs

	struct :ref:`tapi_ping_opt<doxid-structtapi__ping__opt>`;
	struct :ref:`tapi_ping_report<doxid-structtapi__ping__report>`;
	struct :ref:`tapi_ping_rtt_stats<doxid-structtapi__ping__rtt__stats>`;

	// global variables

	const :ref:`tapi_ping_opt<doxid-structtapi__ping__opt>` :ref:`tapi_ping_default_opt<doxid-group__tapi__ping_1gacea1782abac059bb96eb722e4f640704>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_ping_create<doxid-group__tapi__ping_1gaf922992384758bd206a0960bcad2ce7a>`(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_ping_opt<doxid-structtapi__ping__opt>`* opt, :ref:`tapi_ping_app<doxid-group__tapi__ping_1ga29b755aa97cf243f0aed9f58a89c38ab>`** app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_ping_start<doxid-group__tapi__ping_1gad9025917f1c72fb0da1a2fc8ed49e2c1>`(:ref:`tapi_ping_app<doxid-group__tapi__ping_1ga29b755aa97cf243f0aed9f58a89c38ab>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_ping_wait<doxid-group__tapi__ping_1ga1a0dcfb47528e8d0ff56e349df0f877d>`(:ref:`tapi_ping_app<doxid-group__tapi__ping_1ga29b755aa97cf243f0aed9f58a89c38ab>`* app, int timeout_ms);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_ping_kill<doxid-group__tapi__ping_1gaef9c62f71f6b9d1e0a3c60d40dd7e1dc>`(:ref:`tapi_ping_app<doxid-group__tapi__ping_1ga29b755aa97cf243f0aed9f58a89c38ab>`* app, int signum);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_ping_stop<doxid-group__tapi__ping_1ga46a4839b1d9128f0cf80fd4b1b9e0f8e>`(:ref:`tapi_ping_app<doxid-group__tapi__ping_1ga29b755aa97cf243f0aed9f58a89c38ab>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_ping_destroy<doxid-group__tapi__ping_1ga25cbf132b82b922ae2c7c77baea67a8f>`(:ref:`tapi_ping_app<doxid-group__tapi__ping_1ga29b755aa97cf243f0aed9f58a89c38ab>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_ping_get_report<doxid-group__tapi__ping_1gae8f36c5da679f2ab34273cf68b2ab4de>`(:ref:`tapi_ping_app<doxid-group__tapi__ping_1ga29b755aa97cf243f0aed9f58a89c38ab>`* app, :ref:`tapi_ping_report<doxid-structtapi__ping__report>`* report);
	void :ref:`tapi_ping_report_mi_log<doxid-group__tapi__ping_1ga577ed32e9cfc26c736ef64ba1c29b47f>`(:ref:`te_mi_logger<doxid-group__te__tools__te__mi__log_1gaec19168a124d0845de6936405b58a4f5>`* logger, :ref:`tapi_ping_report<doxid-structtapi__ping__report>`* report);

.. _details-group__tapi__ping:

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

TAPI to handle ping tool.

Copyright (C) 2020-2022 OKTET Labs Ltd. All rights reserved.

Typedefs
--------

.. index:: pair: typedef; tapi_ping_opt
.. _doxid-group__tapi__ping_1ga5b6e2720f0099006d4e06f083a076631:

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

	typedef struct :ref:`tapi_ping_opt<doxid-structtapi__ping__opt>` tapi_ping_opt

ping tool specific command line options

.. index:: pair: typedef; tapi_ping_report
.. _doxid-group__tapi__ping_1ga2495ef7527eff8d118391faef8c74b63:

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

	typedef struct :ref:`tapi_ping_report<doxid-structtapi__ping__report>` tapi_ping_report

Statistics report of ping tool

.. index:: pair: typedef; tapi_ping_app
.. _doxid-group__tapi__ping_1ga29b755aa97cf243f0aed9f58a89c38ab:

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

	typedef struct :ref:`tapi_ping_app<doxid-group__tapi__ping_1ga29b755aa97cf243f0aed9f58a89c38ab>` tapi_ping_app

Information of a ping tool

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

.. index:: pair: variable; tapi_ping_default_opt
.. _doxid-group__tapi__ping_1gacea1782abac059bb96eb722e4f640704:

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

	const :ref:`tapi_ping_opt<doxid-structtapi__ping__opt>` tapi_ping_default_opt

Default options initializer

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

.. index:: pair: function; tapi_ping_create
.. _doxid-group__tapi__ping_1gaf922992384758bd206a0960bcad2ce7a:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_ping_create(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_ping_opt<doxid-structtapi__ping__opt>`* opt, :ref:`tapi_ping_app<doxid-group__tapi__ping_1ga29b755aa97cf243f0aed9f58a89c38ab>`** app)

Create ping app.



.. rubric:: Parameters:

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

	*
		- factory

		- Job factory

	*
		- opt

		- ping tool options

	*
		- app

		- ping app handle



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_ping_start
.. _doxid-group__tapi__ping_1gad9025917f1c72fb0da1a2fc8ed49e2c1:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_ping_start(:ref:`tapi_ping_app<doxid-group__tapi__ping_1ga29b755aa97cf243f0aed9f58a89c38ab>`* app)

Start ping tool.



.. rubric:: Parameters:

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

	*
		- app

		- ping app handle



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_ping_wait
.. _doxid-group__tapi__ping_1ga1a0dcfb47528e8d0ff56e349df0f877d:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_ping_wait(:ref:`tapi_ping_app<doxid-group__tapi__ping_1ga29b755aa97cf243f0aed9f58a89c38ab>`* app, int timeout_ms)

Wait for ping tool completion.



.. rubric:: Parameters:

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

	*
		- app

		- ping app handle

	*
		- timeout_ms

		- Wait timeout in milliseconds

	*
		- TE_EINPROGRESS

		- ping is still running



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_ping_kill
.. _doxid-group__tapi__ping_1gaef9c62f71f6b9d1e0a3c60d40dd7e1dc:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_ping_kill(:ref:`tapi_ping_app<doxid-group__tapi__ping_1ga29b755aa97cf243f0aed9f58a89c38ab>`* app, int signum)

Send a signal to ping tool.



.. rubric:: Parameters:

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

	*
		- app

		- ping app handle

	*
		- signum

		- Signal to send



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_ping_stop
.. _doxid-group__tapi__ping_1ga46a4839b1d9128f0cf80fd4b1b9e0f8e:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_ping_stop(:ref:`tapi_ping_app<doxid-group__tapi__ping_1ga29b755aa97cf243f0aed9f58a89c38ab>`* app)

Stop ping tool. It can be started over with :ref:`tapi_ping_start() <doxid-group__tapi__ping_1gad9025917f1c72fb0da1a2fc8ed49e2c1>`.



.. rubric:: Parameters:

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

	*
		- app

		- ping app handle

	*
		- TE_EPROTO

		- ping tool is stopped, but report is unavailable



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_ping_destroy
.. _doxid-group__tapi__ping_1ga25cbf132b82b922ae2c7c77baea67a8f:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_ping_destroy(:ref:`tapi_ping_app<doxid-group__tapi__ping_1ga29b755aa97cf243f0aed9f58a89c38ab>`* app)

Destroy ping app. The app cannot be used after calling this function.



.. rubric:: Parameters:

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

	*
		- app

		- ping app handle



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_ping_get_report
.. _doxid-group__tapi__ping_1gae8f36c5da679f2ab34273cf68b2ab4de:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_ping_get_report(:ref:`tapi_ping_app<doxid-group__tapi__ping_1ga29b755aa97cf243f0aed9f58a89c38ab>`* app, :ref:`tapi_ping_report<doxid-structtapi__ping__report>`* report)

Get ping tool report.



.. rubric:: Parameters:

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

	*
		- app

		- ping app handle

	*
		- report

		- ping report handle



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_ping_report_mi_log
.. _doxid-group__tapi__ping_1ga577ed32e9cfc26c736ef64ba1c29b47f:

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

	void tapi_ping_report_mi_log(:ref:`te_mi_logger<doxid-group__te__tools__te__mi__log_1gaec19168a124d0845de6936405b58a4f5>`* logger, :ref:`tapi_ping_report<doxid-structtapi__ping__report>`* report)

Add ping tool report to MI logger.



.. rubric:: Parameters:

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

	*
		- logger

		- MI logger entity

	*
		- report

		- ping tool report