docs: rebuild Threading API content
This commit is contained in:
@@ -6,29 +6,29 @@
|
||||
|
||||
**头文件**: `XCEngine/Threading/TaskSystemConfig.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Threading` 子目录中的 `TaskSystemConfig` public API。
|
||||
**描述**: 描述 `TaskSystem` 初始化参数的配置结构体。
|
||||
|
||||
## 概述
|
||||
|
||||
`TaskSystemConfig.h` 是 `XCEngine/Threading` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
`TaskSystemConfig` 的字段形状已经有了商用任务系统常见的雏形:工作线程数、任务窃取、任务队列上限、profiling 开关和线程栈大小。
|
||||
|
||||
## 声明概览
|
||||
但需要注意的是,当前真正被 `TaskSystem::Initialize()` 使用的只有 `workerThreadCount`。
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `TaskSystemConfig` | `struct` | 头文件中的公开声明。 |
|
||||
## 字段
|
||||
|
||||
## 结构体成员
|
||||
| 字段 | 类型 | 默认值 | 当前作用 |
|
||||
|------|------|--------|----------|
|
||||
| `workerThreadCount` | `uint32_t` | `0` | 已使用;`0` 时回退到 `std::thread::hardware_concurrency()` |
|
||||
| `enableTaskProfiling` | `bool` | `true` | 当前未使用 |
|
||||
| `stealTasks` | `bool` | `true` | 当前未使用 |
|
||||
| `maxTaskQueueSize` | `uint32_t` | `1024` | 当前未使用 |
|
||||
| `threadStackSize` | `uint32_t` | `0` | 当前未使用 |
|
||||
|
||||
| 成员 | 类型 | 描述 | 默认值 |
|
||||
|------|------|------|--------|
|
||||
| `workerThreadCount` | `uint32_t` | 结构体公开字段。 | `0` |
|
||||
| `enableTaskProfiling` | `bool` | 结构体公开字段。 | `true` |
|
||||
| `stealTasks` | `bool` | 结构体公开字段。 | `true` |
|
||||
| `maxTaskQueueSize` | `uint32_t` | 结构体公开字段。 | `1024` |
|
||||
| `threadStackSize` | `uint32_t` | 结构体公开字段。 | `0` |
|
||||
## 设计说明
|
||||
|
||||
这说明 `TaskSystem` 目前更接近“先把 API 形状搭出来”,而不是已经把所有调度策略和平台细节真正接上。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Threading.md) - 返回 `Threading` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
- [当前模块](../Threading.md)
|
||||
- [TaskSystem](../TaskSystem/TaskSystem.md)
|
||||
|
||||
Reference in New Issue
Block a user