:orphan:

.. index:: pair: group; unbound DNS server tool TAPI (tapi_dns_unbound)
.. _doxid-group__tapi__dns__unbound:

unbound DNS server tool TAPI (tapi_dns_unbound)
===============================================

.. toctree::
	:hidden:

	enum_tapi_dns_unbound_cfg_ac_action.rst
	enum_tapi_dns_unbound_verbose.rst
	struct_tapi_dns_unbound_app.rst
	struct_tapi_dns_unbound_cfg_ac.rst
	struct_tapi_dns_unbound_cfg_address.rst
	struct_tapi_dns_unbound_cfg_auth_zone.rst
	struct_tapi_dns_unbound_cfg_opt.rst
	struct_tapi_dns_unbound_opt.rst

Overview
~~~~~~~~

TAPI to handle unbound DNS server tool. :ref:`More...<details-group__tapi__dns__unbound>`


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

	
	// typedefs

	typedef enum :ref:`tapi_dns_unbound_verbose<doxid-group__tapi__dns__unbound_1ga5f817a628cbd5ff3f5d45aec32e001af>` :ref:`tapi_dns_unbound_verbose<doxid-group__tapi__dns__unbound_1ga86110dcd54df0903b46b321b254de525>`;
	typedef struct :ref:`tapi_dns_unbound_cfg_address<doxid-structtapi__dns__unbound__cfg__address>` :ref:`tapi_dns_unbound_cfg_address<doxid-group__tapi__dns__unbound_1gacd96c80fee24dc542d6c5cd8f75c2b33>`;
	typedef enum :ref:`tapi_dns_unbound_cfg_ac_action<doxid-group__tapi__dns__unbound_1gae10c484326458543b8daf1ec2afb4aae>` :ref:`tapi_dns_unbound_cfg_ac_action<doxid-group__tapi__dns__unbound_1ga74901beb5bf79b92ab2d302b05042d9e>`;
	typedef struct :ref:`tapi_dns_unbound_cfg_ac<doxid-structtapi__dns__unbound__cfg__ac>` :ref:`tapi_dns_unbound_cfg_ac<doxid-group__tapi__dns__unbound_1gafb46eda0d3db34c8d7090b9bd0b19c38>`;
	typedef struct :ref:`tapi_dns_unbound_cfg_auth_zone<doxid-structtapi__dns__unbound__cfg__auth__zone>` :ref:`tapi_dns_unbound_cfg_auth_zone<doxid-group__tapi__dns__unbound_1ga62b21e5da537287fc1ddf135475bece9>`;
	typedef struct :ref:`tapi_dns_unbound_cfg_opt<doxid-structtapi__dns__unbound__cfg__opt>` :ref:`tapi_dns_unbound_cfg_opt<doxid-group__tapi__dns__unbound_1ga8ddf713b061a15c429882eec4c07d178>`;
	typedef struct :ref:`tapi_dns_unbound_opt<doxid-structtapi__dns__unbound__opt>` :ref:`tapi_dns_unbound_opt<doxid-group__tapi__dns__unbound_1ga02c667e83f15faad979624aca05ef561>`;
	typedef struct :ref:`tapi_dns_unbound_app<doxid-structtapi__dns__unbound__app>` :ref:`tapi_dns_unbound_app<doxid-group__tapi__dns__unbound_1ga04efd7d7744f8503edf8f4307078fd97>`;

	// enums

	enum :ref:`tapi_dns_unbound_cfg_ac_action<doxid-group__tapi__dns__unbound_1gae10c484326458543b8daf1ec2afb4aae>`;
	enum :ref:`tapi_dns_unbound_verbose<doxid-group__tapi__dns__unbound_1ga5f817a628cbd5ff3f5d45aec32e001af>`;

	// structs

	struct :ref:`tapi_dns_unbound_app<doxid-structtapi__dns__unbound__app>`;
	struct :ref:`tapi_dns_unbound_cfg_ac<doxid-structtapi__dns__unbound__cfg__ac>`;
	struct :ref:`tapi_dns_unbound_cfg_address<doxid-structtapi__dns__unbound__cfg__address>`;
	struct :ref:`tapi_dns_unbound_cfg_auth_zone<doxid-structtapi__dns__unbound__cfg__auth__zone>`;
	struct :ref:`tapi_dns_unbound_cfg_opt<doxid-structtapi__dns__unbound__cfg__opt>`;
	struct :ref:`tapi_dns_unbound_opt<doxid-structtapi__dns__unbound__opt>`;

	// global variables

	const :ref:`tapi_dns_unbound_cfg_opt<doxid-structtapi__dns__unbound__cfg__opt>` :ref:`tapi_dns_unbound_cfg_default_opt<doxid-group__tapi__dns__unbound_1ga06ba8f41c177d69146249e57e06144e5>`;
	const :ref:`tapi_dns_unbound_opt<doxid-structtapi__dns__unbound__opt>` :ref:`tapi_dns_unbound_default_opt<doxid-group__tapi__dns__unbound_1ga57f4110d97d5cad108874ea513d860f8>`;

	// global functions

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_dns_unbound_create<doxid-group__tapi__dns__unbound_1ga284981e857c4b4ec1f5c00031c3f44ed>`(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_dns_unbound_opt<doxid-structtapi__dns__unbound__opt>`* opt, :ref:`tapi_dns_unbound_app<doxid-structtapi__dns__unbound__app>`** app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_dns_unbound_start<doxid-group__tapi__dns__unbound_1ga75780621dff0443a193cd36eb38a1a96>`(:ref:`tapi_dns_unbound_app<doxid-structtapi__dns__unbound__app>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_dns_unbound_wait<doxid-group__tapi__dns__unbound_1ga0bd94fcbf388b593c1935c43d483ac4f>`(:ref:`tapi_dns_unbound_app<doxid-structtapi__dns__unbound__app>`* app, int timeout_ms);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_dns_unbound_kill<doxid-group__tapi__dns__unbound_1ga4b52cb4bfbae43a0cae3c2dbc9e4a344>`(:ref:`tapi_dns_unbound_app<doxid-structtapi__dns__unbound__app>`* app, int signum);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_dns_unbound_stop<doxid-group__tapi__dns__unbound_1ga25e2e29629fdaa16ca813b2720de4e60>`(:ref:`tapi_dns_unbound_app<doxid-structtapi__dns__unbound__app>`* app);
	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` :ref:`tapi_dns_unbound_destroy<doxid-group__tapi__dns__unbound_1ga69c9ea65b0da157b8bab26349c5296fd>`(:ref:`tapi_dns_unbound_app<doxid-structtapi__dns__unbound__app>`* app);

