TaskCPP.h File Reference

FreeRTOS Task Wrapper. More...

#include "FreeRTOScpp.h"

Include dependency graph for TaskCPP.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	TaskBase
	Lowest Level Wrapper. More...
class	TaskClassBase
	Dynamically Created Task Wrapper. More...
class	TaskClassS< stackDepth >
	Make a class based task. More...
class	TaskS< stackDepth >
	Statically Created Task Wrapper. More...

Enumerations
enum	TaskPriority {   TaskPrio_Idle = 0 , TaskPrio_Low = ((configMAX_PRIORITIES)>1) , TaskPrio_HMI = (TaskPrio_Low + ((configMAX_PRIORITIES)>5)) , TaskPrio_Mid = ((configMAX_PRIORITIES)/2) ,   TaskPrio_High = ((configMAX_PRIORITIES)-1-((configMAX_PRIORITIES)>4)) , TaskPrio_Highest = ((configMAX_PRIORITIES)-1) }
	Names for Base set of Priorities. More...

Functions
constexpr TaskPriority	operator+ (TaskPriority p, int offset)
	Allow adjment to Task Priority.
constexpr TaskPriority	operator- (TaskPriority p, int offset)
	Allow adjment to Task Priority.
void	taskcpp_task_thunk (void *)
	Thunk for FreeRTOS to C++ Task Wrapper.

Detailed Description

FreeRTOS Task Wrapper.

This file contains a set of lightweight wrappers for tasks using FreeRTOS

Copyright

(c) 2007-2024 Richard Damon

Author

Richard Damon richa.nosp@m.rd.d.nosp@m.amon@.nosp@m.gmai.nosp@m.l.com

MIT License:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

It is requested (but not required by license) that any bugs found or improvements made be shared, preferably to the author.

Tasks are built with a selction of options:

Task Function Type:

• Simple void fun(void* parm);
• task memberfuncion of a derived class

TasK Allocation:

• Static (specified by a template parameter)
• Dynamic (specified by that template parameter being 0)

• Static with suppied stack

  Todo

  Look at options to create "restricted" tasks with xTaskCreateRestricted Basically needs another parrallel construciton of this tree.

Function Documentation

operator+()

TaskPriority operator+ ( TaskPriority p, int offset )

constexpr

Allow adjment to Task Priority.

Mostly for configMAX_PRIORITIES > 6

operator-()

TaskPriority operator- ( TaskPriority p, int offset )

constexpr

Allow adjment to Task Priority.

Mostly for configMAX_PRIORITIES > 6

taskcpp_task_thunk()

void taskcpp_task_thunk ( void * parm )

extern

Thunk for FreeRTOS to C++ Task Wrapper.

References TaskBase::take(), and TaskClassBase::task().

Here is the call graph for this function: