Data Structures | Typedefs | Functions
BCDS_RingBuffer.h File Reference
#include "BCDS_Utils.h"
#include "BCDS_Basics.h"
+ Include dependency graph for BCDS_RingBuffer.h:
+ This graph shows which files directly or indirectly include this file:

Data Structures

struct  RingBuffer_S
 Describes a circular buffer - this implementation expects a single consumer and a single producer. More...
 

Typedefs

typedef struct RingBuffer_S RingBuffer_T
 Describes a circular buffer - this implementation expects a single consumer and a single producer. More...
 

Functions

void RingBuffer_Initialize (RingBuffer_T *ringBuffer, uint8_t *bufferSpace, uint32_t size)
 Initializes a ring-buffer to empty state with a given buffer and buffer size. More...
 
uint32_t RingBuffer_Read (RingBuffer_T *ringBuffer, uint8_t *data, uint32_t length)
 Removes the specified number of bytes from the circular buffer and stores them in the user supplied buffer. More...
 
void RingBuffer_Reset (RingBuffer_T *ringBuffer)
 Resets the ring-buffer. All the saved / available data will be lost, if any at the time of trigger. More...
 
uint32_t RingBuffer_Write (RingBuffer_T *ringBuffer, uint8_t *data, uint32_t length)
 Copies specified number of bytes into the circular buffer. More...
 

This documentation file has been automatically generated on Fri Oct 4 2019 03:47:30 by doxygen 1.8.8