circ_buff Struct Reference
[The Circular-Buff Library]

Storage structure for a key value pair. More...

#include <circ_buff.h>

Data Fields
long	buff_size
long	write_pnt
long	read_pnt
long	byte_count
unsigned long long	byte_id
pthread_mutex_t	circ_write_mut
pthread_mutex_t	circ_read_mut
pthread_mutex_t	circ_size_var_mut
pthread_mutex_t	circ_write_cond_mut
pthread_cond_t	circ_write_cond_var
pthread_mutex_t	circ_read_cond_mut
pthread_cond_t	circ_read_cond_var
void *	buff_ptr

---

Detailed Description

Storage structure for a key value pair.

---

Field Documentation

void* circ_buff::buff_ptr

Pointer to the memory location of the buffer

long circ_buff::buff_size

Size of the buffer in bytes

long circ_buff::byte_count

Number of bytes currently in the buffer

unsigned long long circ_buff::byte_id

Identifier for each byte in the buffer

pthread_mutex_t circ_buff::circ_read_cond_mut

Mutex for use with circ_read_cond_var to wait for a read

pthread_cond_t circ_buff::circ_read_cond_var

Condition variable that allows threads to know when a read has been made

pthread_mutex_t circ_buff::circ_read_mut

Mutex to prevent simultaneous reads

pthread_mutex_t circ_buff::circ_size_var_mut

Mutex to prevent simultaneous updates of the size variable

pthread_mutex_t circ_buff::circ_write_cond_mut

Mutex for use with circ_write_cond_var to wait for a write

pthread_cond_t circ_buff::circ_write_cond_var

Condition variable that allows threads to know when a write has been made

pthread_mutex_t circ_buff::circ_write_mut

Mutex to prevent simultaneous writes

long circ_buff::read_pnt

Starting point to read

long circ_buff::write_pnt

Starting point to write

---

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

• circ_buff.h

---