:orphan:

.. index:: pair: struct; tapi_flow_traffic
.. _doxid-structtapi__flow__traffic:

struct tapi_flow_traffic
========================

.. toctree::
	:hidden:

Overview
~~~~~~~~

Flow Traffic entry structure Traffic entry contains all information to send and receive single pdu. :ref:`More...<details-structtapi__flow__traffic>`


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

	#include <tapi_flow.h>
	
	struct tapi_flow_traffic {
		// fields
	
		char* :ref:`name<doxid-structtapi__flow__traffic_1a4555bb902de8b7630fb62120382d3e75>`;
		:ref:`asn_value<doxid-structasn__value>`* :ref:`value<doxid-structtapi__flow__traffic_1aa851845ddadd0efcc649b553522818a4>`;
		:ref:`tapi_flow_ep<doxid-structtapi__flow__ep>`* :ref:`snd<doxid-structtapi__flow__traffic_1afcd56100d8c91d67cf04ebeaef46bd97>`;
		:ref:`tapi_flow_ep<doxid-structtapi__flow__ep>`* :ref:`rcv<doxid-structtapi__flow__traffic_1ab7aefcc6b409e2d188cc0e527152c648>`;
		:ref:`tapi_flow_ep<doxid-structtapi__flow__ep>`* :ref:`rcv_base<doxid-structtapi__flow__traffic_1ac1f17b001fee5242d055081c8d6271fd>`;
		:ref:`asn_value<doxid-structasn__value>`* :ref:`send_tmpl<doxid-structtapi__flow__traffic_1accb323750719da35db78e565200794df>`;
		:ref:`asn_value<doxid-structasn__value>`* :ref:`recv_ptrn<doxid-structtapi__flow__traffic_1ac5af3172df8c7ce0afcf1fad5b026920>`;
		:ref:`asn_value<doxid-structasn__value>`* :ref:`recv_base_ptrn<doxid-structtapi__flow__traffic_1a8b3abf3dbb79db3885bec54ee282a2fd>`;
		int :ref:`plen<doxid-structtapi__flow__traffic_1a38114b5935e97ad5a0ec09d995eed311>`;
		int :ref:`count<doxid-structtapi__flow__traffic_1a646a4045084eb1ce44176b8fc9181824>`;
		bool :ref:`started<doxid-structtapi__flow__traffic_1a1bd97134312864a0fbf046fd4153d3e9>`;
		int :ref:`total<doxid-structtapi__flow__traffic_1af48c0bd026274eabc1d3bd8d34be8628>`;
		int :ref:`marked<doxid-structtapi__flow__traffic_1a06f147e0a04b11ccd3e81dad1aba5c6a>`;

		// methods
	
		:ref:`SLIST_ENTRY<doxid-structtapi__flow__traffic_1acf4f04ac11d37cba168574ccaee773a0>`(tapi_flow_traffic);
	};
.. _details-structtapi__flow__traffic:

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

Flow Traffic entry structure Traffic entry contains all information to send and receive single pdu.

Fields
------

.. index:: pair: variable; name
.. _doxid-structtapi__flow__traffic_1a4555bb902de8b7630fb62120382d3e75:

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

	char* name

traffic entry name

.. index:: pair: variable; value
.. _doxid-structtapi__flow__traffic_1aa851845ddadd0efcc649b553522818a4:

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

	:ref:`asn_value<doxid-structasn__value>`* value

traffic asn notation

.. index:: pair: variable; snd
.. _doxid-structtapi__flow__traffic_1afcd56100d8c91d67cf04ebeaef46bd97:

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

	:ref:`tapi_flow_ep<doxid-structtapi__flow__ep>`* snd

endpoint to send pdu from

.. index:: pair: variable; rcv
.. _doxid-structtapi__flow__traffic_1ab7aefcc6b409e2d188cc0e527152c648:

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

	:ref:`tapi_flow_ep<doxid-structtapi__flow__ep>`* rcv

endpoint to receive pdu at

.. index:: pair: variable; rcv_base
.. _doxid-structtapi__flow__traffic_1ac1f17b001fee5242d055081c8d6271fd:

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

	:ref:`tapi_flow_ep<doxid-structtapi__flow__ep>`* rcv_base

second instance of receive endpoint to perform only base matching

.. index:: pair: variable; send_tmpl
.. _doxid-structtapi__flow__traffic_1accb323750719da35db78e565200794df:

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

	:ref:`asn_value<doxid-structasn__value>`* send_tmpl

send pdu template

.. index:: pair: variable; recv_ptrn
.. _doxid-structtapi__flow__traffic_1ac5af3172df8c7ce0afcf1fad5b026920:

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

	:ref:`asn_value<doxid-structasn__value>`* recv_ptrn

receive pdu pattern

.. index:: pair: variable; recv_base_ptrn
.. _doxid-structtapi__flow__traffic_1a8b3abf3dbb79db3885bec54ee282a2fd:

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

	:ref:`asn_value<doxid-structasn__value>`* recv_base_ptrn

basic receive pattern (only mac/ip addresses matching)

.. index:: pair: variable; plen
.. _doxid-structtapi__flow__traffic_1a38114b5935e97ad5a0ec09d995eed311:

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

	int plen

payload length

.. index:: pair: variable; count
.. _doxid-structtapi__flow__traffic_1a646a4045084eb1ce44176b8fc9181824:

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

	int count

amount of times the pdu should be sent

.. index:: pair: variable; started
.. _doxid-structtapi__flow__traffic_1a1bd97134312864a0fbf046fd4153d3e9:

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

	bool started

operating status of receive operation

.. index:: pair: variable; total
.. _doxid-structtapi__flow__traffic_1af48c0bd026274eabc1d3bd8d34be8628:

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

	int total

total count of received pdus matching base rules

.. index:: pair: variable; marked
.. _doxid-structtapi__flow__traffic_1a06f147e0a04b11ccd3e81dad1aba5c6a:

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

	int marked

amount of matched received pdus

Methods
-------

.. index:: pair: function; SLIST_ENTRY
.. _doxid-structtapi__flow__traffic_1acf4f04ac11d37cba168574ccaee773a0:

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

	SLIST_ENTRY(tapi_flow_traffic)

traffic linked list