RingBuffer.h

Go to the documentation of this file.

#ifndef RINGBUFFER_H_
#define RINGBUFFER_H_

#include <cstdlib>
#include <cstdio>

#include "ListEntry.h"
#include "Mutex.h"

class RingBufferVoid
{
public:
    RingBufferVoid( const bool freeOnCleanup = true );

    virtual ~RingBufferVoid();

    bool isEmpty();

    void freeAll();

    void push( void* item );

    void* pop();

    void* peek();

protected:
    ListEntry<void*>* start_;
    ListEntry<void*>* end_;
    const bool freeOnCleanup_;
    Mutex mutex_;

private:
    // Note that the copy constructor below is private and not given a body.
    // Any attempt to call it will return a compiler error.
    RingBufferVoid( const RingBufferVoid& old ); // disallow copy constructor

};

template< typename T >
class RingBuffer : public RingBufferVoid
{
public:
    RingBuffer( const bool deleteOnCleanup = true )
        : RingBufferVoid( deleteOnCleanup )
    {}
    ;

    virtual ~RingBuffer()
    {
        deleteAll();
    };

    void deleteAll()
    {
        while( freeOnCleanup_ && !isEmpty() )
        {
            T item( pop() );
            if( NULL != item )
            {
                delete item;
            }
        }
    };

    void push( T item )
    {
        RingBufferVoid::push( ( void* )item );
    };

    T pop()
    {
        return ( T )RingBufferVoid::pop();
    };

    T peek()
    {
        return ( T )RingBufferVoid::peek();
    };
};

#endif /*RINGBUFFER_H_*/