buffer_t Struct Reference

#include <buffer.h>

Data Fields
uint16_t	size
uint16_t	max_size
char *	front
char *	rear
char *	buffer_start
char *	buffer_end
void(*	Callback )(void *buf)

Detailed Description

data structure to hold the required information for each buffer

Field Documentation

char* buffer_end

buffer end location in memory (buffer_start + max_size) >

char* buffer_start

buffer start location in memory >

void(* Callback) (void *buf)

Push callback, useful if buffer is used for communications, does not need to be used/set, initializes to 0>

char* front

pointer to first item in buffer >

uint16_t max_size

max_size is the length of the buffer array provided by the user >

char* rear

pointer to next open position in the buffer >

uint16_t size

size is the number of items in the buffer >

---

The documentation for this struct was generated from the following file:

• C:/Users/Michael/Software/embeddedlibrary/include/buffer.h