queue/mn_queue.hpp

Go to the documentation of this file.

/*
*This file is part of the Mini Thread Library (https://github.com/RoseLeBlood/MiniThread ).
*Copyright (c) 2020 Amber-Sophia Schroeck
*
*The Mini Thread Library is free software; you can redistribute it and/or modify  
*it under the terms of the GNU Lesser General Public License as published by  
*the Free Software Foundation, version 3, or (at your option) any later version.
 
*The Mini Thread Library is distributed in the hope that it will be useful, but 
*WITHOUT ANY WARRANTY; without even the implied warranty of 
*MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 
*General Public License for more details.
*
*You should have received a copy of the GNU Lesser General Public
*License along with the Mini Thread  Library; if not, see
*<https://www.gnu.org/licenses/>.  
*/
#ifndef MINLIB_ESP32_QUEUE_
#define MINLIB_ESP32_QUEUE_
 
#include "mn_config.hpp"
 
namespace mn {
    namespace queue {
        class basic_queue {
        public:
            basic_queue(unsigned int maxItems, unsigned int itemSize);
 
            virtual ~basic_queue();
 
            virtual int create();
 
            virtual int destroy();
            virtual int enqueue(void *item, 
                            unsigned int timeout = MN_THREAD_CONFIG_TIMEOUT_QUEUE_DEFAULT);
 
 
            virtual int peek(void *item,
                            unsigned int timeout = MN_THREAD_CONFIG_TIMEOUT_QUEUE_DEFAULT);
 
            virtual int dequeue(void *item, 
                            unsigned int timeout = MN_THREAD_CONFIG_TIMEOUT_QUEUE_DEFAULT);
 
            virtual bool is_empty();
            virtual bool is_full();
            
            virtual int clear();
 
            virtual unsigned int get_num_items();
 
            virtual unsigned int get_left();
 
            void*  get_handle() { return m_pHandle; }
        protected:
            void*  m_pHandle;
 
            unsigned int m_imaxItems;
            unsigned int m_iitemSize;
        };
 
        using queue_t = basic_queue;
    }
}
 
#endif