.. _details-group__tapi__dns__unbound:

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

TAPI to handle unbound DNS server tool.

Typedefs
--------

.. index:: pair: typedef; tapi_dns_unbound_verbose
.. _doxid-group__tapi__dns__unbound_1ga86110dcd54df0903b46b321b254de525:

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

	typedef enum :ref:`tapi_dns_unbound_verbose<doxid-group__tapi__dns__unbound_1ga5f817a628cbd5ff3f5d45aec32e001af>` tapi_dns_unbound_verbose

Representation of possible values for unbound::verbose option.

.. index:: pair: typedef; tapi_dns_unbound_cfg_address
.. _doxid-group__tapi__dns__unbound_1gacd96c80fee24dc542d6c5cd8f75c2b33:

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

	typedef struct :ref:`tapi_dns_unbound_cfg_address<doxid-structtapi__dns__unbound__cfg__address>` tapi_dns_unbound_cfg_address

Representation of pair of address and port.

.. index:: pair: typedef; tapi_dns_unbound_cfg_ac_action
.. _doxid-group__tapi__dns__unbound_1ga74901beb5bf79b92ab2d302b05042d9e:

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

	typedef enum :ref:`tapi_dns_unbound_cfg_ac_action<doxid-group__tapi__dns__unbound_1gae10c484326458543b8daf1ec2afb4aae>` tapi_dns_unbound_cfg_ac_action

Representation of possible values of action for access_control option.

.. index:: pair: typedef; tapi_dns_unbound_cfg_ac
.. _doxid-group__tapi__dns__unbound_1gafb46eda0d3db34c8d7090b9bd0b19c38:

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

	typedef struct :ref:`tapi_dns_unbound_cfg_ac<doxid-structtapi__dns__unbound__cfg__ac>` tapi_dns_unbound_cfg_ac

Representation of unbound::access-control option.

.. index:: pair: typedef; tapi_dns_unbound_cfg_auth_zone
.. _doxid-group__tapi__dns__unbound_1ga62b21e5da537287fc1ddf135475bece9:

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

	typedef struct :ref:`tapi_dns_unbound_cfg_auth_zone<doxid-structtapi__dns__unbound__cfg__auth__zone>` tapi_dns_unbound_cfg_auth_zone

Representation of unbound::auth-zone option element.

.. index:: pair: typedef; tapi_dns_unbound_cfg_opt
.. _doxid-group__tapi__dns__unbound_1ga8ddf713b061a15c429882eec4c07d178:

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

	typedef struct :ref:`tapi_dns_unbound_cfg_opt<doxid-structtapi__dns__unbound__cfg__opt>` tapi_dns_unbound_cfg_opt

Unbound DNS server config file options.

``use-syslog`` option disabled by default.

.. index:: pair: typedef; tapi_dns_unbound_opt
.. _doxid-group__tapi__dns__unbound_1ga02c667e83f15faad979624aca05ef561:

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

	typedef struct :ref:`tapi_dns_unbound_opt<doxid-structtapi__dns__unbound__opt>` tapi_dns_unbound_opt

