---

buffer.h File Reference

Multipurpose byte buffer structure and methods. More...

Go to the source code of this file.

Data Structures
struct	struct_cBuffer
Typedefs
typedef struct_cBuffer	cBuffer
Functions
void	bufferInit (cBuffer *buffer, unsigned char *start, unsigned short size)
	initialize a buffer to start at a given address and have given size
unsigned char	bufferGetFromFront (cBuffer *buffer)
	get the first byte from the front of the buffer
void	bufferDumpFromFront (cBuffer *buffer, unsigned short numbytes)
	dump (discard) the first numbytes from the front of the buffer
unsigned char	bufferGetAtIndex (cBuffer *buffer, unsigned short index)
	get a byte at the specified index in the buffer (kind of like array access)
unsigned char	bufferAddToEnd (cBuffer *buffer, unsigned char data)
	add a byte to the end of the buffer
unsigned char	bufferIsNotFull (cBuffer *buffer)
	check if the buffer is full/not full (returns non-zero value if not full)
void	bufferFlush (cBuffer *buffer)
	flush (clear) the contents of the buffer

---

Detailed Description

Multipurpose byte buffer structure and methods.

Definition in file buffer.h.

---