:orphan:

.. index:: pair: struct; tapi_haproxy_cfg_opt
.. _doxid-structtapi__haproxy__cfg__opt:

struct tapi_haproxy_cfg_opt
===========================

.. toctree::
	:hidden:

Overview
~~~~~~~~

HAProxy config file options. :ref:`More...<details-structtapi__haproxy__cfg__opt>`


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

	#include <tapi_haproxy_cfg.h>
	
	struct tapi_haproxy_cfg_opt {
		// fields
	
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`nbthread<doxid-structtapi__haproxy__cfg__opt_1aed3b94a603ba0dda2abaab747991c699>`;
		bool :ref:`tune_listener_multi_queue<doxid-structtapi__haproxy__cfg__opt_1a4bcf448af3beb3054fce947626839301>`;
		bool :ref:`tune_idle_pool_shared<doxid-structtapi__haproxy__cfg__opt_1a4c66c869b36cb4602c9cd7f2a242c3f5>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`timeout_client_ms<doxid-structtapi__haproxy__cfg__opt_1a71cbb84a58b88b99ee75858f565a492b>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`timeout_server_ms<doxid-structtapi__haproxy__cfg__opt_1a32a116343b79331c27698b1cb2df6e55>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`timeout_connect_ms<doxid-structtapi__haproxy__cfg__opt_1af1090a5e99a87cbf32c2e9b3112df7ad>`;
		const char* :ref:`name<doxid-structtapi__haproxy__cfg__opt_1ac11bbf0d7d7abd1fd315dfc4465ecf5f>`;
		:ref:`tapi_haproxy_cfg_address<doxid-structtapi__haproxy__cfg__address>` :ref:`frontend_addr<doxid-structtapi__haproxy__cfg__opt_1aa83b9a3c3ab31a332682029d803848d7>`;
		:ref:`tapi_haproxy_cfg_shards<doxid-group__tapi__haproxy__cfg_1ga3056196290dd346cb16a82389fbf2ecc>` :ref:`shards<doxid-structtapi__haproxy__cfg__opt_1a9555a5ba39d19c9df243ee116a6eb851>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`shards_n<doxid-structtapi__haproxy__cfg__opt_1a48948a28a0003b697a4a164ee928bcf8>`;
		struct tapi_haproxy_cfg_opt::@83 :ref:`frontend<doxid-structtapi__haproxy__cfg__opt_1af077fe122729ba1f473d9cf879eb9bb3>`;
		size_t :ref:`n<doxid-structtapi__haproxy__cfg__opt_1a05d0ba33d2aafd248c531584a83b842d>`;
		:ref:`tapi_haproxy_cfg_backend<doxid-structtapi__haproxy__cfg__backend>`* :ref:`backends<doxid-structtapi__haproxy__cfg__opt_1a1006a03cbfeb9a73952e685d832a65f3>`;
		struct tapi_haproxy_cfg_opt::@84 :ref:`backend<doxid-structtapi__haproxy__cfg__opt_1a6d1dd519873c90f46ce8fec4164a424d>`;
	};
.. _details-structtapi__haproxy__cfg__opt:

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

HAProxy config file options.

Fields
------

.. index:: pair: variable; nbthread
.. _doxid-structtapi__haproxy__cfg__opt_1aed3b94a603ba0dda2abaab747991c699:

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

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` nbthread

Number of threads to run HAProxy on.

.. index:: pair: variable; tune_listener_multi_queue
.. _doxid-structtapi__haproxy__cfg__opt_1a4bcf448af3beb3054fce947626839301:

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

	bool tune_listener_multi_queue

If ``true``, HAProxy listener spreads the incoming traffic to all threads a frontend "bind" line is allowed to run on instead of taking them for itself.

.. index:: pair: variable; tune_idle_pool_shared
.. _doxid-structtapi__haproxy__cfg__opt_1a4c66c869b36cb4602c9cd7f2a242c3f5:

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

	bool tune_idle_pool_shared

If ``true``, idle connection pools are shared between threads for a same server.

.. index:: pair: variable; timeout_client_ms
.. _doxid-structtapi__haproxy__cfg__opt_1a71cbb84a58b88b99ee75858f565a492b:

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

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` timeout_client_ms

