Files
XCEngine/docs/api/threading/task/task.md

94 lines
2.5 KiB
Markdown
Raw Normal View History

# ITask
**命名空间**: `XCEngine::Threading`
**类型**: `class` (abstract)
**头文件**: `XCEngine/Threading/Task.h`
**描述**: 任务基类抽象接口和任务状态/优先级枚举定义。
## 概述
`ITask` 是任务系统的核心抽象基类。用户需要继承此类并实现 `Execute()` 方法来定义具体的任务逻辑。任务系统通过引用计数自动管理任务生命周期。
## TaskPriority 枚举
任务优先级枚举(数值越小优先级越高)。
| 值 | 描述 |
|----|------|
| `Critical` | 关键优先级0 |
| `High` | 高优先级1 |
| `Normal` | 普通优先级2 |
| `Low` | 低优先级3 |
| `Idle` | 空闲优先级4 |
## TaskStatus 枚举
任务状态枚举。
| 值 | 描述 |
|----|------|
| `Pending` | 等待中 |
| `Scheduled` | 已调度 |
| `Running` | 运行中 |
| `Completed` | 已完成 |
| `Failed` | 失败 |
| `Canceled` | 已取消 |
## 公共方法
| 方法 | 描述 |
|------|------|
| `virtual ~ITask()` | 虚析构函数 |
| [`Execute`](execute.md) | 任务执行逻辑(纯虚) |
| [`OnComplete`](on-complete.md) | 任务完成回调(可重写) |
| [`OnCancel`](on-cancel.md) | 任务取消回调(可重写) |
| [`GetPriority`](get-priority.md) | 获取优先级 |
| [`GetStatus`](get-status.md) | 获取状态 |
| [`GetId`](get-id.md) | 获取任务 ID |
| [`SetId`](set-id.md) | 设置任务 ID |
| [`SetPriority`](set-priority.md) | 设置优先级 |
| [`SetStatus`](set-status.md) | 设置状态 |
| [`AddRef`](add-ref.md) | 增加引用计数 |
| [`Release`](release.md) | 减少引用计数(引用归零时自动 delete |
## 受保护方法
| 方法 | 描述 |
|------|------|
| `ITask()` | 默认构造函数 |
| `ITask(TaskPriority priority)` | 带优先级的构造函数 |
## 使用示例
```cpp
class MyTask : public ITask {
public:
explicit MyTask(int data) : m_data(data) {}
void Execute() override {
printf("Task executed with data: %d\n", m_data);
}
void OnComplete() override {
printf("Task completed\n");
}
private:
int m_data;
};
auto task = new MyTask(42);
task->SetPriority(TaskPriority::High);
TaskSystem::Get().Submit(std::unique_ptr<ITask>(task));
```
## 相关文档
- [LambdaTask](../lambda-task/lambda-task.md) - Lambda 任务封装
- [TaskGroup](../task-group/task-group.md) - 任务组
- [TaskSystem](../task-system/task-system.md) - 任务系统
- [../threading.md](../threading.md) - 模块总览