doxygen-docs/ringbuffer_8h_source.html

#ifndef RINGBUFFER_H

#define RINGBUFFER_H


#include <basics.h>


typedef struct {

    uint8_t* buffer;     // Pointer to raw memory buffer

    size_t capacity;     // Max number of elements

    size_t elem_size;    // Size of each element in bytes


    size_t head;         // Write position

    size_t tail;         // Read position

    size_t count;        // Number of elements stored

} ring_buffer_t;


void rb_init(ring_buffer_t* rb, void* buffer, size_t capacity, size_t elem_size);


int rb_full(const ring_buffer_t* rb);


int rb_empty(const ring_buffer_t* rb);


int rb_push(ring_buffer_t* rb, const void* data);


int rb_pop(ring_buffer_t* rb, void* out);


int rb_peek(const ring_buffer_t* rb, void* out);


void rb_clear(ring_buffer_t* rb);


size_t rb_size(const ring_buffer_t* rb);


size_t rb_free(const ring_buffer_t* rb);


#endif

basics.h
This is a basic header files with FrostWing specific short forms and basically a good for life header...

rb_peek
int rb_peek(const ring_buffer_t *rb, void *out)
Peek at the next element without removing it.

rb_empty
int rb_empty(const ring_buffer_t *rb)
Check if buffer is empty.

rb_free
size_t rb_free(const ring_buffer_t *rb)
Get remaining capacity.

rb_push
int rb_push(ring_buffer_t *rb, const void *data)
Push an element into the buffer.

rb_pop
int rb_pop(ring_buffer_t *rb, void *out)
Pop an element from the buffer.

rb_full
int rb_full(const ring_buffer_t *rb)
Check if buffer is full.

rb_size
size_t rb_size(const ring_buffer_t *rb)
Get number of elements currently stored.

rb_init
void rb_init(ring_buffer_t *rb, void *buffer, size_t capacity, size_t elem_size)
Initialize a ring buffer.

rb_clear
void rb_clear(ring_buffer_t *rb)
Clear the buffer.

ring_buffer_t
Structure representing a ring buffer.
Definition ringbuffer.h:20