added doc for linux
This commit is contained in:
parent
b0634ab0a2
commit
dc9ef41bec
@ -8,6 +8,18 @@
|
|||||||
|
|
||||||
class FixedTimeslotTask: public FixedTimeslotTaskIF, public PosixThread {
|
class FixedTimeslotTask: public FixedTimeslotTaskIF, public PosixThread {
|
||||||
public:
|
public:
|
||||||
|
/**
|
||||||
|
* Create a generic periodic task.
|
||||||
|
* @param name_
|
||||||
|
* Name, maximum allowed size of linux is 16 chars, everything else will
|
||||||
|
* be truncated.
|
||||||
|
* @param priority_
|
||||||
|
* Real-time priority, ranges from 1 to 99 for Linux.
|
||||||
|
* See: https://man7.org/linux/man-pages/man7/sched.7.html
|
||||||
|
* @param stackSize_
|
||||||
|
* @param period_
|
||||||
|
* @param deadlineMissedFunc_
|
||||||
|
*/
|
||||||
FixedTimeslotTask(const char* name_, int priority_, size_t stackSize_,
|
FixedTimeslotTask(const char* name_, int priority_, size_t stackSize_,
|
||||||
uint32_t periodMs_);
|
uint32_t periodMs_);
|
||||||
virtual ~FixedTimeslotTask();
|
virtual ~FixedTimeslotTask();
|
||||||
|
@ -9,9 +9,22 @@
|
|||||||
|
|
||||||
class PeriodicPosixTask: public PosixThread, public PeriodicTaskIF {
|
class PeriodicPosixTask: public PosixThread, public PeriodicTaskIF {
|
||||||
public:
|
public:
|
||||||
|
/**
|
||||||
|
* Create a generic periodic task.
|
||||||
|
* @param name_
|
||||||
|
* Name, maximum allowed size of linux is 16 chars, everything else will
|
||||||
|
* be truncated.
|
||||||
|
* @param priority_
|
||||||
|
* Real-time priority, ranges from 1 to 99 for Linux.
|
||||||
|
* See: https://man7.org/linux/man-pages/man7/sched.7.html
|
||||||
|
* @param stackSize_
|
||||||
|
* @param period_
|
||||||
|
* @param deadlineMissedFunc_
|
||||||
|
*/
|
||||||
PeriodicPosixTask(const char* name_, int priority_, size_t stackSize_,
|
PeriodicPosixTask(const char* name_, int priority_, size_t stackSize_,
|
||||||
uint32_t period_, void(*deadlineMissedFunc_)());
|
uint32_t period_, void(*deadlineMissedFunc_)());
|
||||||
virtual ~PeriodicPosixTask();
|
virtual ~PeriodicPosixTask();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @brief The method to start the task.
|
* @brief The method to start the task.
|
||||||
* @details The method starts the task with the respective system call.
|
* @details The method starts the task with the respective system call.
|
||||||
|
Loading…
Reference in New Issue
Block a user