docs: update memory and threading API docs
This commit is contained in:
@@ -6,43 +6,52 @@
|
||||
|
||||
**头文件**: `XCEngine/Threading/Mutex.h`
|
||||
|
||||
**描述**: 互斥锁封装类,基于 `std::mutex` 实现,提供线程安全的互斥访问。
|
||||
**描述**: 互斥锁,封装 std::mutex 提供线程同步
|
||||
|
||||
## 概述
|
||||
|
||||
`Mutex` 是对 `std::mutex` 的简单封装,提供了标准的 Lock/Unlock/TryLock 接口。它是 XCEngine 中最基础的同步原语,适用于保护共享数据的访问。
|
||||
Mutex 类是对 std::mutex 的封装,提供线程安全的互斥访问机制。该类确保同一时刻只有一个线程可以访问受保护的资源,防止数据竞争和竞态条件。
|
||||
|
||||
该类提供两套接口:
|
||||
- `Lock/Unlock/TryLock`:XCEngine 风格接口
|
||||
- `lock/unlock/try_lock`:STL 兼容接口(const 成员函数)
|
||||
|
||||
## 公共方法
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`Lock`](lock.md) | 获取锁(阻塞) |
|
||||
| [`Unlock`](unlock.md) | 释放锁 |
|
||||
| [`TryLock`](trylock.md) | 尝试获取锁(非阻塞,成功返回 true) |
|
||||
|
||||
## STL 兼容方法
|
||||
|
||||
支持 `lock()`, `unlock()`, `try_lock()` 以兼容 STL 的 lockable 概念。**注意**:这些方法为 `const` 成员函数。
|
||||
| [`Lock`](lock.md) | 获取互斥锁(非 const) |
|
||||
| [`Unlock`](unlock.md) | 释放互斥锁(非 const) |
|
||||
| [`TryLock`](trylock.md) | 尝试获取互斥锁(非 const) |
|
||||
| [`lock`](lock_const.md) | 获取互斥锁(const,STL 兼容) |
|
||||
| [`unlock`](unlock_const.md) | 释放互斥锁(const,STL 兼容) |
|
||||
| [`try_lock`](try_lock_const.md) | 尝试获取互斥锁(const,STL 兼容) |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
Threading::Mutex mtx;
|
||||
#include "XCEngine/Threading/Mutex.h"
|
||||
#include <thread>
|
||||
#include <iostream>
|
||||
|
||||
XCEngine::Threading::Mutex mutex;
|
||||
int sharedData = 0;
|
||||
|
||||
// 线程安全地修改共享数据
|
||||
void SafeIncrement() {
|
||||
mtx.Lock();
|
||||
void increment() {
|
||||
mutex.lock();
|
||||
++sharedData;
|
||||
mtx.Unlock();
|
||||
mutex.unlock();
|
||||
}
|
||||
|
||||
// 或使用 TryLock
|
||||
void SafeTryIncrement() {
|
||||
if (mtx.TryLock()) {
|
||||
++sharedData;
|
||||
mtx.Unlock();
|
||||
}
|
||||
int main() {
|
||||
std::thread t1(increment);
|
||||
std::thread t2(increment);
|
||||
|
||||
t1.join();
|
||||
t2.join();
|
||||
|
||||
std::cout << "sharedData = " << sharedData << std::endl;
|
||||
return 0;
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user