Dynalib Utils
Public Member Functions | Static Public Attributes | List of all members
DynaRingBuffer Class Reference

#include <DynaRingBuffer.h>

Public Member Functions

 DynaRingBuffer (ulong size)
 
virtual ~DynaRingBuffer ()
 
void reset ()
 
bool isEmpty ()
 
bool isFull ()
 
bool hasNextByte ()
 
bool hasByteCount (ulong count)
 
ulong getCount ()
 
bool hasFreeCount (ulong count)
 
ulong getFreeCount ()
 
ulong getBufferSize ()
 
uint8_t getNextByte ()
 
uint8_t popLastByte ()
 
ushort getNextUShort ()
 
ulong getNextULong ()
 
ulonglong getNextULongLong ()
 
float getNextFloat ()
 
double getNextDouble ()
 
String getBufferAsString ()
 
bool getNextString (char *buf, ulong count, bool addTerm)
 
void getNextString (char *buf, ulong maxCount)
 
bool getNextString (String &str)
 
bool getNextToken (String &str, char delim)
 
bool putByte (uint8_t value)
 
bool putUShort (ushort value)
 
bool putULong (ulong value)
 
bool putULongLong (ulonglong value)
 
bool putFloat (float value)
 
bool putDouble (double value)
 
bool putString (const char *value, bool addTerm=true)
 

Static Public Attributes

static bool THROW_EXCEPTIONS = true
 

Constructor & Destructor Documentation

◆ DynaRingBuffer()

DynaRingBuffer::DynaRingBuffer ( ulong  size)
explicit

◆ ~DynaRingBuffer()

DynaRingBuffer::~DynaRingBuffer ( )
virtual

Member Function Documentation

◆ getBufferAsString()

String DynaRingBuffer::getBufferAsString ( )

◆ getBufferSize()

ulong DynaRingBuffer::getBufferSize ( )

◆ getCount()

ulong DynaRingBuffer::getCount ( )

◆ getFreeCount()

ulong DynaRingBuffer::getFreeCount ( )

◆ getNextByte()

uint8_t DynaRingBuffer::getNextByte ( )

◆ getNextDouble()

double DynaRingBuffer::getNextDouble ( )

◆ getNextFloat()

float DynaRingBuffer::getNextFloat ( )

◆ getNextString() [1/3]

bool DynaRingBuffer::getNextString ( char *  buf,
ulong  count,
bool  addTerm 
)

◆ getNextString() [2/3]

void DynaRingBuffer::getNextString ( char *  buf,
ulong  maxCount 
)

◆ getNextString() [3/3]

bool DynaRingBuffer::getNextString ( String str)

◆ getNextToken()

bool DynaRingBuffer::getNextToken ( String str,
char  delim 
)

◆ getNextULong()

ulong DynaRingBuffer::getNextULong ( )

◆ getNextULongLong()

ulonglong DynaRingBuffer::getNextULongLong ( )

◆ getNextUShort()

ushort DynaRingBuffer::getNextUShort ( )

◆ hasByteCount()

bool DynaRingBuffer::hasByteCount ( ulong  count)

◆ hasFreeCount()

bool DynaRingBuffer::hasFreeCount ( ulong  count)

◆ hasNextByte()

bool DynaRingBuffer::hasNextByte ( )

◆ isEmpty()

bool DynaRingBuffer::isEmpty ( )

◆ isFull()

bool DynaRingBuffer::isFull ( )

◆ popLastByte()

uint8_t DynaRingBuffer::popLastByte ( )

◆ putByte()

bool DynaRingBuffer::putByte ( uint8_t  value)

◆ putDouble()

bool DynaRingBuffer::putDouble ( double  value)

◆ putFloat()

bool DynaRingBuffer::putFloat ( float  value)

◆ putString()

bool DynaRingBuffer::putString ( const char *  value,
bool  addTerm = true 
)

◆ putULong()

bool DynaRingBuffer::putULong ( ulong  value)

◆ putULongLong()

bool DynaRingBuffer::putULongLong ( ulonglong  value)

◆ putUShort()

bool DynaRingBuffer::putUShort ( ushort  value)

◆ reset()

void DynaRingBuffer::reset ( )

Member Data Documentation

◆ THROW_EXCEPTIONS

bool DynaRingBuffer::THROW_EXCEPTIONS = true
static

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