docs: update memory and threading API docs

This commit is contained in:
2026-03-20 02:35:24 +08:00
parent c5b17239ca
commit fd792b7df1
103 changed files with 2485 additions and 673 deletions

View File

@@ -6,24 +6,26 @@
**头文件**: `XCEngine/Threading/Thread.h`
**描述**: 线程封装类,提供跨平台线程创建和管理功能。
**描述**: 线程类,封装 std::thread 提供命名的线程管理功能。
## 概述
`Thread` 类封装了 `std::thread`,提供统一的线程管理接口,包括启动、加入、分离等操作
`Thread` 类封装了 `std::thread`,提供统一的线程管理接口。设计用于跨平台线程创建和管理,支持为线程指定名称便于调试和日志记录
## 公共类型
类提供实例方法用于启动、等待Join和分离Detach线程以及静态工具方法用于获取当前线程 ID、线程睡眠和让出 CPU 时间片。
| 类型 | 描述 |
|------|------|
| `using Id = uint64_t` | 线程唯一标识符类型 |
## 类型别名
| 类型 | 定义 | 描述 |
|------|------|------|
| `Id` | `uint64_t` | 线程唯一标识符类型 |
## 公共方法
| 方法 | 描述 |
|------|------|
| `Thread()` | 默认构造函数 |
| `~Thread()` | 析构函数 |
| [`Thread()`](thread.md) | 默认构造函数 |
| [`~Thread()`](thread.md) | 析构函数 |
| [`Start`](start.md) | 启动线程,执行传入的函数 |
| [`Join`](join.md) | 等待线程结束 |
| [`Detach`](detach.md) | 分离线程,使其独立运行 |
@@ -36,25 +38,28 @@
## 使用示例
```cpp
#include "Threading/Thread.h"
#include "XCEngine/Threading/Thread.h"
// 创建并启动线程
Thread thread;
thread.Start([]() {
using namespace XCEngine::Threading;
void WorkerFunction() {
printf("Worker thread running\n");
}, "WorkerThread");
}
// 等待线程结束
thread.Join();
int main() {
Thread thread;
thread.Start(WorkerFunction, "WorkerThread");
thread.Join();
// 使用静态方法
Thread::Sleep(1000); // 休眠1秒
Thread::Yield(); // 让出时间片
auto currentId = Thread::GetCurrentId();
Thread::Sleep(1000);
Thread::Yield();
auto currentId = Thread::GetCurrentId();
return 0;
}
```
## 相关文档
- [Mutex](../mutex/mutex.md) - 互斥锁
- [TaskSystem](../task-system/task-system.md) - 任务调度系统
- [../threading/threading.md](../threading.md) - 模块总览
- [../threading.md](../threading.md) - 模块总览