task_scheduler.h

Go to the documentation of this file.

#ifndef HAWKTRACER_TASK_SCHEDULER_H
#define HAWKTRACER_TASK_SCHEDULER_H

#include <hawktracer/base_types.h>

HT_DECLS_BEGIN

typedef HT_Boolean(*HT_TaskCallback)(void* user_data);
typedef int32_t HT_TaskId;
#define HT_TASK_SCHEDULER_INVALID_TASK_ID ((HT_TaskId)-1)

typedef enum
{
    HT_TASK_SCHEDULING_IGNORE_DELAYS,
    HT_TASK_SCHEDULING_RESTART_TIMER
} HT_TaskSchedulingMode;

typedef struct _HT_TaskScheduler HT_TaskScheduler;

HT_API HT_TaskScheduler* ht_task_scheduler_create(HT_ErrorCode* out_err);

HT_API void ht_task_scheduler_destroy(HT_TaskScheduler* task_scheduler);

HT_API HT_TaskId ht_task_scheduler_schedule_task(HT_TaskScheduler* task_scheduler,
                                                 HT_TaskSchedulingMode mode,
                                                 HT_DurationNs period,
                                                 HT_TaskCallback callback,
                                                 void* user_data);

HT_API HT_Boolean ht_task_scheduler_remove_task(HT_TaskScheduler* task_scheduler, HT_TaskId task_id);

HT_API void ht_task_scheduler_tick(HT_TaskScheduler* task_scheduler);

HT_API HT_DurationNs ht_task_scheduler_get_optimal_tick_period(HT_TaskScheduler* task_scheduler);

HT_DECLS_END

#endif /* HAWKTRACER_TASK_SCHEDULER_H */