docs: rebuild Threading API content
This commit is contained in:
@@ -6,34 +6,41 @@
|
||||
|
||||
**头文件**: `XCEngine/Threading/Thread.h`
|
||||
|
||||
**描述**: 定义 `XCEngine/Threading` 子目录中的 `Thread` public API。
|
||||
**描述**: 对 `std::thread` 的轻量包装,附带名称字符串和一个缓存的线程标识值。
|
||||
|
||||
## 概述
|
||||
|
||||
`Thread.h` 是 `XCEngine/Threading` 子目录 下的 public header,当前页面作为平行目录中的 canonical 总览,用于汇总该头文件暴露的主要声明。
|
||||
`Thread` 不是线程系统,而是一个非常薄的 `std::thread` 外壳。它主要额外做了两件事:
|
||||
|
||||
## 声明概览
|
||||
- 保存一个 `Containers::String m_name`
|
||||
- 在 `Start()` 时缓存一个 `m_id`
|
||||
|
||||
| 声明 | 类型 | 说明 |
|
||||
|------|------|------|
|
||||
| `Thread` | `class` | 头文件中的公开声明。 |
|
||||
这类包装在引擎里很常见,因为很多系统希望在不直接暴露标准库类型的前提下,统一线程 API、线程名和工具层调试信息。
|
||||
|
||||
## 公共方法
|
||||
## 当前实现边界
|
||||
|
||||
| 方法 | 描述 |
|
||||
- [Destructor](Destructor.md) 会在对象析构时自动 `Join()`,因此析构可能阻塞。
|
||||
- [Start](Start.md) 只保存名称字符串,不会设置 OS 层面的线程名。
|
||||
- [GetId](GetId.md) 的来源是 `native_handle()` 转成整数,而 [GetCurrentId](GetCurrentId.md) 的来源是 `std::thread::id` 的 hash;两者不是同一口径。
|
||||
- [Start](Start.md) 当前没有防御“对一个仍然 joinable 的线程再次 Start”的情况;这会落到 `std::thread` 的终止语义。
|
||||
- 当前没有对应单测覆盖。
|
||||
|
||||
## 公开方法
|
||||
|
||||
| 方法 | 说明 |
|
||||
|------|------|
|
||||
| [Thread()](Constructor.md) | 构造对象。 |
|
||||
| [~Thread()](Destructor.md) | 销毁对象并释放相关资源。 |
|
||||
| [Start](Start.md) | 公开方法,详见头文件声明。 |
|
||||
| [Join](Join.md) | 公开方法,详见头文件声明。 |
|
||||
| [Detach](Detach.md) | 公开方法,详见头文件声明。 |
|
||||
| [GetId](GetId.md) | 获取相关状态或对象。 |
|
||||
| [GetName](GetName.md) | 获取相关状态或对象。 |
|
||||
| [GetCurrentId](GetCurrentId.md) | 获取相关状态或对象。 |
|
||||
| [Sleep](Sleep.md) | 公开方法,详见头文件声明。 |
|
||||
| [Yield](Yield.md) | 公开方法,详见头文件声明。 |
|
||||
| [Constructor](Constructor.md) | 构造空线程对象。 |
|
||||
| [Destructor](Destructor.md) | 析构时自动 join。 |
|
||||
| [Start](Start.md) | 启动线程。 |
|
||||
| [Join](Join.md) | 等待线程结束。 |
|
||||
| [Detach](Detach.md) | 分离线程。 |
|
||||
| [GetId](GetId.md) | 获取缓存的线程标识。 |
|
||||
| [GetName](GetName.md) | 获取保存的线程名称。 |
|
||||
| [GetCurrentId](GetCurrentId.md) | 获取当前线程标识。 |
|
||||
| [Sleep](Sleep.md) | 让当前线程休眠。 |
|
||||
| [Yield](Yield.md) | 让出当前线程时间片。 |
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [当前目录](../Threading.md) - 返回 `Threading` 平行目录
|
||||
- [API 总索引](../../../main.md) - 返回顶层索引
|
||||
- [当前模块](../Threading.md)
|
||||
- [Synchronization And Task System Limits](../../../_guides/Threading/Synchronization-And-TaskSystem-Limits.md)
|
||||
|
||||
Reference in New Issue
Block a user