docs: update memory and threading API docs
This commit is contained in:
@@ -6,52 +6,86 @@
|
||||
|
||||
**头文件**: `XCEngine/Threading/ReadWriteLock.h`
|
||||
|
||||
**描述**: 读写锁实现,支持多个并发读取或单一写入,提高读多写少场景的并发性能。
|
||||
**描述**: 读写锁,允许多个读者或单个写者
|
||||
|
||||
## 概述
|
||||
|
||||
`ReadWriteLock` 实现了一个经典的读写锁。它允许多个线程同时持有读锁,但在有写锁时,所有读锁都必须释放,写锁为独占访问。这对于读操作远多于写操作的共享数据非常有效。
|
||||
|
||||
### 设计目的
|
||||
|
||||
- 提供比普通互斥锁更高的并发性能
|
||||
- 允许多个线程同时读取共享数据
|
||||
- 确保写入操作时的独占性访问
|
||||
- 防止写者饥饿(通过写者优先策略)
|
||||
|
||||
### 使用场景
|
||||
|
||||
- 读多写少的共享数据访问
|
||||
- 需要保护长时间读取的数据结构
|
||||
- 数据库、缓存、配置等共享资源访问
|
||||
|
||||
## 公共方法
|
||||
|
||||
### 读锁
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`ReadLock`](readlock.md) | 获取读锁(可重入,支持多个并发读者) |
|
||||
| [`ReadWriteLock`](constructor.md) | 构造一个读写锁 |
|
||||
| [`~ReadWriteLock`](destructor.md) | 销毁读写锁 |
|
||||
| [`ReadLock`](readlock.md) | 获取读锁(支持多个并发读者) |
|
||||
| [`ReadUnlock`](readunlock.md) | 释放读锁 |
|
||||
|
||||
### 写锁
|
||||
|
||||
| 方法 | 描述 |
|
||||
|------|------|
|
||||
| [`WriteLock`](writelock.md) | 获取写锁(独占,阻塞所有读者和写者) |
|
||||
| [`WriteUnlock`](writeunlock.md) | 释放写锁 |
|
||||
|
||||
## 使用示例
|
||||
|
||||
```cpp
|
||||
Threading::ReadWriteLock rwLock;
|
||||
Containers::HashMap<String, int> sharedMap;
|
||||
#include "XCEngine/Threading/ReadWriteLock.h"
|
||||
#include <thread>
|
||||
#include <vector>
|
||||
#include <iostream>
|
||||
#include <map>
|
||||
|
||||
XCEngine::Threading::ReadWriteLock rwLock;
|
||||
std::map<std::string, int> sharedCache;
|
||||
|
||||
// 读操作(多个线程可同时读)
|
||||
int* ReadData(const String& key) {
|
||||
int ReadData(const std::string& key) {
|
||||
rwLock.ReadLock();
|
||||
int* value = sharedMap.Find(key);
|
||||
int value = 0;
|
||||
auto it = sharedCache.find(key);
|
||||
if (it != sharedCache.end()) {
|
||||
value = it->second;
|
||||
}
|
||||
rwLock.ReadUnlock();
|
||||
return value;
|
||||
}
|
||||
|
||||
// 写操作(独占)
|
||||
void WriteData(const String& key, int value) {
|
||||
void WriteData(const std::string& key, int value) {
|
||||
rwLock.WriteLock();
|
||||
sharedMap.Insert(key, value);
|
||||
sharedCache[key] = value;
|
||||
rwLock.WriteUnlock();
|
||||
}
|
||||
|
||||
int main() {
|
||||
std::vector<std::thread> threads;
|
||||
|
||||
threads.emplace_back(WriteData, "score", 100);
|
||||
threads.emplace_back(ReadData, "score");
|
||||
threads.emplace_back(WriteData, "health", 200);
|
||||
threads.emplace_back(ReadData, "health");
|
||||
|
||||
for (auto& t : threads) {
|
||||
t.join();
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
```
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [Mutex](../mutex/mutex.md) - 互斥锁
|
||||
- [SpinLock](../spinlock/spinlock.md) - 自旋锁
|
||||
- [../threading/threading.md](../threading.md) - 模块总览
|
||||
- [`ReadLock`](readlock.md) - 获取读锁
|
||||
- [`ReadUnlock`](readunlock.md) - 释放读锁
|
||||
- [`WriteLock`](writelock.md) - 获取写锁
|
||||
- [`WriteUnlock`](writeunlock.md) - 释放写锁
|
||||
|
||||
Reference in New Issue
Block a user