ringbuffer.h

Go to the documentation of this file.

 
#ifndef SEMF_UTILS_CORE_BUFFER_RINGBUFFER_H_
#define SEMF_UTILS_CORE_BUFFER_RINGBUFFER_H_
 
#include <semf/utils/core/buffer/buffer.h>
 
namespace semf
{
template <typename T>
class RingBuffer : public Buffer<T>
{
public:
    using Buffer<T>::Buffer;
 
    virtual void put(T data);
    T& get();
    virtual T& operator[](size_t pos) const;
    bool isFull() const;
    bool isEmpty() const;
    size_t count() const override;
    void reset();
 
private:
    size_t m_dataCounter = 0;
    size_t m_writePos = 0;
    size_t m_readPos = 0;
};
 
template <typename T>
void RingBuffer<T>::put(T data)
{
    if (isFull())
    {
        return;
    }
 
    CriticalSection::enter();
    ++m_dataCounter;
    m_writePos = (m_writePos + 1) % this->size();
    this->data()[m_writePos] = data;
    CriticalSection::exit();
}
 
template <typename T>
T& RingBuffer<T>::get()
{
#if defined(DEBUG) || defined(USE_SEMF_DEBUG)
    if (isEmpty())
    {
        T* p = nullptr;
        return *p;
    }
#endif
 
    CriticalSection::enter();
    --m_dataCounter;
    m_readPos = (m_readPos + 1) % this->size();
    T& data = this->data()[m_readPos];
    CriticalSection::exit();
 
    return data;
}
 
template <typename T>
T& RingBuffer<T>::operator[](size_t pos) const
{
#if defined(DEBUG) || defined(USE_SEMF_DEBUG)
    if (isEmpty() || pos > m_dataCounter)
    {
        T* p = nullptr;
        return *p;
    }
#endif
 
    CriticalSection::enter();
    size_t readPos = (m_readPos + pos) % this->size();
    T& data = this->data()[readPos];
    CriticalSection::exit();
 
    return data;
}
 
template <typename T>
bool RingBuffer<T>::isFull() const
{
    CriticalSection::enter();
    if (m_dataCounter == this->size())
    {
        CriticalSection::exit();
        return true;
    }
    CriticalSection::exit();
    return false;
}
 
template <typename T>
bool RingBuffer<T>::isEmpty() const
{
    CriticalSection::enter();
    if (m_dataCounter == 0)
    {
        CriticalSection::exit();
        return true;
    }
 
    CriticalSection::exit();
    return false;
}
 
template <typename T>
size_t RingBuffer<T>::count() const
{
    CriticalSection::enter();
    size_t counter = m_dataCounter;
    CriticalSection::exit();
 
    return counter;
}
 
template <typename T>
void RingBuffer<T>::reset()
{
    CriticalSection::enter();
    m_readPos = 0;
    m_writePos = 0;
    m_dataCounter = 0;
    CriticalSection::exit();
}
} /* namespace semf */
#endif /* SEMF_UTILS_CORE_BUFFER_RINGBUFFER_H_ */