BUFFER Struct Reference

#include <buffer.h>

List of all members.

Public Attributes
char *	buffer
uint16_t	size
volatile int16_t	front
volatile int16_t	back

---

Detailed Description

Buffer structure. Implementation of a circular byte buffer.

---

Member Data Documentation

volatile int16_t BUFFER::back

Current index of the next location to receive a byte.

Referenced by buffer_add(), buffer_create(), buffer_nbytes(), and buffer_reset().

char* BUFFER::buffer

Pointer to the storage space.

Referenced by buffer_add(), buffer_create(), and buffer_remove().

volatile int16_t BUFFER::front

Current index of the next byte to be removed.

Referenced by buffer_create(), buffer_nbytes(), buffer_remove(), and buffer_reset().

uint16_t BUFFER::size

Total number of bytes available for storage.

Referenced by buffer_add(), buffer_create(), buffer_nbytes(), and buffer_remove().

---

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

• include/buffer.h