docs: update memory and threading API docs

This commit is contained in:
2026-03-20 02:35:24 +08:00
parent c5b17239ca
commit fd792b7df1
103 changed files with 2485 additions and 673 deletions

View File

@@ -6,61 +6,83 @@
**头文件**: `XCEngine/Threading/TaskGroup.h`
**描述**: 任务组管理类,用于组织多个任务并支持批量等待、进度跟踪和依赖管理。
**描述**: 管理一组相关任务的执行和同步
## 概述
`TaskGroup` 提供了一种批量管理任务的机制。它允许添加多个任务、设置任务依赖关系、等待所有任务完成,并提供进度回调功能
TaskGroup 用于将多个相关任务组织在一起,统一管理它们的执行和同步。任务组内的任务可以声明依赖关系,确保任务按照正确的顺序执行。支持任务优先级设置、完成回调、进度查询和取消操作
## 公共类型
| 类型 | 描述 |
|------|------|
| `Callback = std::function<void()>` | 任务组回调函数类型 |
主要功能:
- 添加任务ITask 对象或函数回调)
- 声明任务间依赖关系
- 等待所有任务完成
- 设置完成回调
- 查询完成进度
- 取消未执行的任务
## 公共方法
| 方法 | 描述 |
|------|------|
| `TaskGroup()` | 默认构造函数 |
| `~TaskGroup()` | 析构函数 |
| [`AddTask(unique_ptr)`](addtask.md) | 添加任务对象 |
| [`AddTask(callback)`](addtask.md) | 添加 lambda 任务 |
| [`AddDependency`](adddependency.md) | 添加任务依赖关系 |
| [`Task()`](task-group.md) | 默认构造函数 |
| [`~Task()`](task-group.md) | 析构函数 |
| [`AddTask`](add-task.md) | 添加任务到组(支持 ITask 或 Callback |
| [`AddDependency`](add-dependency.md) | 添加任务依赖关系 |
| [`Wait`](wait.md) | 阻塞等待所有任务完成 |
| [`WaitFor`](waitfor.md) | 超时等待 |
| [`SetCompleteCallback`](setcompletecallback.md) | 设置完成回调 |
| [`IsComplete`](iscomplete.md) | 检查所有任务是否完成 |
| [`GetProgress`](getprogress.md) | 获取完成进度0.0f ~ 1.0f |
| [`Cancel`](cancel.md) | 取消所有任务 |
| [`WaitFor`](wait-for.md) | 等待指定超时时间 |
| [`SetCompleteCallback`](set-complete-callback.md) | 设置完成回调函数 |
| [`IsComplete`](is-complete.md) | 检查所有任务是否完成 |
| [`GetProgress`](get-progress.md) | 获取任务组完成进度 |
| [`Cancel`](cancel.md) | 取消所有未执行的任务 |
## 使用示例
```cpp
TaskGroup* group = TaskSystem::Get().CreateTaskGroup();
#include "XCEngine/Threading/TaskGroup.h"
#include "XCEngine/Threading/Task.h"
#include <iostream>
// 添加多个任务
uint64_t task1 = group->AddTask([]() { /* 任务1 */ });
uint64_t task2 = group->AddTask([]() { /* 任务2 */ });
using namespace XCEngine::Threading;
// 设置依赖task3 等待 task1 完成
uint64_t task3 = group->AddTask([]() { /* 任务3 */ });
group->AddDependency(task3, task1);
class MyTask : public ITask {
public:
explicit MyTask(const std::string& name) : m_name(name) {}
// 设置完成回调
group->SetCompleteCallback([]() {
printf("All tasks completed!\n");
});
void Execute() override {
std::cout << "Task " << m_name << " executing\n";
}
// 等待完成
group->Wait();
void OnComplete() override {
std::cout << "Task " << m_name << " completed\n";
}
// 销毁
TaskSystem::Get().DestroyTaskGroup(group);
private:
std::string m_name;
};
int main() {
TaskGroup group;
uint64_t task1 = group.AddTask(std::make_unique<MyTask>("Task1"));
uint64_t task2 = group.AddTask([]() {
std::cout << "Lambda task executing\n";
}, TaskPriority::High);
group.AddDependency(task2, task1);
group.SetCompleteCallback([]() {
std::cout << "All tasks completed!\n";
});
group.Wait();
std::cout << "Progress: " << group.GetProgress() * 100 << "%\n";
return 0;
}
```
## 相关文档
- [ITask](../task/task.md) - 任务基类
- [TaskSystem](../task-system/task-system.md) - 任务系统
- [../threading/threading.md](../threading.md) - 模块总览
- [ITask](../task/task.md) - 任务接口基类
- [TaskSystem](../task-system/task-system.md) - 任务调度系统