:orphan:

.. index:: pair: group; HAProxy tool TAPI
.. _doxid-group__tapi__haproxy:

HAProxy tool TAPI
=================

.. toctree::
	:hidden:

	struct_tapi_haproxy_app.rst
	struct_tapi_haproxy_opt.rst

Overview
~~~~~~~~

TAPI to manage HAProxy tool. :ref:`More...<details-group__tapi__haproxy>`


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

	
	// typedefs

	typedef struct :ref:`tapi_haproxy_opt<doxid-structtapi__haproxy__opt>` :ref:`tapi_haproxy_opt<doxid-group__tapi__haproxy_1gaf3a7fa572e1b5487bb3a1eef85ea40d7>`;
	typedef struct :ref:`tapi_haproxy_app<doxid-structtapi__haproxy__app>` :ref:`tapi_haproxy_app<doxid-group__tapi__haproxy_1ga24711597ccaafbc00aa7c316068f2ba8>`;

	// structs

	struct :ref:`tapi_haproxy_app<doxid-structtapi__haproxy__app>`;
	struct :ref:`tapi_haproxy_opt<doxid-structtapi__haproxy__opt>`;

	// global variables

	const :ref:`tapi_haproxy_opt<doxid-structtapi__haproxy__opt>` :ref:`tapi_haproxy_default_opt<doxid-group__tapi__haproxy_1ga8386614b78c81dce23d2c884648d057a>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_haproxy_create<doxid-group__tapi__haproxy_1ga29369c2dc0b2b688a9449f22865e606a>`(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_haproxy_opt<doxid-structtapi__haproxy__opt>`* opt, :ref:`tapi_haproxy_app<doxid-structtapi__haproxy__app>`** app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_haproxy_start<doxid-group__tapi__haproxy_1ga852a92283d1d3033110fb1e0fe60b204>`(:ref:`tapi_haproxy_app<doxid-structtapi__haproxy__app>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_haproxy_wait<doxid-group__tapi__haproxy_1gaf14288634ea57f2ff43ee95e2a3efb79>`(:ref:`tapi_haproxy_app<doxid-structtapi__haproxy__app>`* app, int timeout_ms);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_haproxy_kill<doxid-group__tapi__haproxy_1ga02359a93797fc4ff1ec9e781c42d5b51>`(:ref:`tapi_haproxy_app<doxid-structtapi__haproxy__app>`* app, int signo);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_haproxy_destroy<doxid-group__tapi__haproxy_1gaca2a3fe4ff62ee7ed0a1858a1c52f0d0>`(:ref:`tapi_haproxy_app<doxid-structtapi__haproxy__app>`* app);

	// macros

	#define :target:`TAPI_HAPROXY_CONF_FILENAME_SUFFIX<doxid-group__tapi__haproxy_1gaebea873589c350fa8bbc2fea1081902f>`
	#define :target:`TAPI_HAPROXY_PATH<doxid-group__tapi__haproxy_1ga438cb59179f3060d417dd28196ff5b4b>`
	#define :target:`TAPI_HAPROXY_TERM_TIMEOUT_MS<doxid-group__tapi__haproxy_1ga118bcad7e3c8cc5c7cd57c22913cbb97>`

.. _details-group__tapi__haproxy:

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

TAPI to manage HAProxy tool.

Typedefs
--------

.. index:: pair: typedef; tapi_haproxy_opt
.. _doxid-group__tapi__haproxy_1gaf3a7fa572e1b5487bb3a1eef85ea40d7:

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

	typedef struct :ref:`tapi_haproxy_opt<doxid-structtapi__haproxy__opt>` tapi_haproxy_opt

HAProxy specific command line options.

.. index:: pair: typedef; tapi_haproxy_app
.. _doxid-group__tapi__haproxy_1ga24711597ccaafbc00aa7c316068f2ba8:

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

	typedef struct :ref:`tapi_haproxy_app<doxid-structtapi__haproxy__app>` tapi_haproxy_app

HAProxy tool information.

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

.. index:: pair: variable; tapi_haproxy_default_opt
.. _doxid-group__tapi__haproxy_1ga8386614b78c81dce23d2c884648d057a:

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

	const :ref:`tapi_haproxy_opt<doxid-structtapi__haproxy__opt>` tapi_haproxy_default_opt

Default options initializer.

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

.. index:: pair: function; tapi_haproxy_create
.. _doxid-group__tapi__haproxy_1ga29369c2dc0b2b688a9449f22865e606a:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_haproxy_create(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_haproxy_opt<doxid-structtapi__haproxy__opt>`* opt, :ref:`tapi_haproxy_app<doxid-structtapi__haproxy__app>`** app)

Create HAProxy app.



.. rubric:: Parameters:

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

	*
		- factory

		- Job factory.

	*
		- opt

		- HAProxy tool options.

	*
		- app

		- HAProxy app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_haproxy_start
.. _doxid-group__tapi__haproxy_1ga852a92283d1d3033110fb1e0fe60b204:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_haproxy_start(:ref:`tapi_haproxy_app<doxid-structtapi__haproxy__app>`* app)

Start HAProxy tool.



.. rubric:: Parameters:

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

	*
		- app

		- HAProxy app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_haproxy_wait
.. _doxid-group__tapi__haproxy_1gaf14288634ea57f2ff43ee95e2a3efb79:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_haproxy_wait(:ref:`tapi_haproxy_app<doxid-structtapi__haproxy__app>`* app, int timeout_ms)

Wait for HAProxy tool completion.



.. rubric:: Parameters:

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

	*
		- app

		- HAProxy app handle.

	*
		- timeout_ms

		- Wait timeout in milliseconds.

	*
		- TE_EINPROGRESS

		- HAProxy is still running.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_haproxy_kill
.. _doxid-group__tapi__haproxy_1ga02359a93797fc4ff1ec9e781c42d5b51:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_haproxy_kill(:ref:`tapi_haproxy_app<doxid-structtapi__haproxy__app>`* app, int signo)

Send a signal to HAProxy tool.



.. rubric:: Parameters:

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

	*
		- app

		- HAProxy app handle.

	*
		- signum

		- Signal to send.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_haproxy_destroy
.. _doxid-group__tapi__haproxy_1gaca2a3fe4ff62ee7ed0a1858a1c52f0d0:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_haproxy_destroy(:ref:`tapi_haproxy_app<doxid-structtapi__haproxy__app>`* app)

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



.. rubric:: Parameters:

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

	*
		- app

		- HAProxy app handle.



.. rubric:: Returns:

Status code.