PaUtilRingBuffer Struct Reference

#include <pa_ringbuffer.h>

Data Fields
ring_buffer_size_t	bufferSize
volatile ring_buffer_size_t	writeIndex
volatile ring_buffer_size_t	readIndex
ring_buffer_size_t	bigMask
ring_buffer_size_t	smallMask
ring_buffer_size_t	elementSizeBytes
char *	buffer

Field Documentation

ring_buffer_size_t PaUtilRingBuffer::bigMask

Used for wrapping indices with extra bit to distinguish full/empty.

Referenced by PaUtil_AdvanceRingBufferReadIndex(), PaUtil_AdvanceRingBufferWriteIndex(), PaUtil_GetRingBufferReadAvailable(), and PaUtil_InitializeRingBuffer().

char* PaUtilRingBuffer::buffer

Pointer to the buffer containing the actual data.

Referenced by destroyBlioRingBuffers(), initializeBlioRingBuffers(), PaUtil_GetRingBufferReadRegions(), PaUtil_GetRingBufferWriteRegions(), PaUtil_InitializeRingBuffer(), resetBlioRingBuffers(), and waitUntilBlioWriteBufferIsEmpty().

ring_buffer_size_t PaUtilRingBuffer::bufferSize

Number of elements in FIFO. Power of 2. Set by PaUtil_InitRingBuffer.

Referenced by PaUtil_GetRingBufferReadRegions(), PaUtil_GetRingBufferWriteAvailable(), PaUtil_GetRingBufferWriteRegions(), PaUtil_InitializeRingBuffer(), and resetBlioRingBuffers().

ring_buffer_size_t PaUtilRingBuffer::elementSizeBytes

Number of bytes per element.

Referenced by PaUtil_GetRingBufferReadRegions(), PaUtil_GetRingBufferWriteRegions(), PaUtil_InitializeRingBuffer(), PaUtil_ReadRingBuffer(), PaUtil_WriteRingBuffer(), and resetBlioRingBuffers().

volatile ring_buffer_size_t PaUtilRingBuffer::readIndex

Index of next readable element. Set by PaUtil_AdvanceRingBufferReadIndex.

Referenced by PaUtil_AdvanceRingBufferReadIndex(), PaUtil_FlushRingBuffer(), PaUtil_GetRingBufferReadAvailable(), and PaUtil_GetRingBufferReadRegions().

ring_buffer_size_t PaUtilRingBuffer::smallMask

Used for fitting indices to buffer.

Referenced by PaUtil_GetRingBufferReadRegions(), PaUtil_GetRingBufferWriteRegions(), and PaUtil_InitializeRingBuffer().

volatile ring_buffer_size_t PaUtilRingBuffer::writeIndex

Index of next writable element. Set by PaUtil_AdvanceRingBufferWriteIndex.

Referenced by PaUtil_AdvanceRingBufferWriteIndex(), PaUtil_FlushRingBuffer(), PaUtil_GetRingBufferReadAvailable(), and PaUtil_GetRingBufferWriteRegions().

---

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

• pa_ringbuffer.h