docs: rebuild Threading API content
This commit is contained in:
@@ -1,30 +1,26 @@
|
||||
# ReadWriteLock::WriteLock
|
||||
|
||||
公开方法,详见头文件声明。
|
||||
以独占方式进入读写锁。
|
||||
|
||||
```cpp
|
||||
void WriteLock();
|
||||
```
|
||||
|
||||
该方法声明于 `XCEngine/Threading/ReadWriteLock.h`,当前页面用于固定 `ReadWriteLock` 类目录下的方法级 canonical 路径。
|
||||
## 行为说明
|
||||
|
||||
**参数:** 无。
|
||||
当前实现会:
|
||||
|
||||
**返回:** `void` - 无返回值。
|
||||
1. 拿内部互斥量。
|
||||
2. 先执行 `++m_writersWaiting`。
|
||||
3. 等待 `m_readers == 0 && !m_writerActive`。
|
||||
4. 条件满足后执行 `--m_writersWaiting` 并把 `m_writerActive = true`。
|
||||
|
||||
**示例:**
|
||||
## 返回值
|
||||
|
||||
```cpp
|
||||
#include <XCEngine/Threading/ReadWriteLock.h>
|
||||
|
||||
void Example() {
|
||||
XCEngine::Threading::ReadWriteLock object;
|
||||
// 根据上下文补齐参数后调用 ReadWriteLock::WriteLock(...)。
|
||||
(void)object;
|
||||
}
|
||||
```
|
||||
- 无。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [返回类总览](ReadWriteLock.md)
|
||||
- [返回模块目录](../Threading.md)
|
||||
- [返回类型总览](ReadWriteLock.md)
|
||||
- [WriteUnlock](WriteUnlock.md)
|
||||
- [ReadLock](ReadLock.md)
|
||||
|
||||
Reference in New Issue
Block a user