summaryrefslogtreecommitdiffstats
path: root/src/task.c
diff options
context:
space:
mode:
authorMatthias Schiffer <mschiffer@universe-factory.net>2015-11-10 22:00:15 +0100
committerMatthias Schiffer <mschiffer@universe-factory.net>2015-11-10 22:00:15 +0100
commitbb761bafb89a734fdc98a8e12cfff3b0c16fb0af (patch)
treea517db07dfca3e9734ce4d6d3443377598f8a792 /src/task.c
parentc5aeb0dc4228c6396f35395194e0ec9cc91519c4 (diff)
downloadfastd-bb761bafb89a734fdc98a8e12cfff3b0c16fb0af.tar
fastd-bb761bafb89a734fdc98a8e12cfff3b0c16fb0af.zip
Add lots of missing doxygen comments
Diffstat (limited to 'src/task.c')
-rw-r--r--src/task.c4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/task.c b/src/task.c
index 44a8ebf..aa6225a 100644
--- a/src/task.c
+++ b/src/task.c
@@ -41,6 +41,7 @@ static inline void maintenance(void) {
fastd_task_reschedule_relative(&ctx.next_maintenance, MAINTENANCE_INTERVAL);
}
+/** Handles one task */
static void handle_task(void) {
fastd_task_t *task = container_of(ctx.task_queue, fastd_task_t, entry);
fastd_pqueue_remove(ctx.task_queue);
@@ -59,16 +60,19 @@ static void handle_task(void) {
}
}
+/** Handles all tasks whose timeout has been reached */
void fastd_task_handle(void) {
while (ctx.task_queue && fastd_timed_out(ctx.task_queue->value))
handle_task();
}
+/** Puts a task back into the queue with a new timeout */
void fastd_task_reschedule(fastd_task_t *task, fastd_timeout_t timeout) {
task->entry.value = timeout;
fastd_pqueue_insert(&ctx.task_queue, &task->entry);
}
+/** Gets the timeout of the next task (if any) */
bool fastd_task_timeout(fastd_timeout_t *timeout) {
if (!ctx.task_queue)
return false;