:orphan:

.. index:: pair: struct; nginx_inst
.. _doxid-structnginx__inst:

struct nginx_inst
=================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Nginx daemon instance :ref:`More...<details-structnginx__inst>`


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

	#include <conf_nginx.h>
	
	struct nginx_inst {
		// fields
	
		char* :ref:`name<doxid-structnginx__inst_1a27b554c3f128d67cdcf18a52b672898a>`;
		bool :ref:`is_running<doxid-structnginx__inst_1a31c303e80a77f2329af826b967e91d18>`;
		char* :ref:`pid_path<doxid-structnginx__inst_1ad575c1d2bcdae53986c6e6c9db7e157b>`;
		char* :ref:`config_path<doxid-structnginx__inst_1a47f8fec8fb025eb51388b3573b2c51ff>`;
		char* :ref:`cmd_prefix<doxid-structnginx__inst_1a742339e524dd133c62e9f53e543dd4a7>`;
		bool :ref:`error_log_enable<doxid-structnginx__inst_1a2265685be741edb47f297664cb30ad33>`;
		char* :ref:`error_log_path<doxid-structnginx__inst_1a6ce6cd8801737f8b495aed4789300727>`;
		char* :ref:`evt_method<doxid-structnginx__inst_1a7cb999c6a798da5a6eef0fea6f44aa04>`;
		bool :ref:`multi_accept<doxid-structnginx__inst_1ae8d85126ae494c81e0a6d6e17736bc61>`;
		bool :ref:`accept_mutex<doxid-structnginx__inst_1aee27e60fa82396a178ece690c3b666c8>`;
		unsigned int :ref:`wrk_ps_num<doxid-structnginx__inst_1a3b4acb6fa0c57e793dd8a3f902245403>`;
		unsigned int :ref:`wrk_conn_num<doxid-structnginx__inst_1a90971dc35ba719dc91f90ecf6e4b8baa>`;
		unsigned int :ref:`rlimit_nofile<doxid-structnginx__inst_1ae33bf7e147638f57b0b35fca10008aae>`;
		char* :ref:`aff_mask<doxid-structnginx__inst_1a592e78768a970f064db573e4c4d7ed05>`;
		:ref:`nginx_cpu_aff_mode<doxid-conf__nginx_8h_1a7eccc3dd335b715552f34fe98486689d>` :ref:`aff_mode<doxid-structnginx__inst_1add8b852b36510c225e4d2ff181f52094>`;
		bool :ref:`to_be_deleted<doxid-structnginx__inst_1a022475c58ddfdce760e810bdce8faee0>`;
		bool :ref:`is_created<doxid-structnginx__inst_1a105d1374a7b0f6357ccc6dfa39f78841>`;
		unsigned int :ref:`id<doxid-structnginx__inst_1a88896737623e2334155671027c4eb9bc>`;

		// methods
	
		:ref:`LIST_ENTRY<doxid-structnginx__inst_1a720426016bfa87f0290ff49aebe4e122>`(nginx_inst);
		:ref:`LIST_HEAD<doxid-structnginx__inst_1aff0cb680fcef38ec52332f7e5ea770d6>`(:ref:`nginx_http_server<doxid-structnginx__http__server>`);
		:ref:`LIST_HEAD<doxid-structnginx__inst_1a9ade1987b45e511d658af4256154fe58>`(:ref:`nginx_http_upstream<doxid-structnginx__http__upstream>`);
		:ref:`LIST_HEAD<doxid-structnginx__inst_1a5ec75a363b302a5d40fcf5cbdeeae7a7>`(:ref:`nginx_ssl_entry<doxid-structnginx__ssl__entry>`);
	};
.. _details-structnginx__inst:

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

Nginx daemon instance

Fields
------

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

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

	char* name

Friendly name of nginx instance

.. index:: pair: variable; is_running
.. _doxid-structnginx__inst_1a31c303e80a77f2329af826b967e91d18:

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

	bool is_running

Is daemon running

.. index:: pair: variable; pid_path
.. _doxid-structnginx__inst_1ad575c1d2bcdae53986c6e6c9db7e157b:

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

	char* pid_path

Path to PID file on TA

