Lucciefr/ringbuffer_8h_source.html

 #ifndef RINGBUFFER_H

 #define RINGBUFFER_H


 #include <stddef.h> // size_t


 typedef void free_func_t(void *ptr);


 typedef struct {

     void* *entries;

     size_t position;

     size_t count;

     size_t capacity;

     free_func_t *free;

 } ringbuffer_t;


 void ringbuffer_init(ringbuffer_t *rb, size_t capacity, free_func_t free_func);

 void ringbuffer_done(ringbuffer_t *rb);


 void ringbuffer_push(ringbuffer_t *rb, void *element);

 void ringbuffer_push_copy(ringbuffer_t *rb, void *buffer, size_t size);

 void ringbuffer_pop(ringbuffer_t *rb);

 void ringbuffer_clear(ringbuffer_t *rb);

 void ringbuffer_resize(ringbuffer_t *rb, size_t new_capacity);

 void *ringbuffer_element(ringbuffer_t *rb, size_t index);

 void *ringbuffer_tail(ringbuffer_t *rb);

 void *ringbuffer_head(ringbuffer_t *rb);


 #endif // RINGBUFFER_H

free_func_t
void free_func_t(void *ptr)
prototype for a "free" function (used as ringbuffer_t member)
Definition: ringbuffer.h:9

ringbuffer_resize
void ringbuffer_resize(ringbuffer_t *rb, size_t new_capacity)
resize the ring buffer (assign a new capacity).
Definition: ringbuffer.c:141

ringbuffer_t::capacity
size_t capacity
maximum number of elements, should correspond to *entries array size
Definition: ringbuffer.h:17

ringbuffer_head
void * ringbuffer_head(ringbuffer_t *rb)
shortcut to retrieve "head" element
Definition: ringbuffer.c:180

ringbuffer_element
void * ringbuffer_element(ringbuffer_t *rb, size_t index)
Retrieve the n-th entry (element pointer) from the ring buffer.
Definition: ringbuffer.c:163

ringbuffer_t::count
size_t count
the number of elements in the buffer (0 -> empty; == capacity -> full)
Definition: ringbuffer.h:16

ringbuffer_t
Ring buffer structure.
Definition: ringbuffer.h:13

ringbuffer_push_copy
void ringbuffer_push_copy(ringbuffer_t *rb, void *buffer, size_t size)
push a copy of a (temporary) memory buffer.
Definition: ringbuffer.c:112

ringbuffer_t::position
size_t position
the current start of the list (oldest entry, "tail" pointer)
Definition: ringbuffer.h:15

ringbuffer_init
void ringbuffer_init(ringbuffer_t *rb, size_t capacity, free_func_t free_func)
"constructor", prepare a ringbuffer_t before usage
Definition: ringbuffer.c:47

ringbuffer_pop
void ringbuffer_pop(ringbuffer_t *rb)
discard the oldest entry ("tail" element) from the buffer.
Definition: ringbuffer.c:121

ringbuffer_push
void ringbuffer_push(ringbuffer_t *rb, void *element)
push an element pointer to the ring buffer (new "head" entry)
Definition: ringbuffer.c:90

ringbuffer_done
void ringbuffer_done(ringbuffer_t *rb)
"destructor", free up a ringbuffer_t's resources after you're done
Definition: ringbuffer.c:60

ringbuffer_t::free
free_func_t * free
(optional) function to release memory on element removal
Definition: ringbuffer.h:18

ringbuffer_tail
void * ringbuffer_tail(ringbuffer_t *rb)
shortcut to retrieve "tail" element
Definition: ringbuffer.c:175

ringbuffer_clear
void ringbuffer_clear(ringbuffer_t *rb)
remove (pop) all entries from the buffer, until it's empty again (count == 0)
Definition: ringbuffer.c:130

ringbuffer_t::entries
void ** entries
dynamic memory for an array of element pointers
Definition: ringbuffer.h:14