JackTrip
|
Provides a ring-buffer (or circular-buffer) that can be written to and read from asynchronously (blocking) or synchronously (non-blocking). More...
#include <RingBuffer.h>
Classes | |
struct | IOStat |
Public Member Functions | |
RingBuffer (int SlotSize, int NumSlots) | |
The class constructor. More... | |
virtual | ~RingBuffer () |
The class destructor. More... | |
void | insertSlotBlocking (const int8_t *ptrToSlot) |
Insert a slot into the RingBuffer from ptrToSlot. This method will block until there's space in the buffer. More... | |
void | readSlotBlocking (int8_t *ptrToReadSlot) |
Read a slot from the RingBuffer into ptrToReadSlot. This method will block until there's space in the buffer. More... | |
void | insertSlotNonBlocking (const int8_t *ptrToSlot) |
Same as insertSlotBlocking but non-blocking (asynchronous) More... | |
void | readSlotNonBlocking (int8_t *ptrToReadSlot) |
Same as readSlotBlocking but non-blocking (asynchronous) More... | |
virtual bool | getStats (IOStat *stat, bool reset) |
Protected Member Functions | |
virtual void | setUnderrunReadSlot (int8_t *ptrToReadSlot) |
Sets the memory in the Read Slot when uderrun occurs. By default, this sets it to 0. Override this method in a subclass for a different behavior. More... | |
virtual void | setMemoryInReadSlotWithLastReadSlot (int8_t *ptrToReadSlot) |
Uses the last read slot to set the memory in the Read Slot. More... | |
Provides a ring-buffer (or circular-buffer) that can be written to and read from asynchronously (blocking) or synchronously (non-blocking).
The RingBuffer is an array of NumSlots slots of memory each of which is of size SlotSize bytes (8-bits). Slots can be read and written asynchronously/synchronously by multiple threads.
RingBuffer::RingBuffer | ( | int | SlotSize, |
int | NumSlots | ||
) |
The class constructor.
SlotSize | Size of one slot in bytes |
NumSlots | Number of slots |
|
virtual |
The class destructor.
|
virtual |
void RingBuffer::insertSlotBlocking | ( | const int8_t * | ptrToSlot | ) |
Insert a slot into the RingBuffer from ptrToSlot. This method will block until there's space in the buffer.
The caller is responsible to make sure sizeof(WriteSlot) = SlotSize. This method should be use when the caller can block against its output, like sending/receiving UDP packets. It shouldn't be used by audio. For that, use the insertSlotNonBlocking.
ptrToSlot | Pointer to slot to insert into the RingBuffer |
void RingBuffer::insertSlotNonBlocking | ( | const int8_t * | ptrToSlot | ) |
Same as insertSlotBlocking but non-blocking (asynchronous)
ptrToSlot | Pointer to slot to insert into the RingBuffer |
void RingBuffer::readSlotBlocking | ( | int8_t * | ptrToReadSlot | ) |
Read a slot from the RingBuffer into ptrToReadSlot. This method will block until there's space in the buffer.
The caller is responsible to make sure sizeof(ptrToReadSlot) = SlotSize. This method should be use when the caller can block against its input, like sending/receiving UDP packets. It shouldn't be used by audio. For that, use the readSlotNonBlocking.
ptrToReadSlot | Pointer to read slot from the RingBuffer |
void RingBuffer::readSlotNonBlocking | ( | int8_t * | ptrToReadSlot | ) |
Same as readSlotBlocking but non-blocking (asynchronous)
ptrToReadSlot | Pointer to read slot from the RingBuffer |
|
protectedvirtual |
Uses the last read slot to set the memory in the Read Slot.
The last read slot is the last packet that arrived, so if no new packets are received, it keeps looping the same packet.
ptrToReadSlot | Pointer to read slot from the RingBuffer |
|
protectedvirtual |
Sets the memory in the Read Slot when uderrun occurs. By default, this sets it to 0. Override this method in a subclass for a different behavior.
ptrToReadSlot | Pointer to read slot from the RingBuffer |
Reimplemented in RingBufferWavetable.