:orphan:

.. index:: pair: struct; tapi_pat_sender
.. _doxid-structtapi__pat__sender:

struct tapi_pat_sender
======================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Pattern sender settings :ref:`More...<details-structtapi__pat__sender>`


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

	#include <tapi_rpc_misc.h>
	
	struct tapi_pat_sender {
		// fields
	
		const char* :ref:`gen_func<doxid-structtapi__pat__sender_1a4b0b486030777f6067243e171e7b33f0>`;
		:ref:`tarpc_pat_gen_arg<doxid-structtarpc__pat__gen__arg>` :ref:`gen_arg<doxid-structtapi__pat__sender_1aca6c5fb0da3e6a2d7b3aaa10c0d43c83>`;
		const char* :ref:`snd_wrapper<doxid-structtapi__pat__sender_1ada1d9710f8e0ee9442715e9c119e98b4>`;
		rpc_ptr :ref:`snd_wrapper_ctx<doxid-structtapi__pat__sender_1acf27b05740d16ca95f22c33d388ae04f>`;
		:ref:`iomux_func<doxid-tarpc__base_8x_8m4_1afb6907a7b6ca5218f661d433f76a9095>` :ref:`iomux<doxid-structtapi__pat__sender_1a2bf37295853f68da98845bbac2739c1e>`;
		:ref:`tapi_rand_gen<doxid-structtapi__rand__gen>` :ref:`size<doxid-structtapi__pat__sender_1a5735637aa51c3c75dde17a662059450e>`;
		:ref:`tapi_rand_gen<doxid-structtapi__rand__gen>` :ref:`delay<doxid-structtapi__pat__sender_1ac7ed55f555343c0d353167479dad57c8>`;
		int :ref:`duration_sec<doxid-structtapi__pat__sender_1a5fb93d9b2f00552d01a381685ab02c9b>`;
		unsigned int :ref:`time2wait<doxid-structtapi__pat__sender_1abeafb2eacb757ba0e0b4b28aa44deb51>`;
		uint64_t :ref:`total_size<doxid-structtapi__pat__sender_1a55eeed7bedde47ec806db30611794529>`;
		tarpc_bool :ref:`ignore_err<doxid-structtapi__pat__sender_1a8d119b4bf291bd9ec38d005893c820e9>`;
		const char* :ref:`pollerr_handler<doxid-structtapi__pat__sender_1a096557a5174c686fa63861c3221c3fe8>`;
		rpc_ptr :ref:`pollerr_handler_data<doxid-structtapi__pat__sender_1a9eca7457ed70fe6ee1a806acbdf2ef35>`;
		uint64_t :ref:`sent<doxid-structtapi__pat__sender_1a12ac307426189892ee594a1f808c736d>`;
		bool :ref:`send_failed<doxid-structtapi__pat__sender_1a3f73102622135d5d2481a979d4e67484>`;
		:ref:`tarpc_pat_gen_arg<doxid-structtarpc__pat__gen__arg>`* :ref:`gen_arg_ptr<doxid-structtapi__pat__sender_1a45ae0a4f915dc3388de8d5ec66f67fc9>`;
		uint64_t* :ref:`sent_ptr<doxid-structtapi__pat__sender_1aee526fdf3c765a92d589783c7e6f9d74>`;
		bool* :ref:`send_failed_ptr<doxid-structtapi__pat__sender_1a78637acdb04569846e1fdc7684672fbe>`;
	};
.. _details-structtapi__pat__sender:

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

Pattern sender settings

Fields
------

.. index:: pair: variable; gen_func
.. _doxid-structtapi__pat__sender_1a4b0b486030777f6067243e171e7b33f0:

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

	const char* gen_func

Pattern generator function name

.. index:: pair: variable; gen_arg
.. _doxid-structtapi__pat__sender_1aca6c5fb0da3e6a2d7b3aaa10c0d43c83:

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

	:ref:`tarpc_pat_gen_arg<doxid-structtarpc__pat__gen__arg>` gen_arg

Pattern generator arguments

.. index:: pair: variable; snd_wrapper
.. _doxid-structtapi__pat__sender_1ada1d9710f8e0ee9442715e9c119e98b4:

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

	const char* snd_wrapper

