:orphan:

.. index:: pair: struct; tapi_pat_receiver
.. _doxid-structtapi__pat__receiver:

struct tapi_pat_receiver
========================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Pattern receiver settings :ref:`More...<details-structtapi__pat__receiver>`


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

	#include <tapi_rpc_misc.h>
	
	struct tapi_pat_receiver {
		// fields
	
		const char* :ref:`gen_func<doxid-structtapi__pat__receiver_1a707246b5b59aadbfc7bb40d814fef730>`;
		:ref:`tarpc_pat_gen_arg<doxid-structtarpc__pat__gen__arg>` :ref:`gen_arg<doxid-structtapi__pat__receiver_1abd95b1922a408c7da7a75e7d16b39bb8>`;
		:ref:`iomux_func<doxid-tarpc__base_8x_8m4_1afb6907a7b6ca5218f661d433f76a9095>` :ref:`iomux<doxid-structtapi__pat__receiver_1afd8152a3dfb87628dba0157869320ec1>`;
		int :ref:`duration_sec<doxid-structtapi__pat__receiver_1a24454a28b4811efb7b01a2c79e5fdb4c>`;
		unsigned int :ref:`time2wait<doxid-structtapi__pat__receiver_1a8a3902c2189225d899fdafd514bfa054>`;
		tarpc_bool :ref:`ignore_pollerr<doxid-structtapi__pat__receiver_1afc1a543065424eeb0c83dc0484ee0936>`;
		uint64_t :ref:`exp_received<doxid-structtapi__pat__receiver_1a56996f540b284e7f7aa52e1e594f122b>`;
		uint64_t :ref:`received<doxid-structtapi__pat__receiver_1ab7dd5f8c5ca25dfc1e7f1ae9a42e92d1>`;
		bool :ref:`recv_failed<doxid-structtapi__pat__receiver_1a4ace1f4a3f8280f703935a24fe600ba1>`;
		:ref:`tarpc_pat_gen_arg<doxid-structtarpc__pat__gen__arg>`* :ref:`gen_arg_ptr<doxid-structtapi__pat__receiver_1a6f0f0a63c6845738d6e1df8bc129743f>`;
		uint64_t* :ref:`received_ptr<doxid-structtapi__pat__receiver_1aab445079f19b79ab6127f1bd51746bde>`;
		bool* :ref:`recv_failed_ptr<doxid-structtapi__pat__receiver_1aa77ebeefcf4653488f82a795bec4af9c>`;
	};
.. _details-structtapi__pat__receiver:

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

Pattern receiver settings

Fields
------

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

.. 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__receiver_1abd95b1922a408c7da7a75e7d16b39bb8:

.. 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; iomux
.. _doxid-structtapi__pat__receiver_1afd8152a3dfb87628dba0157869320ec1:

.. 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; duration_sec
.. _doxid-structtapi__pat__receiver_1a24454a28b4811efb7b01a2c79e5fdb4c:

.. 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__receiver_1a8a3902c2189225d899fdafd514bfa054:

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

	unsigned int time2wait

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

.. index:: pair: variable; ignore_pollerr
.. _doxid-structtapi__pat__receiver_1afc1a543065424eeb0c83dc0484ee0936:

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

	tarpc_bool ignore_pollerr

If ``true``, ignore ``POLLERR`` if it arrives instead of ``POLLIN``, and continue polling

.. index:: pair: variable; exp_received
.. _doxid-structtapi__pat__receiver_1a56996f540b284e7f7aa52e1e594f122b:

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

	uint64_t exp_received

Number of bytes expected to be received (ignored if ``0``; if > ``0``, stop after receiving this number of bytes)

.. index:: pair: variable; received
.. _doxid-structtapi__pat__receiver_1ab7dd5f8c5ca25dfc1e7f1ae9a42e92d1:

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

	uint64_t received

Number of received bytes

.. index:: pair: variable; recv_failed
.. _doxid-structtapi__pat__receiver_1a4ace1f4a3f8280f703935a24fe600ba1:

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

	bool recv_failed

``true`` if **recv()** call was failed

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

.. 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; received_ptr
.. _doxid-structtapi__pat__receiver_1aab445079f19b79ab6127f1bd51746bde:

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

	uint64_t* received_ptr

Where to save number of received bytes

.. index:: pair: variable; recv_failed_ptr
.. _doxid-structtapi__pat__receiver_1aa77ebeefcf4653488f82a795bec4af9c:

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

	bool* recv_failed_ptr

Pointer to a variable which will be set to ``true`` if **recv()** fails.