.. index:: pair: variable; config_path
.. _doxid-structnginx__inst_1a47f8fec8fb025eb51388b3573b2c51ff:

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

	char* config_path

Path to configuration file on TA

.. index:: pair: variable; cmd_prefix
.. _doxid-structnginx__inst_1a742339e524dd133c62e9f53e543dd4a7:

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

	char* cmd_prefix

Prefix to nginx command line

.. index:: pair: variable; error_log_enable
.. _doxid-structnginx__inst_1a2265685be741edb47f297664cb30ad33:

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

	bool error_log_enable

Enable error logging

.. index:: pair: variable; error_log_path
.. _doxid-structnginx__inst_1a6ce6cd8801737f8b495aed4789300727:

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

	char* error_log_path

Path to error log file on TA

.. index:: pair: variable; evt_method
.. _doxid-structnginx__inst_1a7cb999c6a798da5a6eef0fea6f44aa04:

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

	char* evt_method

Method of connections processing, e.g. epoll

.. index:: pair: variable; multi_accept
.. _doxid-structnginx__inst_1ae8d85126ae494c81e0a6d6e17736bc61:

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

	bool multi_accept

Whether one worker can accept multiple connections at a time

.. index:: pair: variable; accept_mutex
.. _doxid-structnginx__inst_1aee27e60fa82396a178ece690c3b666c8:

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

	bool accept_mutex

Whether worker processes will accept new connections by turn

.. index:: pair: variable; wrk_ps_num
.. _doxid-structnginx__inst_1a3b4acb6fa0c57e793dd8a3f902245403:

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

	unsigned int wrk_ps_num

Number of worker processes

.. index:: pair: variable; wrk_conn_num
.. _doxid-structnginx__inst_1a90971dc35ba719dc91f90ecf6e4b8baa:

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

	unsigned int wrk_conn_num

Number of worker connections

.. index:: pair: variable; rlimit_nofile
.. _doxid-structnginx__inst_1ae33bf7e147638f57b0b35fca10008aae:

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

	unsigned int rlimit_nofile

Maximum number of open files for worker processes

.. index:: pair: variable; aff_mask
.. _doxid-structnginx__inst_1a592e78768a970f064db573e4c4d7ed05:

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

	char* aff_mask

Worker processes CPU affinity mask

.. index:: pair: variable; aff_mode
.. _doxid-structnginx__inst_1add8b852b36510c225e4d2ff181f52094:

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

	:ref:`nginx_cpu_aff_mode<doxid-conf__nginx_8h_1a7eccc3dd335b715552f34fe98486689d>` aff_mode

Worker processes CPU affinity mode

.. index:: pair: variable; to_be_deleted
.. _doxid-structnginx__inst_1a022475c58ddfdce760e810bdce8faee0:

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

	bool to_be_deleted

Flag to delete instance on commit

.. index:: pair: variable; is_created
.. _doxid-structnginx__inst_1a105d1374a7b0f6357ccc6dfa39f78841:

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

	bool is_created

Flag to track if instance was created

.. index:: pair: variable; id
.. _doxid-structnginx__inst_1a88896737623e2334155671027c4eb9bc:

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

	unsigned int id

ID of the created job

Methods
-------

.. index:: pair: function; LIST_ENTRY
.. _doxid-structnginx__inst_1a720426016bfa87f0290ff49aebe4e122:

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

	LIST_ENTRY(nginx_inst)

Linked list of nginx instances

.. index:: pair: function; LIST_HEAD
.. _doxid-structnginx__inst_1aff0cb680fcef38ec52332f7e5ea770d6:

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

	LIST_HEAD(:ref:`nginx_http_server<doxid-structnginx__http__server>`)

HTTP servers

.. index:: pair: function; LIST_HEAD
.. _doxid-structnginx__inst_1a9ade1987b45e511d658af4256154fe58:

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

	LIST_HEAD(:ref:`nginx_http_upstream<doxid-structnginx__http__upstream>`)

HTTP upstream servers groups

.. index:: pair: function; LIST_HEAD
.. _doxid-structnginx__inst_1a5ec75a363b302a5d40fcf5cbdeeae7a7:

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

	LIST_HEAD(:ref:`nginx_ssl_entry<doxid-structnginx__ssl__entry>`)

SSL settings