:orphan:

.. index:: pair: struct; csap_instance
.. _doxid-structcsap__instance:

struct csap_instance
====================

.. toctree::
	:hidden:

Overview
~~~~~~~~

CSAP instance support resources and attributes. :ref:`More...<details-structcsap__instance>`


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

	#include <tad_csap_inst.h>
	
	struct csap_instance {
		// fields
	
		unsigned int :ref:`id<doxid-structcsap__instance_1acbc2df6dc439f5ef7369a5ed9a064f11>`;
		unsigned int :ref:`ref<doxid-structcsap__instance_1a57c12dd4db2876d6257c7bb3150b71d5>`;
		char* :ref:`csap_type<doxid-structcsap__instance_1a9cec0f3aea4cbcc046dfb6ece5281378>`;
		:ref:`asn_value<doxid-structasn__value>`* :ref:`nds<doxid-structcsap__instance_1a14f106f519c0d3577de53833bf7d6686>`;
		unsigned int :ref:`depth<doxid-structcsap__instance_1a49fa05d96dd4751e6e558f3c58f1a73f>`;
		:ref:`csap_layer_t<doxid-structcsap__layer__t>`* :ref:`layers<doxid-structcsap__instance_1adb365fb3b23a00ab7f072fb0f7402cb5>`;
		unsigned int :ref:`rw_layer<doxid-structcsap__instance_1a0bba4f8729041ed0803bd2f82afc0105>`;
		void* :ref:`rw_data<doxid-structcsap__instance_1aee586cd296a6703a0db41740c01c7792>`;
		unsigned int :ref:`stop_latency_timeout<doxid-structcsap__instance_1a1c5a733be80f881abdb359f9f0a94242>`;
		unsigned int :ref:`recv_timeout<doxid-structcsap__instance_1ac43fd9a140a78004ff1ff99d24d3d8c9>`;
		struct timeval :ref:`wait_for<doxid-structcsap__instance_1a619cc7e54919d2fcb6c7e49260a2d813>`;
		struct timeval :ref:`first_pkt<doxid-structcsap__instance_1a366969158cb27f3058c17d8d8e798138>`;
		struct timeval :ref:`last_pkt<doxid-structcsap__instance_1abce54924fa2b0819fbd5423eca0258ea>`;
		pthread_cond_t :ref:`event<doxid-structcsap__instance_1ade12409379f067d3163f39a70df1e0bd>`;
		unsigned int :ref:`state<doxid-structcsap__instance_1acc409fe3cc2f3a79a6606770f358d571>`;
		pthread_mutex_t :ref:`lock<doxid-structcsap__instance_1a0800ab355f9cc0cad803adb3e95d8a27>`;
		:ref:`tad_send_context<doxid-structtad__send__context>` :ref:`sender<doxid-structcsap__instance_1ac1f2459e61683c30a259122b00324154>`;
		:ref:`tad_recv_context<doxid-structtad__recv__context>` :ref:`receiver<doxid-structcsap__instance_1a2d15ca3fc9370941b76e45e151e51bff>`;
		unsigned int :ref:`poll_id<doxid-structcsap__instance_1a455598eec57680d552dba03a8db84952>`;

		// methods
	
		:ref:`TAILQ_HEAD<doxid-structcsap__instance_1ac9fcd28e7fba921e2204ecf3cb1f60ec>`(:ref:`tad_recv_op_context<doxid-structtad__recv__op__context>`);
		:ref:`LIST_HEAD<doxid-structcsap__instance_1ac1122e825c9749db6214e453f549fa91>`(:ref:`tad_poll_context<doxid-structtad__poll__context>`);
	};
.. _details-structcsap__instance:

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

CSAP instance support resources and attributes.

Fields
------

.. index:: pair: variable; id
.. _doxid-structcsap__instance_1acbc2df6dc439f5ef7369a5ed9a064f11:

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

	unsigned int id

CSAP ID

.. index:: pair: variable; ref
.. _doxid-structcsap__instance_1a57c12dd4db2876d6257c7bb3150b71d5:

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

	unsigned int ref

CSAP reference count (have to be >0)

.. index:: pair: variable; csap_type
.. _doxid-structcsap__instance_1a9cec0f3aea4cbcc046dfb6ece5281378:

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

	char* csap_type

