:orphan:

.. index:: pair: struct; tapi_dnsperf_opt
.. _doxid-structtapi__dnsperf__opt:

struct tapi_dnsperf_opt
=======================

.. toctree::
	:hidden:

Overview
~~~~~~~~

dnsperf specific options. :ref:`More...<details-structtapi__dnsperf__opt>`


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

	#include <tapi_dnsperf.h>
	
	struct tapi_dnsperf_opt {
		// fields
	
		const char* :ref:`local_addr<doxid-structtapi__dnsperf__opt_1a45ce207414d79b3cbfe34f6c2b3cc07e>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`bufsize<doxid-structtapi__dnsperf__opt_1aa5b7c5deb652f3593bf69d6e6b137239>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`clients<doxid-structtapi__dnsperf__opt_1aad2f51de85d2766eb5e33e1b0b9e7895>`;
		const char* :ref:`datafile<doxid-structtapi__dnsperf__opt_1a9485df89606b6df90954342cef1f57de>`;
		bool :ref:`enable_dnssec_ok<doxid-structtapi__dnsperf__opt_1afe9289e708e6ddac7e81765371903e65>`;
		bool :ref:`enable_edns0<doxid-structtapi__dnsperf__opt_1a6e8e8e648bd1a0e9142f854ea0e5b2d7>`;
		const char* :ref:`edns_opt<doxid-structtapi__dnsperf__opt_1a00a81567c6c5cfde3e24e8d57801d1ff>`;
		:ref:`tapi_dnsperf_addr_family<doxid-group__tapi__dnsperf_1gad6395d2ca1711115a9b1cdefb5bf9f65>` :ref:`addr_family<doxid-structtapi__dnsperf__opt_1a6ef835905c07fd96fe752f249e21c82a>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`limit<doxid-structtapi__dnsperf__opt_1a0c693e831906e2be9d748c3adda5e9ed>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`runs_through_file<doxid-structtapi__dnsperf__opt_1aa3f94632f1517774f27bbe36d93fa11d>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`port<doxid-structtapi__dnsperf__opt_1a9cc8e6f8c2dd38ddd33a0d93385af9a7>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`num_queries<doxid-structtapi__dnsperf__opt_1ac3db718cc1ba6d6f2755b708d421bb7d>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`max_qps<doxid-structtapi__dnsperf__opt_1ad3f5cd86716f65f144cb22dd32dec94e>`;
		:ref:`tapi_dnsperf_transport_mode<doxid-group__tapi__dnsperf_1ga563bb7ec3ac8827faee24b3849068742>` :ref:`transport_mode<doxid-structtapi__dnsperf__opt_1aa0c2916f85d2a56633cb3c405d58752b>`;
		const char* :ref:`server<doxid-structtapi__dnsperf__opt_1ad03fde7e791ff6a3efed7ef354f339bf>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`stats_interval<doxid-structtapi__dnsperf__opt_1ae89525bf14ba3e6dc11068098aa0fb64>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`timeout<doxid-structtapi__dnsperf__opt_1a4768b488f63043c610d43b1af31160be>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`threads<doxid-structtapi__dnsperf__opt_1a0bd26260ab58ffba33f50f8795ae2dea>`;
		bool :ref:`verbose<doxid-structtapi__dnsperf__opt_1a188af5e9e70aef839b91ed28f1c7fe06>`;
		bool :ref:`stdout_only<doxid-structtapi__dnsperf__opt_1a4b0aa60c638a3357d91445fbd7b07756>`;
		:ref:`tapi_job_opt_uint_t<doxid-group__tapi__job__opt_1ga6029f81fe926f3cb1d5a63c02b06d8b9>` :ref:`local_port<doxid-structtapi__dnsperf__opt_1a2d380c63fa8e56e3fd4ce4e776893927>`;
		const char* :ref:`ext_opt<doxid-structtapi__dnsperf__opt_1ab7b4644442a67a9d14822330737d0d26>`;
		:ref:`te_vec<doxid-structte__vec>` :ref:`queries<doxid-structtapi__dnsperf__opt_1adaafc8d1598bf1d2f23cdb03a278bd2c>`;
		const char* :ref:`dnsperf_path<doxid-structtapi__dnsperf__opt_1ab59677b0a24a7fe3e105383c9ee28889>`;
	};
.. _details-structtapi__dnsperf__opt:

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

dnsperf specific options.

Fields
------

.. index:: pair: variable; local_addr
.. _doxid-structtapi__dnsperf__opt_1a45ce207414d79b3cbfe34f6c2b3cc07e:

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

	const char* local_addr

the local address from which to send requests

.. index:: pair: variable; bufsize
.. _doxid-structtapi__dnsperf__opt_1aa5b7c5deb652f3593bf69d6e6b137239:

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

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

socket send/receive buffer size in kilobytes

.. index:: pair: variable; clients
.. _doxid-structtapi__dnsperf__opt_1aad2f51de85d2766eb5e33e1b0b9e7895:

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

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

