Os::Task::TaskRoutineWrapper Class Reference

Wrapper for task routine that ensures onStart() is called once the task actually begins. More...

#include <Os/Task.hpp>

Public Member Functions
	TaskRoutineWrapper (Task &self)
void	invoke ()
	invoke the run method with "self" as argument More...

Static Public Member Functions
static void	run (void *task_pointer)
	run the task routine wrapper More...

Public Attributes
Task &	m_task
	Reference to owning task. More...
taskRoutine	m_user_function = nullptr
	User function to run once started. More...
void *	m_user_argument = nullptr
	Argument to user function. More...

Detailed Description

Wrapper for task routine that ensures onStart() is called once the task actually begins.

Definition at line 199 of file Task.hpp.

Constructor & Destructor Documentation

TaskRoutineWrapper()

Os::Task::TaskRoutineWrapper::TaskRoutineWrapper ( Task &  self )

explicit

Definition at line 25 of file Task.cpp.

Member Function Documentation

invoke()

void Os::Task::TaskRoutineWrapper::invoke

(

)

invoke the run method with "self" as argument

Definition at line 48 of file Task.cpp.

run()

void Os::Task::TaskRoutineWrapper::run ( void *  task_pointer )

static

run the task routine wrapper

Sets the Os::Task to started via the setStarted method. Then runs the user function passing in the user argument.

Parameters

task_pointer

pointer to TaskRoutineWrapper being run

Definition at line 27 of file Task.cpp.

Member Data Documentation

m_task

Task& Os::Task::TaskRoutineWrapper::m_task

Reference to owning task.

Definition at line 213 of file Task.hpp.

m_user_argument

void* Os::Task::TaskRoutineWrapper::m_user_argument = nullptr

Argument to user function.

Definition at line 215 of file Task.hpp.

m_user_function

taskRoutine Os::Task::TaskRoutineWrapper::m_user_function = nullptr

User function to run once started.

Definition at line 214 of file Task.hpp.

---

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

• Os/Task.hpp
• Os/Task.cpp