std::unique_lock

来自cppreference.com
< cpp‎ | thread
 
 
线程支持库
线程
(C++11)
(C++20)
(C++20)
this_thread 命名空间
(C++11)
(C++11)
(C++11)
互斥
(C++11)
通用锁管理
(C++11)
unique_lock
(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)
(C++11)
(C++11)
条件变量
(C++11)
信号量
闩与屏障
(C++20)
(C++20)
future
(C++11)
(C++11)
(C++11)
(C++11)
 
 
定义于头文件 <mutex>
template< class Mutex >
class unique_lock;
(C++11 起)

unique_lock 是通用互斥包装器,允许延迟锁定、锁定的有时限尝试、递归锁定、所有权转移和与条件变量一同使用。

unique_lock 可移动,但不可复制——它满足可移动构造 (MoveConstructible) 可移动赋值 (MoveAssignable) 但不满足可复制构造 (CopyConstructible) 可复制赋值 (CopyAssignable)

unique_lock 满足基本可锁定 (BasicLockable) 要求。若 Mutex 满足可锁定 (Lockable) 要求,则 unique_lock 亦满足可锁定 (Lockable) 要求(例如:能用于 std::lock ) ;若 Mutex 满足可定时锁定 (TimedLockable) 要求,则 unique_lock 亦满足可定时锁定 (TimedLockable) 要求。

模板形参

Mutex - 要锁定的互斥类型。类型必须满足基本可锁定 (BasicLockable) 要求

成员类型

类型 定义
mutex_type Mutex

成员函数

构造 unique_lock ,可选地锁定提供的互斥
(公开成员函数)
若占有关联互斥,则解锁之
(公开成员函数)
若占有则解锁互斥,并取得另一者的所有权
(公开成员函数)
锁定
锁定关联互斥
(公开成员函数)
尝试锁定关联互斥,若互斥不可用则返回
(公开成员函数)
试图锁定关联的可定时锁定 (TimedLockable) 互斥,若互斥在给定时长中不可用则返回
(公开成员函数)
尝试锁定关联可定时锁定 (TimedLockable) 互斥,若抵达指定时间点互斥仍不可用则返回
(公开成员函数)
解锁关联互斥
(公开成员函数)
修改器
与另一 std::unique_lock 交换状态
(公开成员函数)
将关联互斥解关联而不解锁它
(公开成员函数)
观察器
返回指向关联互斥的指针
(公开成员函数)
测试锁是否占有其关联互斥
(公开成员函数)
测试锁是否占有其关联互斥
(公开成员函数)

非成员函数

std::swapunique_lock 的特化
(函数模板)

示例

#include <mutex>
#include <thread>
#include <chrono>
 
struct Box {
    explicit Box(int num) : num_things{num} {}
 
    int num_things;
    std::mutex m;
};
 
void transfer(Box &from, Box &to, int num)
{
    // 仍未实际取锁
    std::unique_lock<std::mutex> lock1(from.m, std::defer_lock);
    std::unique_lock<std::mutex> lock2(to.m, std::defer_lock);
 
    // 锁两个 unique_lock 而不死锁
    std::lock(lock1, lock2);
 
    from.num_things -= num;
    to.num_things += num;
 
    // 'from.m' 与 'to.m' 互斥解锁于 'unique_lock' 析构函数
}
 
int main()
{
    Box acc1(100);
    Box acc2(50);
 
    std::thread t1(transfer, std::ref(acc1), std::ref(acc2), 10);
    std::thread t2(transfer, std::ref(acc2), std::ref(acc1), 5);
 
    t1.join();
    t2.join();
}

缺陷报告

下列更改行为的缺陷报告追溯地应用于以前出版的 C++ 标准。

DR 应用于 出版时的行为 正确行为
LWG 2981 C++17 曾提供来自 unique_lock<Mutex> 的冗余推导指引 已移除

参阅

实现严格基于作用域的互斥体所有权包装器
(类模板)
用于多个互斥体的免死锁 RAII 封装器
(类模板)