test/awtk
1
0
Fork 0
mirror of https://gitee.com/zlgopen/awtk.git synced 2024-11-30 02:58:26 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
fd32a94a54
awtk/docs/manual/timer_manager_t.md

434 lines
14 KiB
Markdown
Raw Normal View History

regenerate docs
2019-11-14 15:54:03 +08:00
## timer\_manager\_t
### 概述
update docs
2019-11-15 11:33:43 +08:00
定时器管理器。
regenerate docs
2019-11-14 15:54:03 +08:00
----------------------------------
### 函数
<p id="timer_manager_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
update docs
2019-11-15 10:00:42 +08:00
| <a href="#timer_manager_t_timer_manager">timer\_manager</a> | 获取缺省的定时器管理器。 |
| <a href="#timer_manager_t_timer_manager_add">timer\_manager\_add</a> | 添加定时器。 |
regen docs
2022-12-05 12:10:53 +08:00
| <a href="#timer_manager_t_timer_manager_add_with_id">timer\_manager\_add\_with\_id</a> | 添加定时器。（可以指定 timer_id ，如果发现 timer_id 冲突则添加失败）。 |
update api docs
2023-06-29 10:44:29 +08:00
| <a href="#timer_manager_t_timer_manager_add_with_type">timer\_manager\_add\_with\_type</a> | 添加对应类型的定时器。 |
| <a href="#timer_manager_t_timer_manager_add_with_type_and_id">timer\_manager\_add\_with\_type\_and\_id</a> | 添加对应类型和id的定时器。 |
update docs
2021-05-11 15:53:22 +08:00
| <a href="#timer_manager_t_timer_manager_all_remove_by_ctx">timer\_manager\_all\_remove\_by\_ctx</a> | 根据上下文删除所有对应的定时器。 |
update api docs
2023-06-29 10:44:29 +08:00
| <a href="#timer_manager_t_timer_manager_all_remove_by_ctx_and_type">timer\_manager\_all\_remove\_by\_ctx\_and\_type</a> | 移除对应类型和上下文的所有定时器。 |
update docs
2019-11-15 10:00:42 +08:00
| <a href="#timer_manager_t_timer_manager_append">timer\_manager\_append</a> | 追加定时器。 |
| <a href="#timer_manager_t_timer_manager_count">timer\_manager\_count</a> | 返回定时器的个数。 |
| <a href="#timer_manager_t_timer_manager_create">timer\_manager\_create</a> | 创建定时器管理器。 |
| <a href="#timer_manager_t_timer_manager_deinit">timer\_manager\_deinit</a> | 析构定时器管理器。 |
| <a href="#timer_manager_t_timer_manager_destroy">timer\_manager\_destroy</a> | 析构并释放定时器管理器。 |
update docs
2021-08-03 07:53:37 +08:00
| <a href="#timer_manager_t_timer_manager_dispatch">timer\_manager\_dispatch</a> | 检查全部定时器的函数，如果时间到期，调用相应的timer函数。 |
update docs
2019-11-15 10:00:42 +08:00
| <a href="#timer_manager_t_timer_manager_find">timer\_manager\_find</a> | 查找指定ID的定时器。 |
regen docs
2022-12-05 12:10:53 +08:00
| <a href="#timer_manager_t_timer_manager_get_next_timer_id">timer\_manager\_get\_next\_timer\_id</a> | 获取下一个可用的 timer_id。 |
update docs
2019-11-15 10:00:42 +08:00
| <a href="#timer_manager_t_timer_manager_init">timer\_manager\_init</a> | 初始化定时器管理器。 |
update docs
2023-12-26 20:05:44 +08:00
| <a href="#timer_manager_t_timer_manager_next_time">timer\_manager\_next\_time</a> | 返回最近的定时器到期时间(毫秒)。 |
update docs
2019-11-15 10:00:42 +08:00
| <a href="#timer_manager_t_timer_manager_remove">timer\_manager\_remove</a> | 根据id删除定时器。 |
| <a href="#timer_manager_t_timer_manager_reset">timer\_manager\_reset</a> | 重置定时器。 |
| <a href="#timer_manager_t_timer_manager_set">timer\_manager\_set</a> | 设置缺省的定时器管理器。 |
regenerate docs
2019-11-14 15:54:03 +08:00
#### timer\_manager 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="timer_manager_t_timer_manager">获取缺省的定时器管理器。
regenerate docs
2019-11-14 15:54:03 +08:00
* 函数原型：
```
timer_manager_t* timer_manager ();
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
update docs
2019-11-15 10:00:42 +08:00
| 返回值 | timer\_manager\_t* | 返回定时器管理器对象。 |
regenerate docs
2019-11-14 15:54:03 +08:00
#### timer\_manager\_add 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="timer_manager_t_timer_manager_add">添加定时器。
regenerate docs
2019-11-14 15:54:03 +08:00
* 函数原型：
```
update api docs
2023-06-29 10:44:29 +08:00
uint32_t timer_manager_add (timer_manager_t* timer_manager, timer_func_t on_timer, void* ctx, uint32_t duration);
regenerate docs
2019-11-14 15:54:03 +08:00
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | uint32\_t | 返回timer的ID，TK\_INVALID\_ID表示失败。 |
update docs
2019-11-15 10:00:42 +08:00
| timer\_manager | timer\_manager\_t* | 定时器管理器对象。 |
update api docs
2023-06-29 10:44:29 +08:00
| on\_timer | timer\_func\_t | timer回调函数。 |
regenerate docs
2019-11-14 15:54:03 +08:00
| ctx | void* | timer回调函数的上下文。 |
update docs
2023-12-26 20:05:44 +08:00
| duration | uint32\_t | 时间(毫秒)。 |
regen docs
2022-12-05 12:10:53 +08:00
#### timer\_manager\_add\_with\_id 函数
-----------------------
* 函数功能：
> <p id="timer_manager_t_timer_manager_add_with_id">添加定时器。（可以指定 timer_id ，如果发现 timer_id 冲突则添加失败）。
* 函数原型：
```
update api docs
2023-06-29 10:44:29 +08:00
uint32_t timer_manager_add_with_id (timer_manager_t* timer_manager, uint32_t id, timer_func_t on_timer, void* ctx, uint32_t duration);
regen docs
2022-12-05 12:10:53 +08:00
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | uint32\_t | 返回timer的ID，TK\_INVALID\_ID表示失败。 |
| timer\_manager | timer\_manager\_t* | 定时器管理器对象。 |
| id | uint32\_t | timer\_id。 |
update api docs
2023-06-29 10:44:29 +08:00
| on\_timer | timer\_func\_t | timer回调函数。 |
regen docs
2022-12-05 12:10:53 +08:00
| ctx | void* | timer回调函数的上下文。 |
update docs
2023-12-26 20:05:44 +08:00
| duration | uint32\_t | 时间(毫秒)。 |
update api docs
2023-06-29 10:44:29 +08:00
#### timer\_manager\_add\_with\_type 函数
-----------------------
* 函数功能：
> <p id="timer_manager_t_timer_manager_add_with_type">添加对应类型的定时器。
* 函数原型：
```
uint32_t timer_manager_add_with_type (timer_manager_t* timer_manager, timer_func_t on_timer, void* ctx, uint32_t duration, uint16_t timer_info_type);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | uint32\_t | 返回定时器id。 |
| timer\_manager | timer\_manager\_t* | 定时器管理器对象。 |
| on\_timer | timer\_func\_t | 定时器回调函数。 |
| ctx | void* | 上下文。 |
update docs
2023-12-26 20:05:44 +08:00
| duration | uint32\_t | 时间(毫秒)。 |
update api docs
2023-06-29 10:44:29 +08:00
| timer\_info\_type | uint16\_t | timer\_info\_type。 |
#### timer\_manager\_add\_with\_type\_and\_id 函数
-----------------------
* 函数功能：
> <p id="timer_manager_t_timer_manager_add_with_type_and_id">添加对应类型和id的定时器。
* 函数原型：
```
uint32_t timer_manager_add_with_type_and_id (timer_manager_t* timer_manager, uint32_t id, timer_func_t on_timer, void* ctx, uint32_t duration, uint16_t timer_info_type, bool_t is_check_id);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | uint32\_t | 返回定时器id。 |
| timer\_manager | timer\_manager\_t* | 定时器管理器对象。 |
| id | uint32\_t | id。 |
| on\_timer | timer\_func\_t | 定时器回调函数。 |
| ctx | void* | 上下文。 |
update docs
2023-12-26 20:05:44 +08:00
| duration | uint32\_t | 时间(毫秒)。 |
update api docs
2023-06-29 10:44:29 +08:00
| timer\_info\_type | uint16\_t | timer\_info\_type。 |
| is\_check\_id | bool\_t | 是否校验id。 |
update docs
2021-05-11 15:53:22 +08:00
#### timer\_manager\_all\_remove\_by\_ctx 函数
-----------------------
* 函数功能：
> <p id="timer_manager_t_timer_manager_all_remove_by_ctx">根据上下文删除所有对应的定时器。
* 函数原型：
```
ret_t timer_manager_all_remove_by_ctx (timer_manager_t* timer_manager, void* ctx);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| timer\_manager | timer\_manager\_t* | 定时器管理器对象。 |
| ctx | void* | timer回调函数的上下文。 |
update api docs
2023-06-29 10:44:29 +08:00
#### timer\_manager\_all\_remove\_by\_ctx\_and\_type 函数
-----------------------
* 函数功能：
> <p id="timer_manager_t_timer_manager_all_remove_by_ctx_and_type">移除对应类型和上下文的所有定时器。
* 函数原型：
```
ret_t timer_manager_all_remove_by_ctx_and_type (timer_manager_t* timer_manager, uint16_t type, void* ctx);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
| timer\_manager | timer\_manager\_t* | 定时器管理器对象。 |
| type | uint16\_t | 类型。 |
| ctx | void* | 上下文。 |
regenerate docs
2019-11-14 15:54:03 +08:00
#### timer\_manager\_append 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="timer_manager_t_timer_manager_append">追加定时器。
regenerate docs
2019-11-14 15:54:03 +08:00
* 函数原型：
```
ret_t timer_manager_append (timer_manager_t* timer_manager, timer_info_t* timer);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
update docs
2019-11-15 10:00:42 +08:00
| timer\_manager | timer\_manager\_t* | 定时器管理器对象。。 |
regenerate docs
2019-11-14 15:54:03 +08:00
| timer | timer\_info\_t* | timer对象。 |
#### timer\_manager\_count 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="timer_manager_t_timer_manager_count">返回定时器的个数。
regenerate docs
2019-11-14 15:54:03 +08:00
* 函数原型：
```
uint32_t timer_manager_count (timer_manager_t* timer_manager);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | uint32\_t | 返回timer的个数。 |
update docs
2019-11-15 10:00:42 +08:00
| timer\_manager | timer\_manager\_t* | 定时器管理器对象。 |
regenerate docs
2019-11-14 15:54:03 +08:00
#### timer\_manager\_create 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="timer_manager_t_timer_manager_create">创建定时器管理器。
regenerate docs
2019-11-14 15:54:03 +08:00
* 函数原型：
```
timer_manager_t* timer_manager_create (timer_get_time_t get_time);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
update docs
2019-11-15 10:00:42 +08:00
| 返回值 | timer\_manager\_t* | 返回定时器管理器对象。 |
regenerate docs
2019-11-14 15:54:03 +08:00
| get\_time | timer\_get\_time\_t | 获取当前时间的函数。 |
#### timer\_manager\_deinit 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="timer_manager_t_timer_manager_deinit">析构定时器管理器。
regenerate docs
2019-11-14 15:54:03 +08:00
* 函数原型：
```
ret_t timer_manager_deinit (timer_manager_t* timer_manager);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
update docs
2019-11-15 10:00:42 +08:00
| timer\_manager | timer\_manager\_t* | 定时器管理器对象。 |
regenerate docs
2019-11-14 15:54:03 +08:00
#### timer\_manager\_destroy 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="timer_manager_t_timer_manager_destroy">析构并释放定时器管理器。
regenerate docs
2019-11-14 15:54:03 +08:00
* 函数原型：
```
ret_t timer_manager_destroy (timer_manager_t* timer_manager);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
update docs
2019-11-15 10:00:42 +08:00
| timer\_manager | timer\_manager\_t* | 定时器管理器对象。 |
update docs
2021-08-03 07:53:37 +08:00
#### timer\_manager\_dispatch 函数
-----------------------
* 函数功能：
> <p id="timer_manager_t_timer_manager_dispatch">检查全部定时器的函数，如果时间到期，调用相应的timer函数。
* 函数原型：
```
update api docs
2023-06-29 10:44:29 +08:00
ret_t timer_manager_dispatch (timer_manager_t* timer_manager);
update docs
2021-08-03 07:53:37 +08:00
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
update api docs
2023-06-29 10:44:29 +08:00
| timer\_manager | timer\_manager\_t* | 定时器管理器对象。 |
regenerate docs
2019-11-14 15:54:03 +08:00
#### timer\_manager\_find 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="timer_manager_t_timer_manager_find">查找指定ID的定时器。
regenerate docs
2019-11-14 15:54:03 +08:00
* 函数原型：
```
update api docs
2023-06-29 10:44:29 +08:00
const timer_info_t* timer_manager_find (timer_manager_t* timer_manager, uint32_t timer_id);
regenerate docs
2019-11-14 15:54:03 +08:00
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
update api docs
2023-06-29 10:44:29 +08:00
| 返回值 | const timer\_info\_t* | 返回timer的信息。 |
update docs
2019-11-15 10:00:42 +08:00
| timer\_manager | timer\_manager\_t* | 定时器管理器对象。 |
regenerate docs
2019-11-14 15:54:03 +08:00
| timer\_id | uint32\_t | timer\_id |
regen docs
2022-12-05 12:10:53 +08:00
#### timer\_manager\_get\_next\_timer\_id 函数
-----------------------
* 函数功能：
> <p id="timer_manager_t_timer_manager_get_next_timer_id">获取下一个可用的 timer_id。
* 函数原型：
```
uint32_t timer_manager_get_next_timer_id (timer_manager_t* timer_manager);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | uint32\_t | 返回idle的ID，TK\_INVALID\_ID表示失败。 |
update api docs
2023-06-29 10:44:29 +08:00
| timer\_manager | timer\_manager\_t* | 定时器管理器对象。 |
regenerate docs
2019-11-14 15:54:03 +08:00
#### timer\_manager\_init 函数
-----------------------
* 函数功能：
update docs
2019-11-15 11:33:43 +08:00
> <p id="timer_manager_t_timer_manager_init">初始化定时器管理器。
regenerate docs
2019-11-14 15:54:03 +08:00
* 函数原型：
```
timer_manager_t* timer_manager_init (timer_manager_t* timer_manager, timer_get_time_t get_time);
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
update docs
2019-11-15 10:00:42 +08:00
| 返回值 | timer\_manager\_t* | 返回定时器管理器对象。 |
| timer\_manager | timer\_manager\_t* | 定时器管理器对象。 |
regenerate docs
2019-11-14 15:54:03 +08:00
| get\_time | timer\_get\_time\_t | 获取当前时间的函数。 |
update docs
2020-05-24 19:28:22 +08:00
#### timer\_manager\_next\_time 函数
regenerate docs
2019-11-14 15:54:03 +08:00
-----------------------
* 函数功能：
update docs
2023-12-26 20:05:44 +08:00
> <p id="timer_manager_t_timer_manager_next_time">返回最近的定时器到期时间(毫秒)。
regenerate docs
2019-11-14 15:54:03 +08:00
* 函数原型：
```
update docs
2020-05-24 19:28:22 +08:00
uint64_t timer_manager_next_time (timer_manager_t* timer_manager);
regenerate docs
2019-11-14 15:54:03 +08:00
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
update docs
2023-12-26 20:05:44 +08:00
| 返回值 | uint64\_t | 返回最近的timer到期时间(毫秒)。 |
update docs
2019-11-15 10:00:42 +08:00
| timer\_manager | timer\_manager\_t* | 定时器管理器对象。 |
update docs
2020-05-24 19:28:22 +08:00
#### timer\_manager\_remove 函数
regenerate docs
2019-11-14 15:54:03 +08:00
-----------------------
* 函数功能：
update docs
2020-05-24 19:28:22 +08:00
> <p id="timer_manager_t_timer_manager_remove">根据id删除定时器。
regenerate docs
2019-11-14 15:54:03 +08:00
* 函数原型：
```
update docs
2020-05-24 19:28:22 +08:00
ret_t timer_manager_remove (timer_manager_t* timer_manager, uint32_t timer_id);
regenerate docs
2019-11-14 15:54:03 +08:00
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
update docs
2019-11-15 10:00:42 +08:00
| timer\_manager | timer\_manager\_t* | 定时器管理器对象。 |
update docs
2020-05-24 19:28:22 +08:00
| timer\_id | uint32\_t | timer\_id。 |
#### timer\_manager\_reset 函数
regenerate docs
2019-11-14 15:54:03 +08:00
-----------------------
* 函数功能：
update docs
2020-05-24 19:28:22 +08:00
> <p id="timer_manager_t_timer_manager_reset">重置定时器。
regenerate docs
2019-11-14 15:54:03 +08:00
* 函数原型：
```
update api docs
2023-06-29 10:44:29 +08:00
ret_t timer_manager_reset (timer_manager_t* timer_manager, uint32_t timer_id);
regenerate docs
2019-11-14 15:54:03 +08:00
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
update docs
2020-05-24 19:28:22 +08:00
| timer\_manager | timer\_manager\_t* | 定时器管理器对象。 |
update api docs
2023-06-29 10:44:29 +08:00
| timer\_id | uint32\_t | timer\_id。 |
update docs
2020-05-24 19:28:22 +08:00
#### timer\_manager\_set 函数
regenerate docs
2019-11-14 15:54:03 +08:00
-----------------------
* 函数功能：
update docs
2020-05-24 19:28:22 +08:00
> <p id="timer_manager_t_timer_manager_set">设置缺省的定时器管理器。
regenerate docs
2019-11-14 15:54:03 +08:00
* 函数原型：
```
update api docs
2023-06-29 10:44:29 +08:00
ret_t timer_manager_set (timer_manager_t* timer_manager);
regenerate docs
2019-11-14 15:54:03 +08:00
```
* 参数说明：
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功，否则表示失败。 |
update api docs
2023-06-29 10:44:29 +08:00
| timer\_manager | timer\_manager\_t* | 定时器管理器对象。 |
Reference in New Issue Copy Permalink