queue.hpp

#ifndef QOS_CPP_QUEUE
#define QOS_CPP_QUEUE
 
#include "include/types.hpp"
 
namespace qOS {
 
    enum class queueSendMode {
        TO_BACK,    /*< to indicate whether the item in the queue should be sent to the back. */
        TO_FRONT    /*< to indicate whether the item in the queue should be sent to the front. */
    };
 
    class queue {
        private:
            uint8_t *head{ nullptr };
            uint8_t *tail{ nullptr };
            uint8_t *writer{ nullptr };
            uint8_t *reader{ nullptr };
            volatile size_t itemsWaiting = 0U;
            size_t itemsCount = 0U;
            size_t itemSize = 0U;
            void moveReader( void ) noexcept;
            void copyDataFromQueue( void * const dst ) noexcept;
            void copyDataToQueue( const void *itemToQueue, const queueSendMode xPosition ) noexcept;
            queue( queue const& ) = delete;
            void operator=( queue const& ) = delete;
        public:
            queue() = default;
            virtual ~queue() {}
            bool setup( void *pData, const size_t size, const size_t count ) noexcept;
            template <typename T>
            bool setup( void *pData, const size_t count ) noexcept
            {
                return setup( pData, sizeof(T), count );
            }
            void reset( void ) noexcept;
            bool isEmpty( void ) const noexcept;
            bool isFull( void ) const noexcept;
            size_t count( void ) const noexcept;
            size_t itemsAvailable( void ) const noexcept;
            bool removeFront( void ) noexcept;
            bool receive( void *dst ) noexcept;
            bool send( void *itemToQueue, const queueSendMode pos = queueSendMode::TO_BACK ) noexcept;
            void* peek( void ) const noexcept;
            bool isInitialized( void ) const noexcept;
            size_t getItemSize( void ) const noexcept;
    };
 
}
 
 
#endif /*QOS_CPP_QUEUE*/