awtk/docs/manual/async_t.md

70 lines
1.7 KiB
Markdown
Raw Normal View History

2020-03-17 10:48:59 +08:00
## async\_t
### 概述
异步请求。
----------------------------------
### 函数
<p id="async_t_methods">
| 函数名称 | 说明 |
| -------- | ------------ |
| <a href="#async_t_async_call">async\_call</a> | 异步执行exec函数执行完成后在后台线程调用on_result函数。 |
| <a href="#async_t_async_call_deinit">async\_call\_deinit</a> | 全局~初始化。 |
| <a href="#async_t_async_call_init">async\_call\_init</a> | 全局初始化。 |
#### async\_call 函数
-----------------------
* 函数功能:
> <p id="async_t_async_call">异步执行exec函数执行完成后在后台线程调用on_result函数。
* 函数原型:
```
ret_t async_call (async_exec_t exec, async_on_result_t on_result, void* ctx);
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
| exec | async\_exec\_t | 需要异步支持的函数。 |
| on\_result | async\_on\_result\_t | 返回执行结果(可选) |
| ctx | void* | 两个回调函数的上下文。 |
#### async\_call\_deinit 函数
-----------------------
* 函数功能:
> <p id="async_t_async_call_deinit">全局~初始化。
* 函数原型:
```
ret_t async_call_deinit ();
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |
#### async\_call\_init 函数
-----------------------
* 函数功能:
> <p id="async_t_async_call_init">全局初始化。
* 函数原型:
```
ret_t async_call_init ();
```
* 参数说明:
| 参数 | 类型 | 说明 |
| -------- | ----- | --------- |
| 返回值 | ret\_t | 返回RET\_OK表示成功否则表示失败。 |