esp32-snippets/Task_8h_source.html

 /*

  * Task.h

  *

  *  Created on: Mar 4, 2017

  *      Author: kolban

  */


 #ifndef COMPONENTS_CPP_UTILS_TASK_H_

 #define COMPONENTS_CPP_UTILS_TASK_H_

 #include <freertos/FreeRTOS.h>

 #include <freertos/task.h>

 #include <string>

 class Task {

 public:

     Task(std::string taskName = "Task", uint16_t stackSize = 10000, uint8_t priority = 5);

     virtual ~Task();

     void setStackSize(uint16_t stackSize);

     void setPriority(uint8_t priority);

     void setName(std::string name);

     void setCore(BaseType_t coreId);

     void start(void* taskData = nullptr);

     void stop();

     virtual void run(void* data) = 0; // Make run pure virtual

     static void delay(int ms);


 private:

     xTaskHandle m_handle;

     void*       m_taskData;

     static void runTask(void* data);

     std::string m_taskName;

     uint16_t    m_stackSize;

     uint8_t     m_priority;

     BaseType_t  m_coreId;


 };


 #endif /* COMPONENTS_CPP_UTILS_TASK_H_ */

Task::delay
static void delay(int ms)
Suspend the task for the specified milliseconds.
Definition: Task.cpp:46

Task::setStackSize
void setStackSize(uint16_t stackSize)
Set the stack size of the task.
Definition: Task.cpp:97

Task::setName
void setName(std::string name)
Set the name of the task.
Definition: Task.cpp:117

Task::setPriority
void setPriority(uint8_t priority)
Set the priority of the task.
Definition: Task.cpp:107

Task::setCore
void setCore(BaseType_t coreId)
Set the core number the task has to be executed on. If the core number is not set, tskNO_AFFINITY will be used.
Definition: Task.cpp:128

Task::stop
void stop()
Stop the task.
Definition: Task.cpp:84

Task::run
virtual void run(void *data)=0
Body of the task to execute.

Task::Task
Task(std::string taskName="Task", uint16_t stackSize=10000, uint8_t priority=5)
Create an instance of the task class.
Definition: Task.cpp:27

Task::start
void start(void *taskData=nullptr)
Start an instance of the task.
Definition: Task.cpp:70

Task
Encapsulate a runnable task.
Definition: Task.h:34