Task Class Reference

FreeRTOS task. More...

#include <Task.h>

Inheritance diagram for Task:

Public Member Functions
	Task ()=default
	Task (const char *name, int stackSize, int priority=1, int core=-1)
	Defines and creates a FreeRTOS task.
	~Task ()
bool	begin (std::function< void()> process)
bool	create (const char *name, int stackSize, int priority=1, int core=-1)
	If you used the empty constructor, you need to call create!
void	end ()
	suspends the task
int	getCoreID ()
void *	getReference ()
TaskHandle_t &	getTaskHandle ()
void	remove ()
	deletes the FreeRTOS task
void	resume ()
void	setReference (void *r)
void	suspend ()

Static Protected Member Functions
static void	nop ()
static void	task_loop (void *arg)

Protected Attributes
std::function< void()>	loop_code = nop
void *	ref
TaskHandle_t	xHandle = nullptr

Detailed Description

FreeRTOS task.

Note

Supported by all FreeRTOS platforms

Author

Phil Schatzmann

Copyright

GPLv3 *

Constructor & Destructor Documentation

Task() [1/2]

Task ( const char *  name, int  stackSize, int  priority = 1, int  core = -1  )

inline

Defines and creates a FreeRTOS task.

Task() [2/2]

Task ( )

default

~Task()

~Task ( )

inline

Member Function Documentation

begin()

bool begin ( std::function< void()>  process )

inlinevirtual

Implements ITask.

create()

bool create ( const char *  name, int  stackSize, int  priority = 1, int  core = -1  )

inline

If you used the empty constructor, you need to call create!

end()

void end ( )

inlinevirtual

suspends the task

Implements ITask.

getCoreID()

int getCoreID ( )

inline

getReference()

void * getReference ( )

inline

getTaskHandle()

TaskHandle_t & getTaskHandle ( )

inline

nop()

static void nop ( )

inlinestaticprotected

remove()

void remove ( )

inline

deletes the FreeRTOS task

resume()

void resume ( )

inline

setReference()

void setReference ( void *  r )

inline

suspend()

void suspend ( )

inline

task_loop()

static void task_loop ( void *  arg )

inlinestaticprotected

Member Data Documentation

loop_code

std::function<void()> loop_code = nop

protected

ref

void* ref

protected

xHandle

TaskHandle_t xHandle = nullptr

protected

---

The documentation for this class was generated from the following file:

• src/AudioTools/Concurrency/RTOS/Task.h