aboutsummaryrefslogtreecommitdiffstats
path: root/source/libmaple/api/ring_buffer.rst
blob: e9b6637e0cc98a2fc43b12ad87185bec38e0ec00 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
.. highlight:: c
.. _libmaple-ring_buffer:

``ring_buffer.h``
=================

Simple circular byte buffer.  This implementation is not thread-safe.
In particular, none of these functions is guaranteed to be re-entrant.

Ring Buffer Type
----------------

.. doxygenstruct:: ring_buffer

Ring Buffer Operations
----------------------

.. doxygenfunction:: rb_init
.. doxygenfunction:: rb_full_count
.. doxygenfunction:: rb_is_full
.. doxygenfunction:: rb_is_empty
.. doxygenfunction:: rb_insert
.. doxygenfunction:: rb_remove
.. doxygenfunction:: rb_safe_remove
.. doxygenfunction:: rb_safe_insert
.. doxygenfunction:: rb_push_insert
.. doxygenfunction:: rb_reset