FreeRTOS C++ Wrappers
Public Member Functions | Public Attributes | List of all members
Task Class Reference

Lowest Level Wrapper. Create the specified task with a provided task function. More...

#include <TaskCPP.h>

Inheritance diagram for Task:
Inheritance graph
Collaboration diagram for Task:
Collaboration graph

Public Member Functions

 Task (char const *name, void(*taskfun)(void *), TaskPriority priority, unsigned portSHORT stackDepth, void *parm=0)
 Constructor. More...
 
virtual ~Task ()
 Destructor. More...
 

Public Attributes

TaskHandle_t handle
 Handle for the task we are managing. More...
 

Detailed Description

Lowest Level Wrapper. Create the specified task with a provided task function.

If the Task object is destroyed, the class will be deleted (if deletion has been enabled)

Todo:
Look at adding member functions for task manipulation

Constructor & Destructor Documentation

Task::Task ( char const *  name,
void(*)(void *)  taskfun,
TaskPriority  priority,
unsigned portSHORT  stackDepth,
void *  parm = 0 
)
inline

Constructor.

Parameters
nameThe name of the task.
taskfunThe function implementing the task, should have type void (*taskfun)(void *)
priorityThe priority of the task. Use the TaskPriority enum values or a related value converted to a TaskPriority
stackDepthSize of the stack to give to the task
parmthe parameter passed to taskFun. Defaults to NULL.

Upon construction the task will be created.

virtual Task::~Task ( )
inlinevirtual

Destructor.

If deletion is enabled, delete the task.

Member Data Documentation

TaskHandle_t Task::handle

Handle for the task we are managing.


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