ring_buffer.h

Go to the documentation of this file.

#ifndef RING_BUFFER_H__
#define RING_BUFFER_H__

#include <stdint.h>
#include "global_defines.h"

typedef struct {
    uint8_t *head;  
    uint8_t *tail;  
    uint8_t *start; 
    uint8_t *end;   
    uint8_t buff_size;    
    uint8_t error;        
    uint8_t unread_items; 
} ring_buffer_t;


void     ring_buff_init(ring_buffer_t *rb_ptr, uint8_t *buffer_array_ptr, uint8_t buffer_len);
retval_t ring_buff_pop(ring_buffer_t *rb_ptr, uint8_t *return_item_ptr);
retval_t ring_buff_peak(ring_buffer_t *rb_ptr, uint8_t *return_item_ptr);
retval_t ring_buff_push(ring_buffer_t *rb_ptr, uint8_t new_val);
bool_t   ring_buff_has_data(ring_buffer_t *rb_ptr);
void     ring_buff_reset(ring_buffer_t *rb_ptr);
uint8_t  ring_buff_unread_items(ring_buffer_t *rb_ptr);

#endif /* RING_BUFFER_H__ */