WppTaskQueue.h

Go to the documentation of this file.

/*
 * WppManager.h
 *
 *  Created on: 20 Jul 2023
 *      Author: valentin
 */
 
#ifndef WPP_TASK_QUEUE_H_
#define WPP_TASK_QUEUE_H_
 
#include <list>
#include <functional>
 
#include "WppTypes.h"
#include "WppGuard.h"
 
#define WPP_TASK_MIN_DELAY_S  (time_t)0
#define WPP_TASK_DEF_DELAY_S  (time_t)1
#define WPP_TASK_MAX_DELAY_S  (time_t)(0xFFFFFFF)
 
#define WPP_TASK_DEF_CTX      NULL
#define WPP_ERR_TASK_ID       0
 
namespace wpp {
 
class WppClient;
 
class WppTaskQueue {
public:
    using task_id_t = uint32_t;
    using task_t = std::function<bool(WppClient&, void *)>;
 
private:
    enum TaskState : uint8_t {
        IDLE = 1,
        EXECUTING = 2,
        SHOULD_BE_DELETED = 4,
        MAX_TASK_STATE = 0xFF
    };
 
    struct TaskInfo {
        task_id_t id;
        task_t task;
        time_t delaySec;
        time_t nextCallTime;
        void *ctx = NULL;
        size_t ctxSize = 0;
        TaskState state;
    };
 
private:
    WppTaskQueue();
 
public:
    ~WppTaskQueue();
 
    /* ------------- Tasks management ------------- */
    static task_id_t addTask(time_t delaySec, task_t task);
 
    static task_id_t addTask(void *ctx, time_t delaySec, task_t task);
 
    static task_id_t addTaskWithCopy(const void *ctx, size_t size, time_t delaySec, task_t task);
 
    static size_t getTaskCnt();
 
    static bool isTaskExist(task_id_t id);
 
    static bool isTaskIdle(task_id_t id);
    static bool isTaskExecuting(task_id_t id);
    static bool isTaskShouldBeDeleted(task_id_t id);
 
    static void requestToRemoveTask(task_id_t id);
 
    static void requestToRemoveEachTask();
 
    static void hardReset();
 
    static time_t handleEachTask(WppClient& client);
 
private:
    void deleteFinishedTasks();
 
    time_t updateNextCallTimeForTasks();
 
    task_id_t getNextTaskId();
 
private:
    static WppGuard _handleTaskGuard;
    static WppGuard _taskQueueGuard;
    static WppTaskQueue _instance;
    task_id_t _nextTaskId;
    std::list<TaskInfo *> _tasks;
};
 
} /* namespace wpp */
 
#endif /* WPP_TASK_QUEUE_H_ */