:orphan:

.. index:: pair: struct; tad_pkt_seg
.. _doxid-structtad__pkt__seg:

struct tad_pkt_seg
==================

.. toctree::
	:hidden:

Overview
~~~~~~~~

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


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

	#include <tad_pkt.h>
	
	struct tad_pkt_seg {
		// fields
	
		void* :ref:`data_ptr<doxid-structtad__pkt__seg_1ae7b5903e2602b652527b25d58a627562>`;
		size_t :ref:`data_len<doxid-structtad__pkt__seg_1a963c10990a49f6cec5cdf9392554e323>`;
		:ref:`tad_pkt_seg_free<doxid-tad__pkt_8h_1adb5db05a8d87447efd6f6f29492df56c>` :ref:`data_free<doxid-structtad__pkt__seg_1a1f43df0ca844d04bda2eb3bdf8b7a3cf>`;
		:ref:`tad_pkt_ctrl_free<doxid-tad__pkt_8h_1a5785f916c62e01865f67ed8b33f2a9cc>` :ref:`my_free<doxid-structtad__pkt__seg_1a2deb2c35a36f4e9599cbdd04726a33d2>`;
		bool :ref:`layer_tag_set<doxid-structtad__pkt__seg_1aa59455d6743fffefa51039248240eb9d>`;
		:ref:`te_tad_protocols_t<doxid-tad__common_8h_1a8bf5168ff74533926526f12c6a8e9da0>` :ref:`layer_tag<doxid-structtad__pkt__seg_1a07a1e34995811ba08fd5aae457990464>`;

		// methods
	
		:ref:`CIRCLEQ_ENTRY<doxid-structtad__pkt__seg_1a716adc6f3749807fc707edb91eff47c6>`(tad_pkt_seg);
	};
.. _details-structtad__pkt__seg:

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

TAD packet segment control block.

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

Fields
------

.. index:: pair: variable; data_ptr
.. _doxid-structtad__pkt__seg_1ae7b5903e2602b652527b25d58a627562:

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

	void* data_ptr

Data pointer

.. index:: pair: variable; data_len
.. _doxid-structtad__pkt__seg_1a963c10990a49f6cec5cdf9392554e323:

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

	size_t data_len

Data length

.. index:: pair: variable; data_free
.. _doxid-structtad__pkt__seg_1a1f43df0ca844d04bda2eb3bdf8b7a3cf:

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

	:ref:`tad_pkt_seg_free<doxid-tad__pkt_8h_1adb5db05a8d87447efd6f6f29492df56c>` data_free

Data free function

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

.. 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; layer_tag_set
.. _doxid-structtad__pkt__seg_1aa59455d6743fffefa51039248240eb9d:

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

	bool layer_tag_set

Custom layer tag is set below

.. index:: pair: variable; layer_tag
.. _doxid-structtad__pkt__seg_1a07a1e34995811ba08fd5aae457990464:

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

	:ref:`te_tad_protocols_t<doxid-tad__common_8h_1a8bf5168ff74533926526f12c6a8e9da0>` layer_tag

TE protocol ID of the layer from which the segment originates

Methods
-------

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

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

	CIRCLEQ_ENTRY(tad_pkt_seg)

List links