:orphan:

.. index:: pair: struct; tapi_ping_opt
.. _doxid-structtapi__ping__opt:

struct tapi_ping_opt
====================

.. toctree::
	:hidden:

Overview
~~~~~~~~

ping tool specific command line options :ref:`More...<details-structtapi__ping__opt>`


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

	#include <tapi_ping.h>
	
	struct tapi_ping_opt {
		// fields
	
		unsigned int :ref:`packet_count<doxid-structtapi__ping__opt_1a8428928f09e239fab8c75063b7e00106>`;
		unsigned int :ref:`packet_size<doxid-structtapi__ping__opt_1a3d1de9175497e08147fc8a55fda7cb52>`;
		:ref:`tapi_job_opt_double_t<doxid-group__tapi__job__opt_1gaee9f6ff157633a98216ac591fec50609>` :ref:`packet_wait<doxid-structtapi__ping__opt_1a63db0d99c5b4f545a76d0d0b4ef5556c>`;
		:ref:`tapi_job_opt_double_t<doxid-group__tapi__job__opt_1gaee9f6ff157633a98216ac591fec50609>` :ref:`interval<doxid-structtapi__ping__opt_1a31b1781d73042e76246761b4e35332b1>`;
		const char* :ref:`interface<doxid-structtapi__ping__opt_1a032b471a8310deaf907c543a863407f4>`;
		const char* :ref:`destination<doxid-structtapi__ping__opt_1a5fe9150ee681acfa1aa43ca499af01b0>`;
	};
.. _details-structtapi__ping__opt:

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

ping tool specific command line options

Fields
------

.. index:: pair: variable; packet_count
.. _doxid-structtapi__ping__opt_1a8428928f09e239fab8c75063b7e00106:

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

	unsigned int packet_count

Number of packets to send. If it is ``TAPI_JOB_OPT_OMIT_UINT``, the option is omitted and ping sends packets until explicitly stopped

.. index:: pair: variable; packet_size
.. _doxid-structtapi__ping__opt_1a3d1de9175497e08147fc8a55fda7cb52:

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

	unsigned int packet_size

Number of data bytes to send (default is 56). Note that the real size of the packet will be 8 bytes more because of an ICMP header.

.. index:: pair: variable; packet_wait
.. _doxid-structtapi__ping__opt_1a63db0d99c5b4f545a76d0d0b4ef5556c:

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

	:ref:`tapi_job_opt_double_t<doxid-group__tapi__job__opt_1gaee9f6ff157633a98216ac591fec50609>` packet_wait

Number of seconds to wait for response. Zero value means infinite timeout.

.. index:: pair: variable; interval
.. _doxid-structtapi__ping__opt_1a31b1781d73042e76246761b4e35332b1:

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

	:ref:`tapi_job_opt_double_t<doxid-group__tapi__job__opt_1gaee9f6ff157633a98216ac591fec50609>` interval

Number of seconds to wait between sending packets. By default ping waits for one second.

.. index:: pair: variable; interface
.. _doxid-structtapi__ping__opt_1a032b471a8310deaf907c543a863407f4:

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

	const char* interface

Address or interface name to send packets from

.. index:: pair: variable; destination
.. _doxid-structtapi__ping__opt_1a5fe9150ee681acfa1aa43ca499af01b0:

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

	const char* destination

Ping destination address