EnigmaIOTRingBuffer.h

Go to the documentation of this file.

 
#ifndef _ENIGMAIOTBUFFER_h
#define _ENIGMAIOTBUFFER_h
 
#if defined(ARDUINO) && ARDUINO >= 100
#include "Arduino.h"
#else
#include "WProgram.h"
#endif
#include "helperFunctions.h"
 
template <typename Telement>
class EnigmaIOTRingBuffer {
protected:
    int maxSize; 
    int numElements = 0; 
    int readIndex = 0; 
    int writeIndex = 0; 
    Telement* buffer; 
 
public:
    EnigmaIOTRingBuffer <Telement> (int range) : maxSize (range) {
        buffer = new Telement[maxSize];
    }
 
    ~EnigmaIOTRingBuffer () {
        maxSize = 0;
        delete[] (buffer);
    }
 
    int size () { return numElements; }
 
    bool isFull () { return numElements == maxSize; }
 
    bool empty () { return (numElements == 0); }
 
    bool push (Telement* item) {
        bool wasFull = isFull ();
        DEBUG_DBG ("Add element. Buffer was %s", wasFull ? "full" : "not full");
        DEBUG_DBG ("Before -- > ReadIdx: %d. WriteIdx: %d. Size: %d", readIndex, writeIndex, numElements);
#ifdef ESP32
        portMUX_TYPE myMutex = portMUX_INITIALIZER_UNLOCKED;
        portENTER_CRITICAL (&myMutex);
#endif
        memcpy (&(buffer[writeIndex]), item, sizeof (Telement));
        //Serial.printf ("Copied: %d bytes\n", sizeof (Telement));
        writeIndex++;
        if (writeIndex >= maxSize) {
            writeIndex %= maxSize;
        }
        if (wasFull) { // old value is no longer valid
            readIndex++;
            if (readIndex >= maxSize) {
                readIndex %= maxSize;
            }
        } else {
            numElements++;
        }
#ifdef ESP32
        portEXIT_CRITICAL (&myMutex);
#endif
        DEBUG_DBG ("After -- > ReadIdx: %d. WriteIdx: %d. Size: %d", readIndex, writeIndex, numElements);
        return !wasFull;
    }
 
    bool pop () {
        bool wasEmpty = empty ();
        DEBUG_DBG ("Remove element. Buffer was %s", wasEmpty ? "empty" : "not empty");
        DEBUG_DBG ("Before -- > ReadIdx: %d. WriteIdx: %d. Size: %d", readIndex, writeIndex, numElements);
        if (!wasEmpty) {
            readIndex++;
            if (readIndex >= maxSize) {
                readIndex %= maxSize;
            }
            numElements--;
        }
        DEBUG_DBG ("After -- > ReadIdx: %d. WriteIdx: %d. Size: %d", readIndex, writeIndex, numElements);
        return !wasEmpty;
    }
 
    Telement* front () {
        DEBUG_DBG ("Read element. ReadIdx: %d. WriteIdx: %d. Size: %d", readIndex, writeIndex, numElements);
        if (!empty ()) {
            return &(buffer[readIndex]);
        } else {
            return NULL;
        }
    }
};
 
#endif