the number of clients to act as

.. index:: pair: variable; datafile
.. _doxid-structtapi__dnsperf__opt_1a9485df89606b6df90954342cef1f57de:

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

	const char* datafile

the input data file (default: stdin)

.. index:: pair: variable; enable_dnssec_ok
.. _doxid-structtapi__dnsperf__opt_1afe9289e708e6ddac7e81765371903e65:

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

	bool enable_dnssec_ok

set the DNSSEC OK bit (implies EDNS)

.. index:: pair: variable; enable_edns0
.. _doxid-structtapi__dnsperf__opt_1a6e8e8e648bd1a0e9142f854ea0e5b2d7:

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

	bool enable_edns0

enable EDNS 0

.. index:: pair: variable; edns_opt
.. _doxid-structtapi__dnsperf__opt_1a00a81567c6c5cfde3e24e8d57801d1ff:

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

	const char* edns_opt

send EDNS option

.. index:: pair: variable; addr_family
.. _doxid-structtapi__dnsperf__opt_1a6ef835905c07fd96fe752f249e21c82a:

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

	:ref:`tapi_dnsperf_addr_family<doxid-group__tapi__dnsperf_1gad6395d2ca1711115a9b1cdefb5bf9f65>` addr_family

address family of DNS transport, inet, inet6 or any

.. index:: pair: variable; limit
.. _doxid-structtapi__dnsperf__opt_1a0c693e831906e2be9d748c3adda5e9ed:

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

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

run for at most this many seconds

.. index:: pair: variable; runs_through_file
.. _doxid-structtapi__dnsperf__opt_1aa3f94632f1517774f27bbe36d93fa11d:

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

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

run through input at most N times

.. index:: pair: variable; port
.. _doxid-structtapi__dnsperf__opt_1a9cc8e6f8c2dd38ddd33a0d93385af9a7:

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

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

the port on which to query the server

.. index:: pair: variable; num_queries
.. _doxid-structtapi__dnsperf__opt_1ac3db718cc1ba6d6f2755b708d421bb7d:

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

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

the maximum number of queries outstanding

.. index:: pair: variable; max_qps
.. _doxid-structtapi__dnsperf__opt_1ad3f5cd86716f65f144cb22dd32dec94e:

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

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

limit the number of queries per second

.. index:: pair: variable; transport_mode
.. _doxid-structtapi__dnsperf__opt_1aa0c2916f85d2a56633cb3c405d58752b:

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

	:ref:`tapi_dnsperf_transport_mode<doxid-group__tapi__dnsperf_1ga563bb7ec3ac8827faee24b3849068742>` transport_mode

set transport mode: udp, tcp, dot or doh

.. index:: pair: variable; server
.. _doxid-structtapi__dnsperf__opt_1ad03fde7e791ff6a3efed7ef354f339bf:

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

	const char* server

the server to query

.. index:: pair: variable; stats_interval
.. _doxid-structtapi__dnsperf__opt_1ae89525bf14ba3e6dc11068098aa0fb64:

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

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

print qps statistics every N seconds

.. index:: pair: variable; timeout
.. _doxid-structtapi__dnsperf__opt_1a4768b488f63043c610d43b1af31160be:

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

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

the timeout for query completion in seconds

.. index:: pair: variable; threads
.. _doxid-structtapi__dnsperf__opt_1a0bd26260ab58ffba33f50f8795ae2dea:

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

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

the number of threads to run

.. index:: pair: variable; verbose
.. _doxid-structtapi__dnsperf__opt_1a188af5e9e70aef839b91ed28f1c7fe06:

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

	bool verbose

verbose: report each query and additional information to stdout

.. index:: pair: variable; stdout_only
.. _doxid-structtapi__dnsperf__opt_1a4b0aa60c638a3357d91445fbd7b07756:

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

	bool stdout_only

log warnings and errors to stdout instead of stderr

.. index:: pair: variable; local_port
.. _doxid-structtapi__dnsperf__opt_1a2d380c63fa8e56e3fd4ce4e776893927:

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

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

the local port from which to send queries

.. index:: pair: variable; ext_opt
.. _doxid-structtapi__dnsperf__opt_1ab7b4644442a67a9d14822330737d0d26:

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

	const char* ext_opt

Suppress various messages and warnings

.. index:: pair: variable; queries
.. _doxid-structtapi__dnsperf__opt_1adaafc8d1598bf1d2f23cdb03a278bd2c:

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

	:ref:`te_vec<doxid-structte__vec>` queries

list of hosts to query (see :ref:`tapi_dnsperf_opt_query_add_a <doxid-group__tapi__dnsperf_1ga53d4aa17e5b4f46a6e04b2a3657e2065>`)

.. index:: pair: variable; dnsperf_path
.. _doxid-structtapi__dnsperf__opt_1ab59677b0a24a7fe3e105383c9ee28889:

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

	const char* dnsperf_path

Path to dnsperf exec (if ``NULL`` then "dnsperf").