:orphan:

.. index:: pair: group; NPtcp tool tapi (tapi_nptcp)
.. _doxid-group__tapi__nptcp:

NPtcp tool tapi (tapi_nptcp)
============================

.. toctree::
	:hidden:

	struct_tapi_nptcp_app.rst
	struct_tapi_nptcp_opt.rst
	struct_tapi_nptcp_report_entry.rst

Overview
~~~~~~~~

TAPI to handle NPtcp tool. :ref:`More...<details-group__tapi__nptcp>`


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

	
	// typedefs

	typedef struct :ref:`tapi_nptcp_opt<doxid-structtapi__nptcp__opt>` :ref:`tapi_nptcp_opt<doxid-group__tapi__nptcp_1gab0dd6e569974b5395ca2ba123472eea6>`;
	typedef struct :ref:`tapi_nptcp_report_entry<doxid-structtapi__nptcp__report__entry>` :ref:`tapi_nptcp_report_entry<doxid-group__tapi__nptcp_1ga8007dc608c76d6d1635f0add7289d9a6>`;
	typedef struct :ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>` :ref:`tapi_nptcp_app<doxid-group__tapi__nptcp_1ga03481deb654659994e7a54e84de7df66>`;

	// structs

	struct :ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`;
	struct :ref:`tapi_nptcp_opt<doxid-structtapi__nptcp__opt>`;
	struct :ref:`tapi_nptcp_report_entry<doxid-structtapi__nptcp__report__entry>`;

	// global variables

	const :ref:`tapi_nptcp_opt<doxid-structtapi__nptcp__opt>` :ref:`tapi_nptcp_default_opt<doxid-group__tapi__nptcp_1ga116449dedfbdb50e1f6f01d7fbfc12ab>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_nptcp_create<doxid-group__tapi__nptcp_1ga582fe0a706ba0f0afc1417336c6834eb>`(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory_receiver, :ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory_transmitter, const :ref:`tapi_nptcp_opt<doxid-structtapi__nptcp__opt>`* opt_receiver, const :ref:`tapi_nptcp_opt<doxid-structtapi__nptcp__opt>`* opt_transmitter, :ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`** app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_nptcp_start<doxid-group__tapi__nptcp_1ga3a115e54c2b96ae30b25064245e837fc>`(:ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_nptcp_wait<doxid-group__tapi__nptcp_1gaee0d15878a0a57fd342e86e8ddecbf46>`(:ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`* app, int timeout_ms);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_nptcp_wait_receiver<doxid-group__tapi__nptcp_1ga9384fe6e230451255959ddf88e7ae37f>`(:ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`* app, int timeout_ms);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_nptcp_wait_transmitter<doxid-group__tapi__nptcp_1ga076c9659b90a5f9339c0fc44db31da7c>`(:ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`* app, int timeout_ms);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_nptcp_get_report<doxid-group__tapi__nptcp_1ga6b5dfd4b00de78b8ede01c5869e61b84>`(:ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`* app, :ref:`te_vec<doxid-structte__vec>`* report);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_nptcp_kill_receiver<doxid-group__tapi__nptcp_1ga17bbf2ca066a7bf3dcc95452addb97fb>`(:ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`* app, int signum);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_nptcp_kill_transmitter<doxid-group__tapi__nptcp_1ga12753205227f19850ae664da099004c0>`(:ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`* app, int signum);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_nptcp_stop<doxid-group__tapi__nptcp_1ga2b078eb979520835c71bfab0ded9bc12>`(:ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_nptcp_destroy<doxid-group__tapi__nptcp_1ga32eadd03533cab63016697e3745b253b>`(:ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`* app);
	void :ref:`tapi_nptcp_report_mi_log<doxid-group__tapi__nptcp_1gab3cb389ec38328d9b85787f1b8680a04>`(:ref:`te_mi_logger<doxid-group__te__tools__te__mi__log_1gaec19168a124d0845de6936405b58a4f5>`* logger, :ref:`te_vec<doxid-structte__vec>`* report);

.. _details-group__tapi__nptcp:

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

TAPI to handle NPtcp tool.

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

Typedefs
--------

.. index:: pair: typedef; tapi_nptcp_opt
.. _doxid-group__tapi__nptcp_1gab0dd6e569974b5395ca2ba123472eea6:

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

	typedef struct :ref:`tapi_nptcp_opt<doxid-structtapi__nptcp__opt>` tapi_nptcp_opt

NPtcp tool specific command line options

.. index:: pair: typedef; tapi_nptcp_report_entry
.. _doxid-group__tapi__nptcp_1ga8007dc608c76d6d1635f0add7289d9a6:

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

	typedef struct :ref:`tapi_nptcp_report_entry<doxid-structtapi__nptcp__report__entry>` tapi_nptcp_report_entry

Entry (row) of NPtcp statistics report

.. index:: pair: typedef; tapi_nptcp_app
.. _doxid-group__tapi__nptcp_1ga03481deb654659994e7a54e84de7df66:

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

	typedef struct :ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>` tapi_nptcp_app

Information of a NPtcp tool

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

.. index:: pair: variable; tapi_nptcp_default_opt
.. _doxid-group__tapi__nptcp_1ga116449dedfbdb50e1f6f01d7fbfc12ab:

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

	const :ref:`tapi_nptcp_opt<doxid-structtapi__nptcp__opt>` tapi_nptcp_default_opt

Default options initializer

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

.. index:: pair: function; tapi_nptcp_create
.. _doxid-group__tapi__nptcp_1ga582fe0a706ba0f0afc1417336c6834eb:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_nptcp_create(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory_receiver, :ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory_transmitter, const :ref:`tapi_nptcp_opt<doxid-structtapi__nptcp__opt>`* opt_receiver, const :ref:`tapi_nptcp_opt<doxid-structtapi__nptcp__opt>`* opt_transmitter, :ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`** app)

Create NPtcp app.



.. rubric:: Parameters:

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

	*
		- factory_receiver

		- Job factory for receiver.

	*
		- factory_transmitter

		- Job factory for transmitter.

	*
		- opt_receiver

		- Options to run NPtcp with on receiver's side.

	*
		- opt_transmitter

		- Options to run NPtcp with on transmitter's side.

	*
		- app

		- NPtcp app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_nptcp_start
.. _doxid-group__tapi__nptcp_1ga3a115e54c2b96ae30b25064245e837fc:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_nptcp_start(:ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`* app)

Start NPtcp.



.. rubric:: Parameters:

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

	*
		- app

		- NPtcp app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_nptcp_wait
.. _doxid-group__tapi__nptcp_1gaee0d15878a0a57fd342e86e8ddecbf46:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_nptcp_wait(:ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`* app, int timeout_ms)

Wait for NPtcp completion.



.. rubric:: Parameters:

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

	*
		- app

		- NPtcp app handle.

	*
		- timeout_ms

		- Wait timeout in milliseconds.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_nptcp_wait_receiver
.. _doxid-group__tapi__nptcp_1ga9384fe6e230451255959ddf88e7ae37f:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_nptcp_wait_receiver(:ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`* app, int timeout_ms)

Wait for NPtcp receiver completion. It should be used only if :ref:`tapi_nptcp_kill_receiver() <doxid-group__tapi__nptcp_1ga17bbf2ca066a7bf3dcc95452addb97fb>` or :ref:`tapi_nptcp_kill_transmitter() <doxid-group__tapi__nptcp_1ga12753205227f19850ae664da099004c0>` was called. If you want to wait for the tool completion, use :ref:`tapi_nptcp_wait() <doxid-group__tapi__nptcp_1gaee0d15878a0a57fd342e86e8ddecbf46>`. Same applies to :ref:`tapi_nptcp_wait_transmitter() <doxid-group__tapi__nptcp_1ga076c9659b90a5f9339c0fc44db31da7c>`.



.. rubric:: Parameters:

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

	*
		- app

		- NPtcp app handle.

	*
		- timeout_ms

		- Wait timeout in milliseconds.



.. rubric:: Returns:

Status code.



.. rubric:: See also:

:ref:`tapi_nptcp_wait_transmitter <doxid-group__tapi__nptcp_1ga076c9659b90a5f9339c0fc44db31da7c>`

.. index:: pair: function; tapi_nptcp_wait_transmitter
.. _doxid-group__tapi__nptcp_1ga076c9659b90a5f9339c0fc44db31da7c:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_nptcp_wait_transmitter(:ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`* app, int timeout_ms)

Wait for NPtcp transmitter completion.



.. rubric:: Parameters:

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

	*
		- app

		- NPtcp app handle.

	*
		- timeout_ms

		- Wait timeout in milliseconds.



.. rubric:: Returns:

Status code.



.. rubric:: See also:

:ref:`tapi_nptcp_wait_receiver <doxid-group__tapi__nptcp_1ga9384fe6e230451255959ddf88e7ae37f>`

.. index:: pair: function; tapi_nptcp_get_report
.. _doxid-group__tapi__nptcp_1ga6b5dfd4b00de78b8ede01c5869e61b84:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_nptcp_get_report(:ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`* app, :ref:`te_vec<doxid-structte__vec>`* report)

Get NPtcp report.



.. rubric:: Parameters:

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

	*
		- app

		- NPtcp app handle.

	*
		- report

		- NPtcp report handle. May be passed uninitialized, should be freed with :ref:`te_vec_free() <doxid-group__te__tools__te__vec_1ga6c853617db506f6e683ed846b10afa17>`.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_nptcp_kill_receiver
.. _doxid-group__tapi__nptcp_1ga17bbf2ca066a7bf3dcc95452addb97fb:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_nptcp_kill_receiver(:ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`* app, int signum)

Send a signal to NPtcp running on receiver's side.



.. rubric:: Parameters:

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

	*
		- app

		- NPtcp app handle.

	*
		- signum

		- Signal to send.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_nptcp_kill_transmitter
.. _doxid-group__tapi__nptcp_1ga12753205227f19850ae664da099004c0:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_nptcp_kill_transmitter(:ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`* app, int signum)

Send a signal to NPtcp running on transmitter's side.



.. rubric:: Parameters:

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

	*
		- app

		- NPtcp app handle.

	*
		- signum

		- Signal to send.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_nptcp_stop
.. _doxid-group__tapi__nptcp_1ga2b078eb979520835c71bfab0ded9bc12:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_nptcp_stop(:ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`* app)

Stop NPtcp. It can be started over with :ref:`tapi_nptcp_start() <doxid-group__tapi__nptcp_1ga3a115e54c2b96ae30b25064245e837fc>`.



.. rubric:: Parameters:

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

	*
		- app

		- NPtcp app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_nptcp_destroy
.. _doxid-group__tapi__nptcp_1ga32eadd03533cab63016697e3745b253b:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_nptcp_destroy(:ref:`tapi_nptcp_app<doxid-structtapi__nptcp__app>`* app)

Destroy NPtcp job running on receiver's side.



.. rubric:: Parameters:

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

	*
		- app

		- NPtcp app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_nptcp_report_mi_log
.. _doxid-group__tapi__nptcp_1gab3cb389ec38328d9b85787f1b8680a04:

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

	void tapi_nptcp_report_mi_log(:ref:`te_mi_logger<doxid-group__te__tools__te__mi__log_1gaec19168a124d0845de6936405b58a4f5>`* logger, :ref:`te_vec<doxid-structte__vec>`* report)

Add NPtcp report to MI logger.



.. rubric:: Parameters:

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

	*
		- logger

		- MI logger entity.

	*
		- report

		- NPtcp report.