DISTRHO Plugin Framework
Public Member Functions | List of all members
SmallStackRingBuffer Class Reference

#include <RingBuffer.hpp>

Inheritance diagram for SmallStackRingBuffer:
RingBufferControl< SmallStackBuffer >

Public Member Functions

 SmallStackRingBuffer () noexcept
 
- Public Member Functions inherited from RingBufferControl< SmallStackBuffer >
bool isDataAvailableForReading () const noexcept
 
bool isEmpty () const noexcept
 
uint32_t getSize () const noexcept
 
uint32_t getReadableDataSize () const noexcept
 
uint32_t getWritableDataSize () const noexcept
 
void clearData () noexcept
 
void flush () noexcept
 
bool readBool () noexcept
 
uint8_t readByte () noexcept
 
int16_t readShort () noexcept
 
uint16_t readUShort () noexcept
 
int32_t readInt () noexcept
 
uint32_t readUInt () noexcept
 
int64_t readLong () noexcept
 
uint64_t readULong () noexcept
 
float readFloat () noexcept
 
double readDouble () noexcept
 
bool readCustomData (void *const data, const uint32_t size) noexcept
 
bool readCustomType (T &type) noexcept
 
bool writeBool (const bool value) noexcept
 
bool writeByte (const uint8_t value) noexcept
 
bool writeShort (const int16_t value) noexcept
 
bool writeUShort (const uint16_t value) noexcept
 
bool writeInt (const int32_t value) noexcept
 
bool writeUInt (const uint32_t value) noexcept
 
bool writeLong (const int64_t value) noexcept
 
bool writeULong (const uint64_t value) noexcept
 
bool writeFloat (const float value) noexcept
 
bool writeDouble (const double value) noexcept
 
bool writeCustomData (const void *const data, const uint32_t size) noexcept
 
bool writeCustomType (const T &type) noexcept
 
bool commitWrite () noexcept
 
void setRingBuffer (SmallStackBuffer *const ringBuf, const bool clearRingBufferData) noexcept
 

Additional Inherited Members

- Protected Member Functions inherited from RingBufferControl< SmallStackBuffer >
bool tryRead (void *const buf, const uint32_t size) noexcept
 
bool tryWrite (const void *const buf, const uint32_t size) noexcept
 

Detailed Description

RingBufferControl with an included small stack buffer. No setup is necessary, this class is usable as-is.

Constructor & Destructor Documentation

◆ SmallStackRingBuffer()

SmallStackRingBuffer::SmallStackRingBuffer ( )
inlinenoexcept

Constructor.


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