Unbound DNS server specific command line options.

.. index:: pair: typedef; tapi_dns_unbound_app
.. _doxid-group__tapi__dns__unbound_1ga04efd7d7744f8503edf8f4307078fd97:

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

	typedef struct :ref:`tapi_dns_unbound_app<doxid-structtapi__dns__unbound__app>` tapi_dns_unbound_app

Information of a unbound DNS server tool.

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

.. index:: pair: variable; tapi_dns_unbound_cfg_default_opt
.. _doxid-group__tapi__dns__unbound_1ga06ba8f41c177d69146249e57e06144e5:

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

	const :ref:`tapi_dns_unbound_cfg_opt<doxid-structtapi__dns__unbound__cfg__opt>` tapi_dns_unbound_cfg_default_opt

Default options initializer.

.. index:: pair: variable; tapi_dns_unbound_default_opt
.. _doxid-group__tapi__dns__unbound_1ga57f4110d97d5cad108874ea513d860f8:

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

	const :ref:`tapi_dns_unbound_opt<doxid-structtapi__dns__unbound__opt>` tapi_dns_unbound_default_opt

Default options initializer.

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

.. index:: pair: function; tapi_dns_unbound_create
.. _doxid-group__tapi__dns__unbound_1ga284981e857c4b4ec1f5c00031c3f44ed:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_dns_unbound_create(:ref:`tapi_job_factory_t<doxid-group__tapi__job_1ga3379bed0890a0ea0073e2a55f85895cd>`* factory, const :ref:`tapi_dns_unbound_opt<doxid-structtapi__dns__unbound__opt>`* opt, :ref:`tapi_dns_unbound_app<doxid-structtapi__dns__unbound__app>`** app)

Create unbound DNS server app.



.. rubric:: Parameters:

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

	*
		- factory

		- Job factory.

	*
		- opt

		- Unbound server tool options.

	*
		- app

		- Unbound server app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_dns_unbound_start
.. _doxid-group__tapi__dns__unbound_1ga75780621dff0443a193cd36eb38a1a96:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_dns_unbound_start(:ref:`tapi_dns_unbound_app<doxid-structtapi__dns__unbound__app>`* app)

Start unbound DNS server tool.



.. rubric:: Parameters:

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

	*
		- app

		- Unbound DNS server app handle.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_dns_unbound_wait
.. _doxid-group__tapi__dns__unbound_1ga0bd94fcbf388b593c1935c43d483ac4f:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_dns_unbound_wait(:ref:`tapi_dns_unbound_app<doxid-structtapi__dns__unbound__app>`* app, int timeout_ms)

Wait for unbound DNS server tool completion.



.. rubric:: Parameters:

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

	*
		- app

		- Unbound DNS server app handle.

	*
		- timeout_ms

		- Wait timeout in milliseconds.

	*
		- TE_EINPROGRESS

		- unbound DNS server is still running.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_dns_unbound_kill
.. _doxid-group__tapi__dns__unbound_1ga4b52cb4bfbae43a0cae3c2dbc9e4a344:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_dns_unbound_kill(:ref:`tapi_dns_unbound_app<doxid-structtapi__dns__unbound__app>`* app, int signum)

Send a signal to unbound DNS server tool.



.. rubric:: Parameters:

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

	*
		- app

		- Unbound DNS server app handle.

	*
		- signum

		- Signal to send.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_dns_unbound_stop
.. _doxid-group__tapi__dns__unbound_1ga25e2e29629fdaa16ca813b2720de4e60:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_dns_unbound_stop(:ref:`tapi_dns_unbound_app<doxid-structtapi__dns__unbound__app>`* app)

Stop unbound DNS server tool. It can be started over with :ref:`tapi_dns_unbound_start() <doxid-group__tapi__dns__unbound_1ga75780621dff0443a193cd36eb38a1a96>`.



.. rubric:: Parameters:

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

	*
		- app

		- Unbound DNS server app handle.

	*
		- TE_EPROTO

		- unbound DNS server tool is stopped, but report is unavailable.



.. rubric:: Returns:

Status code.

.. index:: pair: function; tapi_dns_unbound_destroy
.. _doxid-group__tapi__dns__unbound_1ga69c9ea65b0da157b8bab26349c5296fd:

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

	:ref:`te_errno<doxid-te__errno_8h_1ac9fc14f28b70f4785037c1df70ebc2a5>` tapi_dns_unbound_destroy(:ref:`tapi_dns_unbound_app<doxid-structtapi__dns__unbound__app>`* app)

Destroy unbound DNS server app. The app cannot be used after calling this function.



.. rubric:: Parameters:

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

	*
		- app

		- Unbound DNS server app handle.



.. rubric:: Returns:

Status code.