XCEngine/docs/api/threading/threading-task-group.md

TaskGroup

命名空间: XCEngine::Threading

类型: class

描述: 任务组管理类，用于组织多个任务并支持批量等待、进度跟踪和依赖管理。

概述

TaskGroup 提供了一种批量管理任务的机制。它允许添加多个任务、设置任务依赖关系、等待所有任务完成，并提供进度回调功能。

公共方法

构造/析构

方法	描述
TaskGroup()	默认构造函数
~TaskGroup()	析构函数

任务添加

方法	描述
uint64_t AddTask(std::unique_ptr<ITask> task)	添加任务对象
uint64_t AddTask(Callback&& func, TaskPriority priority = TaskPriority::Normal)	添加 lambda 任务

依赖管理

方法	描述
void AddDependency(uint64_t taskId, uint64_t dependsOn)	添加任务依赖关系

等待

方法	描述
void Wait()	阻塞等待所有任务完成
bool WaitFor(std::chrono::milliseconds timeout)	超时等待

回调和状态

方法	描述
void SetCompleteCallback(Callback&& callback)	设置完成回调
bool IsComplete() const	检查所有任务是否完成
float GetProgress() const	获取完成进度（0.0f ~ 1.0f）
void Cancel()	取消所有任务

使用示例

TaskGroup* group = TaskSystem::Get().CreateTaskGroup();

// 添加多个任务
uint64_t task1 = group->AddTask([]() { /* 任务1 */ });
uint64_t task2 = group->AddTask([]() { /* 任务2 */ });

// 设置依赖：task3 等待 task1 完成
uint64_t task3 = group->AddTask([]() { /* 任务3 */ });
group->AddDependency(task3, task1);

// 设置完成回调
group->SetCompleteCallback([]() {
    printf("All tasks completed!\n");
});

// 等待完成
group->Wait();

// 或者超时等待
if (group->WaitFor(std::chrono::seconds(5))) {
    printf("Completed within 5 seconds\n");
} else {
    printf("Timeout, some tasks did not complete\n");
}

// 销毁
TaskSystem::Get().DestroyTaskGroup(group);

相关文档

• ITask - 任务基类
• TaskSystem - 任务系统