:orphan:

.. index:: pair: group; Test API to use packetdrill test tool
.. _doxid-group__tapi__packetdrill:

Test API to use packetdrill test tool
=====================================

.. toctree::
	:hidden:

	enum_tapi_packetdrill_ip_version_t.rst
	struct_tapi_packetdrill_opts.rst

Overview
~~~~~~~~

Generic API to use packetdrill test tool. :ref:`More...<details-group__tapi__packetdrill>`


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

	
	// typedefs

	typedef struct :ref:`tapi_packetdrill_opts<doxid-structtapi__packetdrill__opts>` :ref:`tapi_packetdrill_opts<doxid-group__tapi__packetdrill_1ga4c03bb408f101df18af009a53349e3d1>`;
	typedef struct :ref:`tapi_packetdrill_app<doxid-group__tapi__packetdrill_1gac10b47ed85bab9226e6956c657081b40>` :ref:`tapi_packetdrill_app<doxid-group__tapi__packetdrill_1gac10b47ed85bab9226e6956c657081b40>`;

	// enums

	enum :ref:`tapi_packetdrill_ip_version_t<doxid-group__tapi__packetdrill_1gaf3a6747b8c0af2671cd7a470a6a32790>`;

	// structs

	struct :ref:`tapi_packetdrill_opts<doxid-structtapi__packetdrill__opts>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_packetdrill_app_init<doxid-group__tapi__packetdrill_1gac23b92430ee9d3bb8a93b058379f6af1>`(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, :ref:`tapi_packetdrill_opts<doxid-structtapi__packetdrill__opts>`* opts, :ref:`tapi_packetdrill_app<doxid-group__tapi__packetdrill_1gac10b47ed85bab9226e6956c657081b40>`** app);
	void :ref:`tapi_packetdrill_app_destroy<doxid-group__tapi__packetdrill_1ga49e464cf431f18c2d3f456364782e65b>`(:ref:`tapi_packetdrill_app<doxid-group__tapi__packetdrill_1gac10b47ed85bab9226e6956c657081b40>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_packetdrill_app_start<doxid-group__tapi__packetdrill_1gaee71a9be9f04254c150e408f5d7f88fb>`(:ref:`tapi_packetdrill_app<doxid-group__tapi__packetdrill_1gac10b47ed85bab9226e6956c657081b40>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_packetdrill_app_wait<doxid-group__tapi__packetdrill_1ga05bfd809f9b0b99f777a170ee4fb67ce>`(:ref:`tapi_packetdrill_app<doxid-group__tapi__packetdrill_1gac10b47ed85bab9226e6956c657081b40>`* app, int timeout_s);
	void :ref:`tapi_packetdrill_print_logs<doxid-group__tapi__packetdrill_1ga65781d6e29387a546fb957165889d532>`(:ref:`tapi_packetdrill_app<doxid-group__tapi__packetdrill_1gac10b47ed85bab9226e6956c657081b40>`* app);

	// macros

	#define :target:`IF_NAMESIZE<doxid-group__tapi__packetdrill_1gaedb93bcce9682d7644080b859849f59d>`

.. _details-group__tapi__packetdrill:

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

Generic API to use packetdrill test tool.

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

Typedefs
--------

.. index:: pair: typedef; tapi_packetdrill_opts
.. _doxid-group__tapi__packetdrill_1ga4c03bb408f101df18af009a53349e3d1:

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

	typedef struct :ref:`tapi_packetdrill_opts<doxid-structtapi__packetdrill__opts>` tapi_packetdrill_opts

Packetdrill test tool options

.. index:: pair: typedef; tapi_packetdrill_app
.. _doxid-group__tapi__packetdrill_1gac10b47ed85bab9226e6956c657081b40:

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

	typedef struct :ref:`tapi_packetdrill_app<doxid-group__tapi__packetdrill_1gac10b47ed85bab9226e6956c657081b40>` tapi_packetdrill_app

Packetdrill test tool context

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

.. index:: pair: function; tapi_packetdrill_app_init
.. _doxid-group__tapi__packetdrill_1gac23b92430ee9d3bb8a93b058379f6af1:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_packetdrill_app_init(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, :ref:`tapi_packetdrill_opts<doxid-structtapi__packetdrill__opts>`* opts, :ref:`tapi_packetdrill_app<doxid-group__tapi__packetdrill_1gac10b47ed85bab9226e6956c657081b40>`** app)

Initiate packetdrill app.



.. rubric:: Parameters:

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

	*
		- factory

		- Job factory.

	*
		- opts

		- Packetdrill options.

	*
		- app

		- The application handle.



.. rubric:: Returns:

Status code.



.. rubric:: See also:

:ref:`tapi_packetdrill_app_destroy <doxid-group__tapi__packetdrill_1ga49e464cf431f18c2d3f456364782e65b>`

.. index:: pair: function; tapi_packetdrill_app_destroy
.. _doxid-group__tapi__packetdrill_1ga49e464cf431f18c2d3f456364782e65b:

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

	void tapi_packetdrill_app_destroy(:ref:`tapi_packetdrill_app<doxid-group__tapi__packetdrill_1gac10b47ed85bab9226e6956c657081b40>`* app)

Destroy packetdrill app.



.. rubric:: Parameters:

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

	*
		- app

		- Packetdrill app context.



.. rubric:: See also:

:ref:`tapi_packetdrill_app_init <doxid-group__tapi__packetdrill_1gac23b92430ee9d3bb8a93b058379f6af1>`

.. index:: pair: function; tapi_packetdrill_app_start
.. _doxid-group__tapi__packetdrill_1gaee71a9be9f04254c150e408f5d7f88fb:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_packetdrill_app_start(:ref:`tapi_packetdrill_app<doxid-group__tapi__packetdrill_1gac10b47ed85bab9226e6956c657081b40>`* app)

Start packetdrill app



.. rubric:: Parameters:

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

	*
		- app

		- Packetdrill app context.



.. rubric:: Returns:

Status code.



.. rubric:: See also:

tapi_packetdrill_app_stop

.. index:: pair: function; tapi_packetdrill_app_wait
.. _doxid-group__tapi__packetdrill_1ga05bfd809f9b0b99f777a170ee4fb67ce:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_packetdrill_app_wait(:ref:`tapi_packetdrill_app<doxid-group__tapi__packetdrill_1gac10b47ed85bab9226e6956c657081b40>`* app, int timeout_s)

Wait while packetdrill client-specific app finishes its work. Note, function jumps to cleanup if timeout is expired.



.. rubric:: Parameters:

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

	*
		- app

		- Packetdrill app context.

	*
		- timeout_s

		- Time to wait for app results It MUST be big enough to finish client normally.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_packetdrill_print_logs
.. _doxid-group__tapi__packetdrill_1ga65781d6e29387a546fb957165889d532:

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

	void tapi_packetdrill_print_logs(:ref:`tapi_packetdrill_app<doxid-group__tapi__packetdrill_1gac10b47ed85bab9226e6956c657081b40>`* app)

Print logs. The function reads packetdrill app output (stdout, stderr).

This function makes sense only with client-specific app.



.. rubric:: Parameters:

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

	*
		- app

		- Packetdrill app context.