:orphan:

.. index:: pair: struct; te_ring
.. _doxid-structte__ring:

struct te_ring
==============

.. toctree::
	:hidden:

Overview
~~~~~~~~

Ring buffer structure. :ref:`More...<details-structte__ring>`


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

	#include <te_ring.h>
	
	struct te_ring {
		// fields
	
		size_t :ref:`ring_size<doxid-structte__ring_1a5139d2338f8e499a87094fa58d2b6593>`;
		:ref:`te_vec<doxid-structte__vec>` :ref:`data<doxid-structte__ring_1a11f280de9e53ec50b14d4fa1104695b8>`;
		size_t :ref:`rptr<doxid-structte__ring_1a97a6b6f6af1bbb550ab2b10ed5b7579b>`;
		size_t :ref:`fill<doxid-structte__ring_1a427bf6fe611ca57846e06ae136763657>`;
	};
.. _details-structte__ring:

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

Ring buffer structure.

All the fields may be inspected but must never be directly modified by the user.

Fields
------

.. index:: pair: variable; ring_size
.. _doxid-structte__ring_1a5139d2338f8e499a87094fa58d2b6593:

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

	size_t ring_size

Ring size.

.. index:: pair: variable; data
.. _doxid-structte__ring_1a11f280de9e53ec50b14d4fa1104695b8:

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

	:ref:`te_vec<doxid-structte__vec>` data

Underlying data vector.

.. index:: pair: variable; rptr
.. _doxid-structte__ring_1a97a6b6f6af1bbb550ab2b10ed5b7579b:

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

	size_t rptr

Sequential read pointer.

.. index:: pair: variable; fill
.. _doxid-structte__ring_1a427bf6fe611ca57846e06ae136763657:

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

	size_t fill

Number of items in the ring.