Name of send function wrapper

.. index:: pair: variable; snd_wrapper_ctx
.. _doxid-structtapi__pat__sender_1acf27b05740d16ca95f22c33d388ae04f:

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

	rpc_ptr snd_wrapper_ctx

RPC pointer to the first argument of send function wrapper

.. index:: pair: variable; iomux
.. _doxid-structtapi__pat__sender_1a2bf37295853f68da98845bbac2739c1e:

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

	:ref:`iomux_func<doxid-tarpc__base_8x_8m4_1afb6907a7b6ca5218f661d433f76a9095>` iomux

Iomux function to be used

.. index:: pair: variable; size
.. _doxid-structtapi__pat__sender_1a5735637aa51c3c75dde17a662059450e:

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

	:ref:`tapi_rand_gen<doxid-structtapi__rand__gen>` size

Size of the message

.. index:: pair: variable; delay
.. _doxid-structtapi__pat__sender_1ac7ed55f555343c0d353167479dad57c8:

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

	:ref:`tapi_rand_gen<doxid-structtapi__rand__gen>` delay

Delay between messages

.. index:: pair: variable; duration_sec
.. _doxid-structtapi__pat__sender_1a5fb93d9b2f00552d01a381685ab02c9b:

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

	int duration_sec

How long to run (in seconds; if **time2wait** is positive, the function can finish earlier)

.. index:: pair: variable; time2wait
.. _doxid-structtapi__pat__sender_1abeafb2eacb757ba0e0b4b28aa44deb51:

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

	unsigned int time2wait

Maximum time to wait for writability before stopping sending, in milliseconds (if ``0``, the function will wait until **duration_sec** expires)

.. index:: pair: variable; total_size
.. _doxid-structtapi__pat__sender_1a55eeed7bedde47ec806db30611794529:

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

	uint64_t total_size

How many bytes to send before stopping (ignored if ``0``). It may send less if ``duration_sec`` expired. Check ``sent`` on return if you need to be sure that all was sent.

.. index:: pair: variable; ignore_err
.. _doxid-structtapi__pat__sender_1a8d119b4bf291bd9ec38d005893c820e9:

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

	tarpc_bool ignore_err

Ignore errors while run

.. index:: pair: variable; pollerr_handler
.. _doxid-structtapi__pat__sender_1a096557a5174c686fa63861c3221c3fe8:

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

	const char* pollerr_handler

Handler to call if ``POLLERR`` event is got. If not set, receiving ``POLLERR`` instead of ``POLLOUT`` will result in error

.. index:: pair: variable; pollerr_handler_data
.. _doxid-structtapi__pat__sender_1a9eca7457ed70fe6ee1a806acbdf2ef35:

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

	rpc_ptr pollerr_handler_data

Data to pass to ``POLLERR`` handler as the first argument (as the second argument socket FD is passed)

.. index:: pair: variable; sent
.. _doxid-structtapi__pat__sender_1a12ac307426189892ee594a1f808c736d:

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

	uint64_t sent

Number of sent bytes

.. index:: pair: variable; send_failed
.. _doxid-structtapi__pat__sender_1a3f73102622135d5d2481a979d4e67484:

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

	bool send_failed

``true`` if **send()** call failed

.. index:: pair: variable; gen_arg_ptr
.. _doxid-structtapi__pat__sender_1a45ae0a4f915dc3388de8d5ec66f67fc9:

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

	:ref:`tarpc_pat_gen_arg<doxid-structtarpc__pat__gen__arg>`* gen_arg_ptr

Pointer to arguments of pattern generator

.. index:: pair: variable; sent_ptr
.. _doxid-structtapi__pat__sender_1aee526fdf3c765a92d589783c7e6f9d74:

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

	uint64_t* sent_ptr

Where to save number of sent bytes

.. index:: pair: variable; send_failed_ptr
.. _doxid-structtapi__pat__sender_1a78637acdb04569846e1fdc7684672fbe:

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

	bool* send_failed_ptr

Pointer to a variable which will be set to ``true`` if sending fails