ERROR_BUFFER Struct Reference

A ring buffer for errors. More...

Data Fields

unsigned char empty
 0: The buffer is not empty, 1: the buffer is empty.
ERROR_INFO errors [ERR_BUF_SIZE]
 The array for holding the errors.
unsigned char first
 Points to the first/oldest error added to the buffer.
unsigned char next
 Points to the front of the buffer, the slot where the next error will be added.
unsigned char overflows
 The number of lost errors caused by overflows.

Detailed Description

A ring buffer for errors.

Holds errors until they are transmitted. If newer errors begin replacing old errors, this information is added to overflows. This value is set back to 0 once an error is popped and the buffer is no longer completely full.

Definition at line 45 of file error.h.


Field Documentation

unsigned char ERROR_BUFFER::empty

0: The buffer is not empty, 1: the buffer is empty.

Definition at line 50 of file error.h.

Referenced by error_init(), error_pop(), error_push(), error_send_next(), and error_update().

The array for holding the errors.

Definition at line 46 of file error.h.

Referenced by error_pop(), error_push(), and error_update().

unsigned char ERROR_BUFFER::first

Points to the first/oldest error added to the buffer.

Definition at line 47 of file error.h.

Referenced by error_init(), error_pop(), error_push(), and error_update().

unsigned char ERROR_BUFFER::next

Points to the front of the buffer, the slot where the next error will be added.

Definition at line 48 of file error.h.

Referenced by error_init(), error_pop(), error_push(), and error_update().

unsigned char ERROR_BUFFER::overflows

The number of lost errors caused by overflows.

Definition at line 49 of file error.h.

Referenced by error_init(), error_pop(), and error_push().


The documentation for this struct was generated from the following file:
Generated on Tue Jun 29 16:36:15 2010 by  doxygen 1.6.3