1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
|
#ifndef AWS_COMMON_TASK_SCHEDULER_H
#define AWS_COMMON_TASK_SCHEDULER_H
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#include <aws/common/common.h>
#include <aws/common/linked_list.h>
#include <aws/common/priority_queue.h>
AWS_PUSH_SANE_WARNING_LEVEL
struct aws_task;
typedef enum aws_task_status {
AWS_TASK_STATUS_RUN_READY,
AWS_TASK_STATUS_CANCELED,
} aws_task_status;
/**
* A scheduled function.
*/
typedef void(aws_task_fn)(struct aws_task *task, void *arg, enum aws_task_status);
/*
* A task object.
* Once added to the scheduler, a task must remain in memory until its function is executed.
*/
struct aws_task {
aws_task_fn *fn;
void *arg;
uint64_t timestamp;
struct aws_linked_list_node node;
struct aws_priority_queue_node priority_queue_node;
const char *type_tag;
/* honor the ABI compat */
union {
bool scheduled;
size_t reserved;
} abi_extension;
};
struct aws_task_scheduler {
struct aws_allocator *alloc;
struct aws_priority_queue timed_queue; /* Tasks scheduled to run at specific times */
struct aws_linked_list timed_list; /* If timed_queue runs out of memory, further timed tests are stored here */
struct aws_linked_list asap_list; /* Tasks scheduled to run as soon as possible */
};
AWS_EXTERN_C_BEGIN
/**
* Init an aws_task
*/
AWS_COMMON_API
void aws_task_init(struct aws_task *task, aws_task_fn *fn, void *arg, const char *type_tag);
/*
* Runs or cancels a task
*/
AWS_COMMON_API
void aws_task_run(struct aws_task *task, enum aws_task_status status);
/**
* Initializes a task scheduler instance.
*/
AWS_COMMON_API
int aws_task_scheduler_init(struct aws_task_scheduler *scheduler, struct aws_allocator *alloc);
/**
* Empties and executes all queued tasks, passing the AWS_TASK_STATUS_CANCELED status to the task function.
* Cleans up any memory allocated, and prepares the instance for reuse or deletion.
*/
AWS_COMMON_API
void aws_task_scheduler_clean_up(struct aws_task_scheduler *scheduler);
AWS_COMMON_API
bool aws_task_scheduler_is_valid(const struct aws_task_scheduler *scheduler);
/**
* Returns whether the scheduler has any scheduled tasks.
* next_task_time (optional) will be set to time of the next task, note that 0 will be set if tasks were
* added via aws_task_scheduler_schedule_now() and UINT64_MAX will be set if no tasks are scheduled at all.
*/
AWS_COMMON_API
bool aws_task_scheduler_has_tasks(const struct aws_task_scheduler *scheduler, uint64_t *next_task_time);
/**
* Schedules a task to run immediately.
* The task should not be cleaned up or modified until its function is executed.
*/
AWS_COMMON_API
void aws_task_scheduler_schedule_now(struct aws_task_scheduler *scheduler, struct aws_task *task);
/**
* Schedules a task to run at time_to_run.
* The task should not be cleaned up or modified until its function is executed.
*/
AWS_COMMON_API
void aws_task_scheduler_schedule_future(
struct aws_task_scheduler *scheduler,
struct aws_task *task,
uint64_t time_to_run);
/**
* Removes task from the scheduler and invokes the task with the AWS_TASK_STATUS_CANCELED status.
*/
AWS_COMMON_API
void aws_task_scheduler_cancel_task(struct aws_task_scheduler *scheduler, struct aws_task *task);
/**
* Sequentially execute all tasks scheduled to run at, or before current_time.
* AWS_TASK_STATUS_RUN_READY will be passed to the task function as the task status.
*
* If a task schedules another task, the new task will not be executed until the next call to this function.
*/
AWS_COMMON_API
void aws_task_scheduler_run_all(struct aws_task_scheduler *scheduler, uint64_t current_time);
/**
* Convert a status value to a c-string suitable for logging
*/
AWS_COMMON_API
const char *aws_task_status_to_c_str(enum aws_task_status status);
AWS_EXTERN_C_END
AWS_POP_SANE_WARNING_LEVEL
#endif /* AWS_COMMON_TASK_SCHEDULER_H */
|
