:orphan:

.. index:: pair: group; HAProxy tool config file generation TAPI
.. _doxid-group__tapi__haproxy__cfg:

HAProxy tool config file generation TAPI
========================================

.. toctree::
	:hidden:

	enum_tapi_haproxy_cfg_shards.rst
	struct_tapi_haproxy_cfg_address.rst
	struct_tapi_haproxy_cfg_backend.rst
	struct_tapi_haproxy_cfg_opt.rst

Overview
~~~~~~~~

TAPI to handle HAProxy tool config file generation. :ref:`More...<details-group__tapi__haproxy__cfg>`


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

	
	// typedefs

	typedef struct :ref:`tapi_haproxy_cfg_address<doxid-structtapi__haproxy__cfg__address>` :ref:`tapi_haproxy_cfg_address<doxid-group__tapi__haproxy__cfg_1ga4bcf9fa4a22feeec29c6ab058a49a521>`;
	typedef enum :ref:`tapi_haproxy_cfg_shards<doxid-group__tapi__haproxy__cfg_1ga3056196290dd346cb16a82389fbf2ecc>` :ref:`tapi_haproxy_cfg_shards<doxid-group__tapi__haproxy__cfg_1ga9d4bdf72e145821d65a07ccb116c61ba>`;
	typedef struct :ref:`tapi_haproxy_cfg_backend<doxid-structtapi__haproxy__cfg__backend>` :ref:`tapi_haproxy_cfg_backend<doxid-group__tapi__haproxy__cfg_1gac57ae9895a8313c99686ddb2e857d098>`;
	typedef struct :ref:`tapi_haproxy_cfg_opt<doxid-structtapi__haproxy__cfg__opt>` :ref:`tapi_haproxy_cfg_opt<doxid-group__tapi__haproxy__cfg_1gaafa3c929b29c7676022fd2d7221c787d>`;

	// enums

	enum :ref:`tapi_haproxy_cfg_shards<doxid-group__tapi__haproxy__cfg_1ga3056196290dd346cb16a82389fbf2ecc>`;

	// structs

	struct :ref:`tapi_haproxy_cfg_address<doxid-structtapi__haproxy__cfg__address>`;
	struct :ref:`tapi_haproxy_cfg_backend<doxid-structtapi__haproxy__cfg__backend>`;
	struct :ref:`tapi_haproxy_cfg_opt<doxid-structtapi__haproxy__cfg__opt>`;

	// global variables

	const :ref:`tapi_haproxy_cfg_opt<doxid-structtapi__haproxy__cfg__opt>` :ref:`tapi_haproxy_cfg_default_opt<doxid-group__tapi__haproxy__cfg_1ga296469fc438700ff96f3380e3887fb34>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_haproxy_cfg_create<doxid-group__tapi__haproxy__cfg_1ga05370b5ed6fac8fe8b582d47935ff461>`(const char* ta, const :ref:`tapi_haproxy_cfg_opt<doxid-structtapi__haproxy__cfg__opt>`* opt, char** result_pathname);
	void :ref:`tapi_haproxy_cfg_destroy<doxid-group__tapi__haproxy__cfg_1gaf13ce3333987a1472666b1ddccea6974>`(const char* ta, const char* cfg_file);

	// macros

	#define :target:`TAPI_HAPROXY_CONF_DEFAULT_TIMEOUT_MS<doxid-group__tapi__haproxy__cfg_1ga297af71fe1d0cc13f9dae29594d87afc>`

.. _details-group__tapi__haproxy__cfg:

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

TAPI to handle HAProxy tool config file generation.

Typedefs
--------

.. index:: pair: typedef; tapi_haproxy_cfg_address
.. _doxid-group__tapi__haproxy__cfg_1ga4bcf9fa4a22feeec29c6ab058a49a521:

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

	typedef struct :ref:`tapi_haproxy_cfg_address<doxid-structtapi__haproxy__cfg__address>` tapi_haproxy_cfg_address

Representation of pair of address and port.

.. index:: pair: typedef; tapi_haproxy_cfg_shards
.. _doxid-group__tapi__haproxy__cfg_1ga9d4bdf72e145821d65a07ccb116c61ba:

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

	typedef enum :ref:`tapi_haproxy_cfg_shards<doxid-group__tapi__haproxy__cfg_1ga3056196290dd346cb16a82389fbf2ecc>` tapi_haproxy_cfg_shards

Representation of possible frontend listener shards option value sources.

.. index:: pair: typedef; tapi_haproxy_cfg_backend
.. _doxid-group__tapi__haproxy__cfg_1gac57ae9895a8313c99686ddb2e857d098:

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

	typedef struct :ref:`tapi_haproxy_cfg_backend<doxid-structtapi__haproxy__cfg__backend>` tapi_haproxy_cfg_backend

Backend server representation for HAProxy configuration.

.. index:: pair: typedef; tapi_haproxy_cfg_opt
.. _doxid-group__tapi__haproxy__cfg_1gaafa3c929b29c7676022fd2d7221c787d:

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

	typedef struct :ref:`tapi_haproxy_cfg_opt<doxid-structtapi__haproxy__cfg__opt>` tapi_haproxy_cfg_opt

HAProxy config file options.

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

.. index:: pair: variable; tapi_haproxy_cfg_default_opt
.. _doxid-group__tapi__haproxy__cfg_1ga296469fc438700ff96f3380e3887fb34:

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

	const :ref:`tapi_haproxy_cfg_opt<doxid-structtapi__haproxy__cfg__opt>` tapi_haproxy_cfg_default_opt

Default options initializer.

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

.. index:: pair: function; tapi_haproxy_cfg_create
.. _doxid-group__tapi__haproxy__cfg_1ga05370b5ed6fac8fe8b582d47935ff461:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_haproxy_cfg_create(const char* ta, const :ref:`tapi_haproxy_cfg_opt<doxid-structtapi__haproxy__cfg__opt>`* opt, char** result_pathname)

Generate config file for HAProxy app. Save it in /tmp subdir of Test Agent working dir.

``result_pathname`` must be free'd.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent name.

	*
		- opt

		- Configs for HAProxy tool.

	*
		- result_pathname

		- Resulting path to the file (must not be ``NULL``).



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_haproxy_cfg_destroy
.. _doxid-group__tapi__haproxy__cfg_1gaf13ce3333987a1472666b1ddccea6974:

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

	void tapi_haproxy_cfg_destroy(const char* ta, const char* cfg_file)

Destroy generated config file for HAProxy app.



.. rubric:: Parameters:

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

	*
		- ta

		- Test Agent name.

	*
		- cfg_file

		- Path to generated config file.