RingBuf-c

A ring buffer (FIFO) for C and C++ languages.

Attention!

• RingBuf_OA_* removed in version 2.0
• RingBuf renamed to RingBuf_t since v1.6

(see version changelog and documentation for detailed information)

About

Ring buffer is a data structure that uses a single, fixed-size buffer as if it were connected end-to-end. (Wikipedia)

Demonstration of a ring buffer:

(Wikipedia)

Features

• Can store char or any 8-bit type
• Can be used with C and C++ languages
• No external dependencies
• Easy to use
• Custom buffer size
• Supports data peek
• Multiple buffers can be created
• Can be deinitialized to free memory
• Optimized for microcontrollers
• Open source MIT license

Documentation

English [English]

Usage

To add this library to your project, just include the src/RingBuf.h file and add src/RingBuf.c to sources.

First, create and initialize the buffer.

RingBuf_t ring_buffer = {0};  // Create the buffer and initialize it with zero
RingBuf_Init(&ring_buffer, 128);  // Initialize the buffer; RingBuf_Init(pointer to buffer, buffer size)

Use RingBuf_Queue() and RingBuf_QueueArr() to add data to the buffer.

RingBuf_Queue(&ring_buffer, 'a');  // Add 'a' to the buffer; RingBuf_Queue(pointer to buffer, data)
char a[] = "hello";
RingBuf_QueueArr(&ring_buffer, a, 5);  // Add "hello" to the buffer; RingBuf_QueueArr(pointer to buffer, pointer to data array, data size)

Use RingBuf_Dequeue() and RingBuf_DequeueArr() to take data from the buffer.

char b;
RingBuf_Dequeue(&ring_buffer, &b);  // Take one element from the buffer and save to b; RingBuf_Dequeue(pointer to buffer, pointer to variable to save)
printf("%c", b);  // Will print "a"
char c[6];
memset(c, 0, 6);  // Fill c with zeros
RingBuf_DequeueArr(&ring_buffer, c, 5);  // Take 5 elements from the buffer and save to c; RingBuf_DequeueArr(pointer to buffer, pointer to array to save, data size)
printf("%s", c);  // Will print "hello"

Watch detailed info about library functions in the documentation.

Important! Don't modify or read any element of the buffer structure manually! It can break the buffer! size_t n = ring_buffer.elements_count; size_t n = RingBuf_GetElementsCount(&ring_buffer);