docs: rebuild Threading API content
This commit is contained in:
@@ -1,31 +1,39 @@
|
||||
# TaskGroup::SetCompleteCallback
|
||||
|
||||
设置相关状态或配置。
|
||||
设置任务组完成时要调用的回调函数。
|
||||
|
||||
```cpp
|
||||
void SetCompleteCallback(Callback&& callback);
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Threading/TaskGroup.h`,当前页面用于固定 `TaskGroup` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:**
|
||||
- `callback` - 参数语义详见头文件声明。
|
||||
当前实现仅在持锁状态下把回调保存到 `m_completeCallback`。
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
## 参数
|
||||
|
||||
**示例:**
|
||||
- `callback` - 任务组完成后期望执行的回调。
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Threading/TaskGroup.h>
|
||||
## 返回值
|
||||
|
||||
void Example() {
|
||||
XCEngine::Threading::TaskGroup object;
|
||||
// 根据上下文补齐参数后调用 TaskGroup::SetCompleteCallback(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 无。
|
||||
|
||||
## 当前实现限制
|
||||
|
||||
- 当前没有任何代码路径会真正调用 `m_completeCallback`。
|
||||
- 设置回调不会改变 [Wait](Wait.md)、[IsComplete](IsComplete.md) 或 [GetProgress](GetProgress.md) 的行为。
|
||||
|
||||
## 设计说明
|
||||
|
||||
这类接口在商业引擎里通常用于:
|
||||
|
||||
- 任务批次完成后唤醒主线程状态机。
|
||||
- 让资源系统在异步加载收尾时投递后续工作。
|
||||
|
||||
当前这里只保留了接口入口,还没有接上“何时判定整组完成”的核心机制。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](TaskGroup.md)
|
||||
- [返回模块目录](../Threading.md)
|
||||
- [返回类型总览](TaskGroup.md)
|
||||
- [IsComplete](IsComplete.md)
|
||||
- [Wait](Wait.md)
|
||||
|
||||
Reference in New Issue
Block a user