Stefan Scholz / ETL
Embed: (wiki syntax)

« Back to documentation index

task Class Reference

task Class Reference

Scheduler. More...

#include <task.h>

Public Member Functions

 task (task_priority_t priority)
 Constructor.
virtual ~task ()
 Destructor.
virtual uint32_t task_request_work () const =0
 Called to check if the task has work.
virtual void task_process_work ()=0
 Called to get the task to do work.
void set_task_running (bool task_running_)
 Set the running state for the task.
bool task_is_running () const
 Get the running state for the task.
etl::task_priority_t get_task_priority () const
 Get the priority of the task.

Detailed Description

Scheduler.

Definition at line 61 of file task.h.


Constructor & Destructor Documentation

task ( task_priority_t  priority )

Constructor.

Definition at line 68 of file task.h.

virtual ~task (  ) [virtual]

Destructor.

Definition at line 77 of file task.h.


Member Function Documentation

etl::task_priority_t get_task_priority (  ) const

Get the priority of the task.

Higher value = higher priority.

Definition at line 112 of file task.h.

void set_task_running ( bool  task_running_ )

Set the running state for the task.

Definition at line 95 of file task.h.

bool task_is_running (  ) const

Get the running state for the task.

Definition at line 103 of file task.h.

virtual void task_process_work (  ) [pure virtual]

Called to get the task to do work.

virtual uint32_t task_request_work (  ) const [pure virtual]

Called to check if the task has work.

Returns a score as to the amount of work it has to do.