Task Handler

System for registering different tasks that will be called regularly, one after another. More...

Files
file	tasks.h
	Task API Header.
file	tasks.c
	Task API Implementation.

Data Structures
struct	TaskElement
	Single-Linked Task List. More...

Typedefs
typedef void(*	Task )(void)
	A Task has no arguments and returns nothing. More...

Functions
uint8_t	addTask (Task func)
	Adds another task that will be called regularly. More...
uint8_t	removeTask (Task func)
	Removes an already registered Task. More...
void	tasks (void)
	Executes registered Tasks. More...
uint8_t	tasksRegistered (void)
	Get the number of registered Tasks. More...

Variables
TaskElement *	taskList
	List of registered Tasks. More...
TaskElement *	taskList = NULL
	List of registered Tasks. More...

Detailed Description

System for registering different tasks that will be called regularly, one after another.

Typedef Documentation

typedef void(* Task)(void)

A Task has no arguments and returns nothing.

Definition at line 44 of file tasks.h.

Function Documentation

uint8_t addTask

(

Task

func

)

Adds another task that will be called regularly.

Parameters

func	Task to be executed

Returns

0 on success

Examples:

hardwareTest.c, and uartFlight.c.

Definition at line 57 of file tasks.c.

References BANK_GENERIC, MEMSWITCH, MEMSWITCHBACK, TaskElement::next, TaskElement::task, and taskList.

Referenced by xyInit().

                           {
    MEMSWITCH(BANK_GENERIC);
    TaskElement *p = (TaskElement *)malloc(sizeof(TaskElement));
    if (p == NULL) {
        MEMSWITCHBACK(BANK_GENERIC);
        return 1;
    }
    p->task = func;
    p->next = taskList;
    taskList = p;
    MEMSWITCHBACK(BANK_GENERIC);
    return 0;
}

uint8_t removeTask

(

Task

func

)

Removes an already registered Task.

Parameters

func	Task to be removed

Returns

0 on success

Definition at line 71 of file tasks.c.

References BANK_GENERIC, MEMSWITCH, MEMSWITCHBACK, TaskElement::next, TaskElement::task, and taskList.

                              {
    MEMSWITCH(BANK_GENERIC);
    TaskElement *p = taskList;
    TaskElement *prev = NULL;
    while (p != NULL) {
        if (p->task == func) {
            if (prev == NULL) {
                taskList = p->next;
            } else {
                prev->next = p->next;
            }
            free(p);
            MEMSWITCHBACK(BANK_GENERIC);
            return 0;
        }
        prev = p;
        p = p->next;
    }
    MEMSWITCHBACK(BANK_GENERIC);
    return 1;
}

void tasks

(

void

)

Executes registered Tasks.

Call this in your Main Loop!

Examples:

hardwareTest.c, test.c, and uartFlight.c.

Definition at line 93 of file tasks.c.

References BANK_GENERIC, MEMSWITCH, MEMSWITCHBACK, TaskElement::next, TaskElement::task, and taskList.

                 {
    MEMSWITCH(BANK_GENERIC);
    static TaskElement *p = NULL;
    if (p == NULL) {
        p = taskList;
    }
    if (p != NULL) {
        p->task();
        p = p->next;
    }
    MEMSWITCHBACK(BANK_GENERIC);
}

uint8_t tasksRegistered

(

void

)

Get the number of registered Tasks.

Returns

Count of registered Tasks

Definition at line 47 of file tasks.c.

References BANK_GENERIC, MEMSWITCH, MEMSWITCHBACK, and TaskElement::next.

                              {
    uint8_t c = 0;
    MEMSWITCH(BANK_GENERIC);
    for (TaskElement *p = taskList; p != NULL; p = p->next) {
        c++;
    }
    MEMSWITCHBACK(BANK_GENERIC);
    return c;
}

Variable Documentation

TaskElement* taskList = NULL

List of registered Tasks.

Definition at line 45 of file tasks.c.

Referenced by addTask(), removeTask(), and tasks().

TaskElement* taskList

List of registered Tasks.

Definition at line 45 of file tasks.c.

Referenced by addTask(), removeTask(), and tasks().