Pointer to original CSAP type, proto[] entries are blocks of this string

.. index:: pair: variable; nds
.. _doxid-structcsap__instance_1a14f106f519c0d3577de53833bf7d6686:

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

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

ASN.1 value with CSAP specification

.. index:: pair: variable; depth
.. _doxid-structcsap__instance_1a49fa05d96dd4751e6e558f3c58f1a73f:

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

	unsigned int depth

Number of layers in stack

.. index:: pair: variable; layers
.. _doxid-structcsap__instance_1adb365fb3b23a00ab7f072fb0f7402cb5:

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

	:ref:`csap_layer_t<doxid-structcsap__layer__t>`* layers

Array of protocol layer descroptors

.. index:: pair: variable; rw_layer
.. _doxid-structcsap__instance_1a0bba4f8729041ed0803bd2f82afc0105:

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

	unsigned int rw_layer

Index of layer in protocol stack responsible for read and write operations, usually lower

.. index:: pair: variable; rw_data
.. _doxid-structcsap__instance_1aee586cd296a6703a0db41740c01c7792:

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

	void* rw_data

Private data of read/write layer

.. index:: pair: variable; stop_latency_timeout
.. _doxid-structcsap__instance_1a1c5a733be80f881abdb359f9f0a94242:

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

	unsigned int stop_latency_timeout

Maximum timeout for read operations in microseconds (it affects latency of stop/destroy operations)

.. index:: pair: variable; recv_timeout
.. _doxid-structcsap__instance_1ac43fd9a140a78004ff1ff99d24d3d8c9:

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

	unsigned int recv_timeout

Default receive timeout

.. index:: pair: variable; wait_for
.. _doxid-structcsap__instance_1a619cc7e54919d2fcb6c7e49260a2d813:

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

	struct timeval wait_for

Zero or moment of timeout current CSAP operation

.. index:: pair: variable; first_pkt
.. _doxid-structcsap__instance_1a366969158cb27f3058c17d8d8e798138:

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

	struct timeval first_pkt

Moment of first good packet processed: matched or sent

.. index:: pair: variable; last_pkt
.. _doxid-structcsap__instance_1abce54924fa2b0819fbd5423eca0258ea:

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

	struct timeval last_pkt

Moment of last good packet processed: matched or sent

.. index:: pair: variable; event
.. _doxid-structcsap__instance_1ade12409379f067d3163f39a70df1e0bd:

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

	pthread_cond_t event

Event condition

.. index:: pair: variable; state
.. _doxid-structcsap__instance_1acc409fe3cc2f3a79a6606770f358d571:

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

	unsigned int state

Current state bitmask

.. index:: pair: variable; lock
.. _doxid-structcsap__instance_1a0800ab355f9cc0cad803adb3e95d8a27:

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

	pthread_mutex_t lock

Mutex for lock CSAP data which are changed from different threads (event, state, queue of received packets)

.. index:: pair: variable; sender
.. _doxid-structcsap__instance_1ac1f2459e61683c30a259122b00324154:

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

	:ref:`tad_send_context<doxid-structtad__send__context>` sender

Sender context

.. index:: pair: variable; receiver
.. _doxid-structcsap__instance_1a2d15ca3fc9370941b76e45e151e51bff:

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

	:ref:`tad_recv_context<doxid-structtad__recv__context>` receiver

Receiver context

.. index:: pair: variable; poll_id
.. _doxid-structcsap__instance_1a455598eec57680d552dba03a8db84952:

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

	unsigned int poll_id

ID of the last poll request

Methods
-------

.. index:: pair: function; TAILQ_HEAD
.. _doxid-structcsap__instance_1ac9fcd28e7fba921e2204ecf3cb1f60ec:

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

	TAILQ_HEAD(:ref:`tad_recv_op_context<doxid-structtad__recv__op__context>`)

Receiver operations queue

.. index:: pair: function; LIST_HEAD
.. _doxid-structcsap__instance_1ac1122e825c9749db6214e453f549fa91:

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

	LIST_HEAD(:ref:`tad_poll_context<doxid-structtad__poll__context>`)

List of poll requests