circular_buffer_uint8_struct Struct Reference

circular buffer struct More...

#include <circular_buffer.h>

Public Attributes
size_t	capacity
size_t	size
size_t	iStart
size_t	iStop
uint8_t *	buffer

Detailed Description

circular buffer struct

Keeps track of the state of the circular buffer Use this for a buffer of unit8's.

Definition at line 20 of file circular_buffer.h.

Member Data Documentation

buffer

uint8_t* circular_buffer_uint8_struct::buffer

pointer to actual data buffer

Definition at line 25 of file circular_buffer.h.

Referenced by circular_buffer_get_blocks_uint8(), circular_buffer_get_element_uint8(), circular_buffer_get_first_block_uint8(), circular_buffer_init_uint8(), circular_buffer_pop_back_uint8(), circular_buffer_pop_front_block_uint8(), circular_buffer_pop_front_to_fd_uint8(), circular_buffer_pop_front_uint8(), circular_buffer_print_uint8(), circular_buffer_push_back_from_fd_uint8(), circular_buffer_push_back_uint8(), and circular_buffer_push_front_uint8().

capacity

size_t circular_buffer_uint8_struct::capacity

capacity of actual data buffer

Definition at line 21 of file circular_buffer.h.

Referenced by circular_buffer_delete_first_block_uint8(), circular_buffer_get_blocks_uint8(), circular_buffer_get_element_uint8(), circular_buffer_get_first_block_uint8(), circular_buffer_init_uint8(), circular_buffer_is_full_uint8(), circular_buffer_pop_front_block_uint8(), circular_buffer_pop_front_to_fd_uint8(), circular_buffer_print_uint8(), circular_buffer_push_back_from_fd_uint8(), circular_buffer_push_back_uint8(), and circular_buffer_push_front_uint8().

iStart

size_t circular_buffer_uint8_struct::iStart

front element of buffer

Definition at line 23 of file circular_buffer.h.

Referenced by circular_buffer_clear_uint8(), circular_buffer_delete_first_block_uint8(), circular_buffer_get_blocks_uint8(), circular_buffer_get_element_uint8(), circular_buffer_get_first_block_uint8(), circular_buffer_init_uint8(), circular_buffer_pop_front_block_uint8(), circular_buffer_pop_front_to_fd_uint8(), circular_buffer_pop_front_uint8(), circular_buffer_print_uint8(), circular_buffer_push_back_from_fd_uint8(), and circular_buffer_push_front_uint8().

iStop

size_t circular_buffer_uint8_struct::iStop

1 past the back element of buffer

Definition at line 24 of file circular_buffer.h.

Referenced by circular_buffer_clear_uint8(), circular_buffer_delete_first_block_uint8(), circular_buffer_init_uint8(), circular_buffer_pop_back_uint8(), circular_buffer_pop_front_block_uint8(), circular_buffer_pop_front_to_fd_uint8(), circular_buffer_print_uint8(), circular_buffer_push_back_from_fd_uint8(), and circular_buffer_push_back_uint8().

size

size_t circular_buffer_uint8_struct::size

N elements in circ buffer

Definition at line 22 of file circular_buffer.h.

Referenced by circular_buffer_clear_uint8(), circular_buffer_count_uint8(), circular_buffer_delete_first_block_uint8(), circular_buffer_find_first_uint8(), circular_buffer_find_last_uint8(), circular_buffer_get_first_block_uint8(), circular_buffer_get_size_uint8(), circular_buffer_init_uint8(), circular_buffer_pop_back_uint8(), circular_buffer_pop_front_block_uint8(), circular_buffer_pop_front_to_fd_uint8(), circular_buffer_pop_front_uint8(), circular_buffer_print_uint8(), circular_buffer_push_back_from_fd_uint8(), circular_buffer_push_back_uint8(), circular_buffer_push_front_uint8(), circular_buffer_remove_back_to_uint8(), circular_buffer_remove_front_to_uint8(), and circular_buffer_remove_front_unfinished_frames_uint8().

---

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

• circular_buffer.h