.. index:: pair: struct; net_drv_flow
.. _doxid-structnet__drv__flow:

struct net_drv_flow
===================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Structure describing data flow between a pair of sockets :ref:`More...<details-structnet__drv__flow>`


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

	#include <net_drv_data_flow.h>
	
	struct net_drv_flow {
		// fields
	
		rcf_rpc_server* :ref:`rpcs1<doxid-structnet__drv__flow_1a5442a7c38b19f5b4f2c849cb1f4d7971>`;
		rcf_rpc_server* :ref:`rpcs2<doxid-structnet__drv__flow_1aa406f92e79515ce63403a7bc2a722c7f>`;
		te_bool :ref:`tx<doxid-structnet__drv__flow_1a0e1aa4a820bce7220537b69a03bfe4f5>`;
		int :ref:`flow_id<doxid-structnet__drv__flow_1a9647f1be837153672868bee2bcc85505>`;
		te_bool :ref:`new_processes<doxid-structnet__drv__flow_1af209fa66a5b087525a17e36c361cc9bb>`;
		:ref:`net_drv_conn<doxid-structnet__drv__conn>`* :ref:`conn<doxid-structnet__drv__flow_1a229f3fbff652f64ad226970fc2634878>`;
		int :ref:`duration<doxid-structnet__drv__flow_1a778f22d1f70bb406cf2364f2438e30bc>`;
		te_bool :ref:`ignore_send_err<doxid-structnet__drv__flow_1a48318ed5fd4027c601ef6e148f91f8a4>`;
		int :ref:`min_size<doxid-structnet__drv__flow_1ac34ad5ac3a4d96e8aedd137cc5f5e052>`;
		int :ref:`max_size<doxid-structnet__drv__flow_1a81cd3c81a476c6bb9d1e272dac857b49>`;
		rcf_rpc_server* :ref:`sender_rpcs<doxid-structnet__drv__flow_1a9268c463ac275f4842e3656c67a3a610>`;
		rcf_rpc_server* :ref:`receiver_rpcs<doxid-structnet__drv__flow_1a2063ece248be06fdd222591463ec766e>`;
		int :ref:`sender_s<doxid-structnet__drv__flow_1a5a5e321edc296e11eceedd4064287abe>`;
		int :ref:`receiver_s<doxid-structnet__drv__flow_1a761023d2cb3ad4f3b1f8cfb31ad8fcd2>`;
		tapi_pat_sender :ref:`sender_ctx<doxid-structnet__drv__flow_1a0bef7b7f8478ff9a57ec384e9ded4653>`;
		te_bool :ref:`in_progress<doxid-structnet__drv__flow_1ae83402b2535a09e3a758b197bcae876d>`;
		te_bool :ref:`success<doxid-structnet__drv__flow_1a23ffaa1f42f2e776ccc251acce67ae61>`;
	};
.. _details-structnet__drv__flow:

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

Structure describing data flow between a pair of sockets

Fields
------

.. index:: pair: variable; rpcs1
.. _doxid-structnet__drv__flow_1a5442a7c38b19f5b4f2c849cb1f4d7971:

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

	rcf_rpc_server* rpcs1

RPC server for the first socket

.. index:: pair: variable; rpcs2
.. _doxid-structnet__drv__flow_1aa406f92e79515ce63403a7bc2a722c7f:

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

	rcf_rpc_server* rpcs2

RPC server for the second socket

.. index:: pair: variable; tx
.. _doxid-structnet__drv__flow_1a0e1aa4a820bce7220537b69a03bfe4f5:

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

	te_bool tx

If ``TRUE``, data is sent from the first socket to the second one, otherwise - in the opposite direction

.. index:: pair: variable; flow_id
.. _doxid-structnet__drv__flow_1a9647f1be837153672868bee2bcc85505:

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

	int flow_id

Unique data flow ID

.. index:: pair: variable; new_processes
.. _doxid-structnet__drv__flow_1af209fa66a5b087525a17e36c361cc9bb:

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

	te_bool new_processes

Whether to create new processes

.. index:: pair: variable; conn
.. _doxid-structnet__drv__flow_1a229f3fbff652f64ad226970fc2634878:

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

	:ref:`net_drv_conn<doxid-structnet__drv__conn>`* conn

Connected sockets to use

.. index:: pair: variable; duration
.. _doxid-structnet__drv__flow_1a778f22d1f70bb406cf2364f2438e30bc:

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

	int duration

How log to send, in seconds

.. index:: pair: variable; ignore_send_err
.. _doxid-structnet__drv__flow_1a48318ed5fd4027c601ef6e148f91f8a4:

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

	te_bool ignore_send_err

Whether to ignore send() errors

.. index:: pair: variable; min_size
.. _doxid-structnet__drv__flow_1ac34ad5ac3a4d96e8aedd137cc5f5e052:

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

	int min_size

Minimum data size passed to send()

.. index:: pair: variable; max_size
.. _doxid-structnet__drv__flow_1a81cd3c81a476c6bb9d1e272dac857b49:

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

	int max_size

Maximum data dise passed to send()

.. index:: pair: variable; sender_rpcs
.. _doxid-structnet__drv__flow_1a9268c463ac275f4842e3656c67a3a610:

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

	rcf_rpc_server* sender_rpcs

Sender RPC server

.. index:: pair: variable; receiver_rpcs
.. _doxid-structnet__drv__flow_1a2063ece248be06fdd222591463ec766e:

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

	rcf_rpc_server* receiver_rpcs

Receiver RPC server

.. index:: pair: variable; sender_s
.. _doxid-structnet__drv__flow_1a5a5e321edc296e11eceedd4064287abe:

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

	int sender_s

Sender socket

.. index:: pair: variable; receiver_s
.. _doxid-structnet__drv__flow_1a761023d2cb3ad4f3b1f8cfb31ad8fcd2:

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

	int receiver_s

Receiver socket

.. index:: pair: variable; sender_ctx
.. _doxid-structnet__drv__flow_1a0bef7b7f8478ff9a57ec384e9ded4653:

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

	tapi_pat_sender sender_ctx

Context for rpc_pattern_sender()

.. index:: pair: variable; in_progress
.. _doxid-structnet__drv__flow_1ae83402b2535a09e3a758b197bcae876d:

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

	te_bool in_progress

Set to ``TRUE`` while sending is in progress

.. index:: pair: variable; success
.. _doxid-structnet__drv__flow_1a23ffaa1f42f2e776ccc251acce67ae61:

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

	te_bool success

After :ref:`net_drv_flow_finish() <doxid-net__drv__data__flow_8h_1a748055e5623a5395a4cd80f968a8322f>` this field shows whether data sending/receiving was successful