RAUL  0.8.0
Public Member Functions | List of all members
Raul::EventRingBuffer Class Reference

A RingBuffer of events (generic time-stamped binary "blobs"). More...

#include <EventRingBuffer.hpp>

Inheritance diagram for Raul::EventRingBuffer:
Inheritance graph
Collaboration diagram for Raul::EventRingBuffer:
Collaboration graph

Public Member Functions

 EventRingBuffer (size_t capacity)
size_t capacity () const
size_t write (TimeStamp time, size_t size, const uint8_t *buf)
bool read (TimeStamp *time, size_t *size, uint8_t *buf)

Additional Inherited Members

- Private Member Functions inherited from Raul::RingBuffer
 RingBuffer (uint32_t size)
void reset ()
 Reset(empty) the ringbuffer.
uint32_t write_space () const
uint32_t read_space () const
uint32_t capacity () const
uint32_t peek (uint32_t size, void *dst)
 Peek at the ringbuffer (read w/o advancing read pointer).
bool full_peek (uint32_t size, void *dst)
uint32_t read (uint32_t size, void *dst)
 Read from the ringbuffer.
bool full_read (uint32_t size, void *dst)
bool skip (uint32_t size)
void write (uint32_t size, const void *src)

Detailed Description

A RingBuffer of events (generic time-stamped binary "blobs").

This packs a timestamp, size, and size bytes of data flat into the buffer. Useful for MIDI events, OSC messages, etc.

Constructor & Destructor Documentation

Raul::EventRingBuffer::EventRingBuffer ( size_t  capacity)
inlineexplicit
Parameters
capacityRingbuffer capacity in bytes.

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