circbuf.h

Go to the documentation of this file.

 
#ifndef __CIRC_BUF_H__
#define __CIRC_BUF_H__
 
#include <stdint.h>
 
#if defined(__GNUC__) || defined(__clang__)
#include <stddef.h>
#ifndef __cplusplus
#include <stdbool.h>
#endif
#endif
 
 
typedef struct _circ_buf_ {
    uint8_t* buffer;
    size_t head;
    size_t tail;
    size_t max;
    bool full;
}CircBuffer;
 
 
/*
* AuAdvancePointer -- advances the pointer
* of the buffer
* @param cbuf -- Pointer to the circular buffer
*/
extern void AuAdvancePointer(CircBuffer *cbuf);
 
/*
* AuRetreatPointer -- retreat the pointer of
* the buffer
* @param cbuf -- Pointer to the circular buffer
*/
extern void AuRetreatPointer(CircBuffer *cbuf);
 
/*
* AuCircBufReset -- reset the entire buffer
* @param cbuf -- Pointer to the circular buffer
*/
extern void AuCircBufReset(CircBuffer *cbuf);
 
/*
* AuCircBufInitialise -- initialise a new circular buffer
* @param buffer -- Pointer to the actual buffer pointer
* @param sz -- size of the buffer
*/
extern CircBuffer* AuCircBufInitialise(uint8_t* buffer, size_t sz);
 
/*
* AuCircBufFree -- free a circular buffer
* @param cbuf -- Pointer to the circular buffer
* to free
*/
extern void AuCircBufFree(CircBuffer *cbuf);
 
/*
* AuCircBufSize -- returns the circular
* buffer size
* @param cbuf -- Pointer to the circular
* buffer size
*/
extern size_t AuCircBufSize(CircBuffer *cbuf);
 
/*
* AuCircBufCapacity -- returns the circular
* buffer capacity
*/
extern size_t AuCircBufCapacity(CircBuffer *cbuf);
 
/*
* AuCircBufPutData -- puts a data to circular buffer
* @param cbuf-- Pointer to the circular buffer
* @param data -- data to put
*/
extern void AuCircBufPutData(CircBuffer* cbuf, uint8_t data);
 
/*
* AuCircBufPut -- puts data onto circular buffer
* @param cbuf -- Pointer to the circular buffer
* @param data -- data to put
*/
extern int AuCircBufPut(CircBuffer* cbuf, uint8_t data);
 
/*
* AuCircBufGet -- gets a data from circular
* buffer
* @param cbuf -- Pointer to the circular buffer
* @param data -- Pointer to the buffer
* where to put the data
*/
extern int AuCircBufGet(CircBuffer *cbuf, uint8_t *data);
 
/*
* CircBufEmpty -- checks if the circular
* buffer is empty
* @param cbuf -- Pointer to the circular
* buffer
*/
extern bool CircBufEmpty(CircBuffer *cbuf);
 
/*
* CircBufFull -- checks if the circular
* buffer is full
* @param cbuf -- Pointer to the circular
* buffer
*/
extern bool CircBufFull(CircBuffer *cbuf);
 
 
#endif