docs: rebuild Threading API content
This commit is contained in:
@@ -1,31 +1,36 @@
|
||||
# TaskSystem::Wait
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
等待指定任务完成。
|
||||
|
||||
```cpp
|
||||
void Wait(uint64_t taskId);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Threading/TaskSystem.h`,当前页面用于固定 `TaskSystem` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:**
|
||||
- `taskId` - 参数语义详见头文件声明。
|
||||
当前实现是一个空函数体,参数 `taskId` 也没有被使用。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
## 参数
|
||||
|
||||
**示例:**
|
||||
- `taskId` - 目标任务 ID。
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Threading/TaskSystem.h>
|
||||
## 返回值
|
||||
|
||||
void Example() {
|
||||
XCEngine::Threading::TaskSystem object;
|
||||
// 根据上下文补齐参数后调用 TaskSystem::Wait(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 无。
|
||||
|
||||
## 当前实现限制
|
||||
|
||||
- 当前不会阻塞。
|
||||
- 当前不会轮询任务状态。
|
||||
- 当前不会配合条件变量、future 或任务组做任何同步。
|
||||
|
||||
## 使用建议
|
||||
|
||||
- 当前不要依赖这个接口实现任务完成等待。
|
||||
- 如果后续要把它补成可用接口,至少需要有一个以任务 ID 为键的完成状态表或句柄系统。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](TaskSystem.md)
|
||||
- [返回模块目录](../Threading.md)
|
||||
- [返回类型总览](TaskSystem.md)
|
||||
- [Submit](Submit.md)
|
||||
- [TaskGroup::Wait](../TaskGroup/Wait.md)
|
||||
|
||||
Reference in New Issue
Block a user