hal_os_task.h

Go to the documentation of this file.

#ifndef HAL_OS_TASK_H
#define HAL_OS_TASK_H

#include <stddef.h>
#include <stdbool.h>


typedef int (*OSTaskFunction)(void* arg);

typedef enum {
    HAL_OSTASK_PRIORITY_NORMAL = 0,
    HAL_OSTASK_PRIORITY_LOWEST,
    HAL_OSTASK_PRIORITY_LOW,
    HAL_OSTASK_PRIORITY_HIGH,
    HAL_OSTASK_PRIORITY_HIGHEST,
} OSTaskPriority;

#define HAL_OSTASK_BASIC        0
#define HAL_OSTASK_JOINABLE     1
#define HAL_OSTASK_MORTAL       2
#define HAL_OSTASK_SLEEPY       4

struct OSTaskDesc;
typedef struct OSTaskDesc* OSTask;

OSTask OSTASK_Create(OSTaskFunction taskFunc, int features, OSTaskPriority priority, size_t stack_size, void* arg);

bool OSTASK_IsValid(OSTask task);

bool OSTASK_IsJoinable(OSTask task);

bool OSTASK_IsMortal(OSTask task);

bool OSTASK_IsSleepy(OSTask task);

bool OSTASK_Join(OSTask task, OSTime timeout, int* result);

void OSTASK_Kill(OSTask task);

bool OSTASK_IsAlive();

void OSTASK_Wakeup(OSTask task);

bool OSTASK_SleepIfNotWoken(OSTime maxSleepTime);

void OSTASK_Destroy(OSTask task);

bool OSTASK_Suspend(OSTask task);

bool OSTASK_Resume(OSTask task);

void OSTASK_Yield(void);

OSTaskPriority OSTASK_GetPriority(OSTask task);

bool OSTASK_SetPriority(OSTask task, OSTaskPriority priority);

OSTask OSTASK_GetCurrentTask(void);

#endif // HAL_OS_TASK_H