Ringbuffer Struct Reference

Generic fixed-size ring buffer state. More...

#include <ringbuffer.h>

Data Fields
void *	buffer
void *	bufferEnd
size_t	capacity
size_t	count
size_t	itemSizeInByte
void *	head
void *	tail

Detailed Description

Generic fixed-size ring buffer state.

Definition at line 27 of file ringbuffer.h.

Field Documentation

buffer

void* Ringbuffer::buffer

Start of raw buffer memory.

Definition at line 30 of file ringbuffer.h.

Referenced by RbInit(), RbPopFront(), RbPushBack(), and RbPushBackWrap().

bufferEnd

void* Ringbuffer::bufferEnd

End pointer of raw buffer memory.

Definition at line 32 of file ringbuffer.h.

Referenced by RbInit(), RbPopFront(), RbPushBack(), and RbPushBackWrap().

capacity

size_t Ringbuffer::capacity

Number of storable elements.

Definition at line 34 of file ringbuffer.h.

Referenced by poll_queue_stats(), print_status_event(), RbInit(), RbPushBack(), RbPushBackWrap(), and tx_queue_enqueue_udp_frame().

count

size_t Ringbuffer::count

Current number of elements stored.

Definition at line 36 of file ringbuffer.h.

Referenced by poll_queue_stats(), print_status_event(), RbInit(), RbPopFront(), RbPushBack(), RbPushBackWrap(), tx_queue_enqueue_udp_frame(), tx_queue_get_count(), and tx_queue_is_empty().

head

void* Ringbuffer::head

Write cursor.

Definition at line 40 of file ringbuffer.h.

Referenced by RbInit(), RbPushBack(), and RbPushBackWrap().

itemSizeInByte

size_t Ringbuffer::itemSizeInByte

Size in bytes of one element.

Definition at line 38 of file ringbuffer.h.

Referenced by RbInit(), RbPopFront(), RbPushBack(), and RbPushBackWrap().

tail

void* Ringbuffer::tail

Read cursor.

Definition at line 42 of file ringbuffer.h.

Referenced by RbInit(), RbPopFront(), and RbPushBackWrap().

---

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

• ringbuffer.h