:orphan:

.. index:: pair: struct; lgr_rb
.. _doxid-structlgr__rb:

struct lgr_rb
=============

.. toctree::
	:hidden:

Overview
~~~~~~~~

The main ring buffer structure. :ref:`More...<details-structlgr__rb>`


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

	#include <logger_ta_internal.h>
	
	struct lgr_rb {
		// fields
	
		uint32_t :ref:`head<doxid-structlgr__rb_1a643b10f99b1797d07ec583d443171759>`;
		uint32_t :ref:`tail<doxid-structlgr__rb_1ad9f0b10e78ff8f9c12cd21d673d9d80d>`;
		uint32_t :ref:`unused<doxid-structlgr__rb_1aadefd2d5c14d3598830836d15387a676>`;
		uint8_t* :ref:`rb<doxid-structlgr__rb_1af2b2b041193a3d321a81d72336b036b1>`;
	};
.. _details-structlgr__rb:

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

The main ring buffer structure. Element of the ring buffer is multiple to the struct :ref:`lgr_mess_header <doxid-structlgr__mess__header>`

Fields
------

.. index:: pair: variable; head
.. _doxid-structlgr__rb_1a643b10f99b1797d07ec583d443171759:

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

	uint32_t head

Head ring buffer element number

.. index:: pair: variable; tail
.. _doxid-structlgr__rb_1ad9f0b10e78ff8f9c12cd21d673d9d80d:

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

	uint32_t tail

Tail ring buffer element number

.. index:: pair: variable; unused
.. _doxid-structlgr__rb_1aadefd2d5c14d3598830836d15387a676:

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

	uint32_t unused

Number of unused ring buffer elements

.. index:: pair: variable; rb
.. _doxid-structlgr__rb_1af2b2b041193a3d321a81d72336b036b1:

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

	uint8_t* rb

Pointer to the ring buffer location