mn_workqueue.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_WORK_QUEUE_BASE_
#define MINLIB_ESP32_WORK_QUEUE_BASE_
 
#include "mn_queue.hpp"
#include "mn_workqueue_item.hpp"
#include "mn_workqueue_task.hpp"
 
namespace mn {
    namespace queue {
        class basic_work_queue {
            friend class work_queue_task;
        public:
            basic_work_queue(basic_task::priority uiPriority,
                            uint16_t usStackDepth,
                            uint8_t uiMaxWorkItems);
 
            virtual ~basic_work_queue();
 
            virtual int create(int iCore = MN_THREAD_CONFIG_DEFAULT_WORKQUEUE_CORE);
            virtual void destroy();
 
            virtual int queue(work_queue_item_t *work,
                            unsigned int timeout = MN_THREAD_CONFIG_TIMEOUT_QUEUE_DEFAULT);
 
            volatile bool& running() { return m_bRunning; }
 
            uint8_t get_num_items_worked();
            uint8_t get_num_items_error();
 
            bool is_ready();
        protected:
            virtual work_queue_item* get_next_item(unsigned int timeout);
 
            virtual int create_engine(int iCore) = 0;
            virtual void destroy_engine() = 0;
        protected:
            queue_t* m_pWorkItemQueue;
            mutex_t  m_ThreadStatus;
            mutex_t  m_ThreadJob;
            
            basic_task::priority m_uiPriority ;
            uint16_t m_usStackDepth; 
            uint8_t m_uiMaxWorkItems;
 
            volatile uint8_t m_uiNumWorks;
            volatile uint8_t m_uiErrorsNumWorks;
            volatile bool m_bRunning;
        };
    }
}
 
#endif