:orphan:

.. index:: pair: group; Bridge configuration
.. _doxid-group__tapi__conf__bridge:

Bridge configuration
====================

.. toctree::
	:hidden:

	enum_tapi_cfg_bridge_provider.rst
	struct_tapi_cfg_bridge.rst

Overview
~~~~~~~~

Definition of TAPI to configure bridge. :ref:`More...<details-group__tapi__conf__bridge>`


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

	
	// typedefs

	typedef enum :ref:`tapi_cfg_bridge_provider<doxid-group__tapi__conf__bridge_1ga8648152f12326be3ac28320fc7e221d2>` :ref:`tapi_cfg_bridge_provider<doxid-group__tapi__conf__bridge_1gab741e0aeed67ea7c4bcc27ba0c61bb9c>`;
	typedef struct :ref:`tapi_cfg_bridge<doxid-structtapi__cfg__bridge>` :ref:`tapi_cfg_bridge<doxid-group__tapi__conf__bridge_1ga9b4ede6eeb397d55cd0ea537f0fb269e>`;

	// enums

	enum :ref:`tapi_cfg_bridge_provider<doxid-group__tapi__conf__bridge_1ga8648152f12326be3ac28320fc7e221d2>`;

	// structs

	struct :ref:`tapi_cfg_bridge<doxid-structtapi__cfg__bridge>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_bridge_add<doxid-group__tapi__conf__bridge_1ga5720de1d424f95a8ddece48482bb9cad>`(const char* ta, const :ref:`tapi_cfg_bridge<doxid-structtapi__cfg__bridge>`* conf);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_bridge_del<doxid-group__tapi__conf__bridge_1gac1489dc33f3946b24bdfbe794f4096ee>`(const char* ta, const char* bridge_name);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_bridge_get<doxid-group__tapi__conf__bridge_1ga5ac0d1084b2bf0cc62e0a9e60f51467e>`(const char* ta, const char* bridge_name, :ref:`tapi_cfg_bridge<doxid-structtapi__cfg__bridge>`* conf);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_bridge_port_add<doxid-group__tapi__conf__bridge_1ga6354ed30c2def3b6b82197fccb08ca31>`(const char* ta, const char* bridge_name, const char* if_name);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_cfg_bridge_port_del<doxid-group__tapi__conf__bridge_1ga05a7f14da6728a7de90fba83df0c67b9>`(const char* ta, const char* bridge_name, const char* if_name);

.. _details-group__tapi__conf__bridge:

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

Definition of TAPI to configure bridge.

Typedefs
--------

.. index:: pair: typedef; tapi_cfg_bridge_provider
.. _doxid-group__tapi__conf__bridge_1gab741e0aeed67ea7c4bcc27ba0c61bb9c:

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

	typedef enum :ref:`tapi_cfg_bridge_provider<doxid-group__tapi__conf__bridge_1ga8648152f12326be3ac28320fc7e221d2>` tapi_cfg_bridge_provider

List of supported bridge providers

.. index:: pair: typedef; tapi_cfg_bridge
.. _doxid-group__tapi__conf__bridge_1ga9b4ede6eeb397d55cd0ea537f0fb269e:

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

	typedef struct :ref:`tapi_cfg_bridge<doxid-structtapi__cfg__bridge>` tapi_cfg_bridge

Bridge configuration

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

.. index:: pair: function; tapi_cfg_bridge_add
.. _doxid-group__tapi__conf__bridge_1ga5720de1d424f95a8ddece48482bb9cad:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_bridge_add(const char* ta, const :ref:`tapi_cfg_bridge<doxid-structtapi__cfg__bridge>`* conf)

Add bridge.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent.

	*
		- conf

		- Bridge configuration.



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_bridge_del
.. _doxid-group__tapi__conf__bridge_1gac1489dc33f3946b24bdfbe794f4096ee:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_bridge_del(const char* ta, const char* bridge_name)

Delete bridge.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent.

	*
		- bridge_name

		- Bridge name.



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_bridge_get
.. _doxid-group__tapi__conf__bridge_1ga5ac0d1084b2bf0cc62e0a9e60f51467e:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_bridge_get(const char* ta, const char* bridge_name, :ref:`tapi_cfg_bridge<doxid-structtapi__cfg__bridge>`* conf)

Get bridge configuration information.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent.

	*
		- bridge_name

		- Bridge name.

	*
		- conf

		- Pointer of bridge configuration to store.



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_bridge_port_add
.. _doxid-group__tapi__conf__bridge_1ga6354ed30c2def3b6b82197fccb08ca31:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_bridge_port_add(const char* ta, const char* bridge_name, const char* if_name)

Add interface in bridge ``bridge_name``.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent.

	*
		- bridge_name

		- Bridge name.

	*
		- if_name

		- New bridge interface.



.. rubric:: Returns:

Status code

.. index:: pair: function; tapi_cfg_bridge_port_del
.. _doxid-group__tapi__conf__bridge_1ga05a7f14da6728a7de90fba83df0c67b9:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_cfg_bridge_port_del(const char* ta, const char* bridge_name, const char* if_name)

Remove interface from bridge ``bridge_name``.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent.

	*
		- bridge_name

		- Bridge name.

	*
		- if_name

		- Bridge interface.



.. rubric:: Returns:

Status code