docs: rebuild Threading API content
This commit is contained in:
@@ -1,29 +1,30 @@
|
||||
# TaskSystem::Get
|
||||
|
||||
获取相关状态或对象。
|
||||
取得全局任务系统单例。
|
||||
|
||||
```cpp
|
||||
static TaskSystem& Get();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Threading/TaskSystem.h`,当前页面用于固定 `TaskSystem` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
|
||||
**返回:** `TaskSystem&` - 返回值语义详见头文件声明。
|
||||
|
||||
**示例:**
|
||||
当前实现返回一个函数内静态对象:
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Threading/TaskSystem.h>
|
||||
|
||||
void Example() {
|
||||
auto& instance = XCEngine::Threading::TaskSystem::Get();
|
||||
(void)instance;
|
||||
}
|
||||
static TaskSystem instance;
|
||||
```
|
||||
|
||||
## 返回值
|
||||
|
||||
- `TaskSystem` 的全局唯一实例引用。
|
||||
|
||||
## 注意事项
|
||||
|
||||
- 取得实例并不会自动调用 [Initialize](Initialize.md)。
|
||||
- 由于构造函数和析构函数是私有的,外部只能通过这个入口访问任务系统。
|
||||
- 当前单例持有线程、队列和任务组列表,因此生命周期等同于整个进程内的静态对象生命周期。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](TaskSystem.md)
|
||||
- [返回模块目录](../Threading.md)
|
||||
- [返回类型总览](TaskSystem.md)
|
||||
- [Initialize](Initialize.md)
|
||||
|
||||
Reference in New Issue
Block a user