:orphan:

.. index:: pair: struct; tad_pkt
.. _doxid-structtad__pkt:

struct tad_pkt
==============

.. toctree::
	:hidden:

Overview
~~~~~~~~

TAD packet control block. :ref:`More...<details-structtad__pkt>`


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

	#include <tad_pkt.h>
	
	struct tad_pkt {
		// fields
	
		tad_pkt_segs :ref:`segs<doxid-structtad__pkt_1a50c2dbaa4c60805e7f4d502d94aa3023>`;
		unsigned int :ref:`n_segs<doxid-structtad__pkt_1ae142a275c1641acfd3c71415bf04edfa>`;
		size_t :ref:`segs_len<doxid-structtad__pkt_1af6284d38163ec7267d097d372faebcf8>`;
		:ref:`tad_pkt_ctrl_free<doxid-tad__pkt_8h_1a5785f916c62e01865f67ed8b33f2a9cc>` :ref:`my_free<doxid-structtad__pkt_1a060f16042091d07a064adf6b18f6c10e>`;
		void* :ref:`opaque<doxid-structtad__pkt_1a5754100b00bf0e6c2a12b19c7bfd1596>`;
		:ref:`tad_pkt_ctrl_free<doxid-tad__pkt_8h_1a5785f916c62e01865f67ed8b33f2a9cc>` :ref:`opaque_free<doxid-structtad__pkt_1a1a49778efbea625552b29fe62064dd6f>`;

		// methods
	
		:ref:`CIRCLEQ_ENTRY<doxid-structtad__pkt_1af80615f066213cb3da742f88a1f530fc>`(tad_pkt);
	};
.. _details-structtad__pkt:

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

TAD packet control block.

Circular queue is used to have possibility to insert element in head and tail and to traverse packets in both directions.

Fields
------

.. index:: pair: variable; segs
.. _doxid-structtad__pkt_1a50c2dbaa4c60805e7f4d502d94aa3023:

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

	tad_pkt_segs segs

Packet segments

.. index:: pair: variable; n_segs
.. _doxid-structtad__pkt_1ae142a275c1641acfd3c71415bf04edfa:

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

	unsigned int n_segs

Number of segments in the packet

.. index:: pair: variable; segs_len
.. _doxid-structtad__pkt_1af6284d38163ec7267d097d372faebcf8:

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

	size_t segs_len

Total length of all segments in the packet

.. index:: pair: variable; my_free
.. _doxid-structtad__pkt_1a060f16042091d07a064adf6b18f6c10e:

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

	:ref:`tad_pkt_ctrl_free<doxid-tad__pkt_8h_1a5785f916c62e01865f67ed8b33f2a9cc>` my_free

Function to free this control block

.. index:: pair: variable; opaque
.. _doxid-structtad__pkt_1a5754100b00bf0e6c2a12b19c7bfd1596:

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

	void* opaque

Attached opaque data

.. index:: pair: variable; opaque_free
.. _doxid-structtad__pkt_1a1a49778efbea625552b29fe62064dd6f:

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

	:ref:`tad_pkt_ctrl_free<doxid-tad__pkt_8h_1a5785f916c62e01865f67ed8b33f2a9cc>` opaque_free

Function to free opaque data

Methods
-------

.. index:: pair: function; CIRCLEQ_ENTRY
.. _doxid-structtad__pkt_1af80615f066213cb3da742f88a1f530fc:

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

	CIRCLEQ_ENTRY(tad_pkt)

List links