RingBuffer.h

Go to the documentation of this file.

/*
 * RingBuffer.h
 *
 * Copyright (c) 2020-2024 Timo Lappalainen, Kave Oy, www.kave.fi
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a
 * copy of this software and associated documentation files (the "Software"),
 * to deal in the Software without restriction, including without limitation
 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
 * and/or sell copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following conditions:
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 
 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
*/
 
/*************************************************************************/
#ifndef _RING_BUFFER_H_
#define _RING_BUFFER_H_
 
#include <cstdint>
/************************************************************************/
template <typename T> class tRingBuffer {
 
protected:
  T *buffer;
  uint16_t head;
  uint16_t tail;
  uint16_t size;
 
public:
  /************************************************************************/
  tRingBuffer(uint16_t _size);
  /************************************************************************/
  virtual ~tRingBuffer();
  /************************************************************************/
  uint16_t getSize() const { return size; }
  /************************************************************************/
  bool isEmpty() const;
  /************************************************************************/
  void clear();
  /************************************************************************/
  uint16_t count();
 
  /************************************************************************/
  T *getAddRef();
 
  /************************************************************************/
  bool add(const T &val);
 
  /************************************************************************/
  const T *getReadRef();
 
  /************************************************************************/
  T *peek();
  
  /************************************************************************/
  bool read(T &val);
};
 
/************************************************************************/
template <typename T> class tPriorityRingBuffer {
protected:
  #define INVALID_RING_REF (uint16_t)(-1)
  #define INVALID_PRIORITY_REF (uint8_t)(-1)
 
  /************************************************************************/
  struct tValueSlot {
    T Value;
    uint16_t next;
    uint8_t priority;
  };
  /************************************************************************/
  struct tPriorityRef {
    uint16_t next;
    uint16_t last;
    tPriorityRef() : next(INVALID_RING_REF), last(INVALID_RING_REF) {;}
    void clear() { next=INVALID_RING_REF; last=INVALID_RING_REF; }
  };
protected:
  tValueSlot *buffer;
  tPriorityRef *priorityReferencies;
  uint16_t head;
  uint16_t tail;
  uint16_t size;
  uint8_t maxPriorities;
 
public:
  /************************************************************************/
  tPriorityRingBuffer(uint16_t _size, uint8_t _maxPriorities=1);
  /************************************************************************/
  virtual ~tPriorityRingBuffer();
 
  /************************************************************************/
  uint16_t getSize() const { return size; }
  /************************************************************************/
  static uint32_t getMemSize(uint16_t _size, uint8_t _maxPriorities=1);
  /************************************************************************/
  bool isEmpty(uint8_t _priority=0xff) const;
  /************************************************************************/
  void clear();
  /************************************************************************/
  void clean();
  /************************************************************************/
  uint16_t count();
  /************************************************************************/
  bool add(const T &val, uint8_t _priority=0);
  /************************************************************************/
  bool read(T &val);
 
  /************************************************************************/
  T *getAddRef(uint8_t _priority=0);
 
  /************************************************************************/
  const T *getReadRef(uint8_t _priority);
  
  /************************************************************************/
  const T *getReadRef(uint8_t *_priority=0);
};
 
 
#include "RingBuffer.tpp"
 
#endif