The maximum inactivity time on the client side (in milliseconds).

.. index:: pair: variable; timeout_server_ms
.. _doxid-structtapi__haproxy__cfg__opt_1a32a116343b79331c27698b1cb2df6e55:

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

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` timeout_server_ms

The maximum time for pending data staying into output buffer (in milliseconds).

.. index:: pair: variable; timeout_connect_ms
.. _doxid-structtapi__haproxy__cfg__opt_1af1090a5e99a87cbf32c2e9b3112df7ad:

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

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` timeout_connect_ms

The maximum time to wait for a connection attempt to a server to succeed (in milliseconds).

.. index:: pair: variable; name
.. _doxid-structtapi__haproxy__cfg__opt_1ac11bbf0d7d7abd1fd315dfc4465ecf5f:

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

	const char* name

Frontend group name in configuration file.

Backend group name in configuration file.

.. index:: pair: variable; frontend_addr
.. _doxid-structtapi__haproxy__cfg__opt_1aa83b9a3c3ab31a332682029d803848d7:

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

	:ref:`tapi_haproxy_cfg_address<doxid-structtapi__haproxy__cfg__address>` frontend_addr

Listener address representation.

.. index:: pair: variable; shards
.. _doxid-structtapi__haproxy__cfg__opt_1a9555a5ba39d19c9df243ee116a6eb851:

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

	:ref:`tapi_haproxy_cfg_shards<doxid-group__tapi__haproxy__cfg_1ga3056196290dd346cb16a82389fbf2ecc>` shards

In multi-threaded mode, source of number of listeners on the same address. If the value is not :ref:`TAPI_HAPROXY_CFG_SHARDS_NUMBER <doxid-group__tapi__haproxy__cfg_1gga3056196290dd346cb16a82389fbf2eccaa4171b0d9852b28869bb56fe18110166>`, :ref:`shards_n <doxid-structtapi__haproxy__cfg__opt_1a48948a28a0003b697a4a164ee928bcf8>` field should be set to :ref:`TAPI_JOB_OPT_UINT_UNDEF <doxid-group__tapi__job__opt_1ga8db07499d9d1da3556820e463320bdf2>`.

.. index:: pair: variable; shards_n
.. _doxid-structtapi__haproxy__cfg__opt_1a48948a28a0003b697a4a164ee928bcf8:

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

	:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` shards_n

In multi-threaded mode, number of listeners on the same address. The field is ommited if it's value is :ref:`TAPI_JOB_OPT_UINT_UNDEF <doxid-group__tapi__job__opt_1ga8db07499d9d1da3556820e463320bdf2>`.

.. index:: pair: variable; frontend
.. _doxid-structtapi__haproxy__cfg__opt_1af077fe122729ba1f473d9cf879eb9bb3:

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

	unnamed-struct frontend

Frontend listener bind configuration.

.. index:: pair: variable; n
.. _doxid-structtapi__haproxy__cfg__opt_1a05d0ba33d2aafd248c531584a83b842d:

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

	size_t n

Size of backend servers representations array.

.. index:: pair: variable; backends
.. _doxid-structtapi__haproxy__cfg__opt_1a1006a03cbfeb9a73952e685d832a65f3:

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

	:ref:`tapi_haproxy_cfg_backend<doxid-structtapi__haproxy__cfg__backend>`* backends

Pointer to backend servers representations array.

.. index:: pair: variable; backend
.. _doxid-structtapi__haproxy__cfg__opt_1a6d1dd519873c90f46ce8fec4164a424d:

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

	unnamed-struct backend

Array of backend servers representations.