c++ 11 多线程支持 条件变量 （condition_variable_any）（三）

定义于头文件 <condition_variable>

class condition_variable_any;         (C++11 起) 

condition_variable_any 类是 std::condition_variable 的泛化。相对于只在 std::unique_lock<std::mutex> 上工作的 std::condition_variable ， condition_variable_any 能在任何满足 基本可锁定 (BasicLockable) 要求的锁上工作。

条件变量语义描述见 std::condition_variable 。

类 std::condition_variable_any 是 标准布局类型 (StandardLayoutType) 。它非 可复制构造 (CopyConstructible) 、 可移动构造 (MoveConstructible) 、 可复制赋值 (CopyAssignable) 或 可移动赋值 (MoveAssignable) 。

若锁是 std::unique_lock ，则 std::condition_variable 可能提供更好的性能。

注意

std::condition_variable_any 能与 std::shared_lock 一同使用，以在 std::shared_mutex 上以共享所有权模式等待。

std::condition_variable_any 与定制可锁定 (Lockable) 类型的一种可行使用是提供便利的可中断等待：定制所操作将按期待锁定关联互斥，并在收到中断信号时进行必要的设置，以通知此条件变量。[1]

阻塞当前线程，直到条件变量被唤醒，或直到抵达指定时间点

template< class Lock, class Clock, class Duration > 
std::cv_status wait_until( Lock& lock,
const std::chrono::time_point<Clock, Duration>& timeout_time ); (1) (C++11 起) 

template< class Lock, class Clock, class Duration, class Pred >
bool wait_until( Lock& lock,
const std::chrono::time_point<Clock, Duration>& timeout_time,
                 Pred pred ); (2) (C++11 起) 

wait_until 导致当前线程阻塞直至通知条件变量、抵达指定时间或虚假唤醒发生，可选的循环直至满足某谓词。

1) 原子地释放 lock ，阻塞当前线程，并将它添加到等待在 *this 上的线程列表。线程将在执行 notify_all() 或 notify_one() 时，或抵达绝对时间点 timeout_time 时被解除阻塞。它亦可被虚假地解除阻塞。解除阻塞时，无关缘由，重获得 lock 并退出 wait_for() 。若此函数通过异常退出，则亦重获得 lock 。 (C++14 前)

2) 等价于

while (!pred()) {
    if (wait_until(lock, timeout_time) == std::cv_status::timeout) {
        return pred();
    }
}
return true;

此重载可用于忽略虚假唤醒。

若这些函数不能满足后置条件（调用方线程锁定 lock ），则调用 std::terminate 。例如，这可能在重锁定互斥抛异常的情况下发生。

(C++14 起)

参数

lock	-	满足基本可锁定 (BasicLockable) 要求的 Lock 类型对象，必须为当前线程所锁定
timeout_time	-	表示停止等待时间的 std::chrono::time_point 类型对象
pred	-	是否应该持续等待则返回 ​false 的谓词。 谓词函数的签名应等价于如下者：  bool pred();​

返回值

1) 若抵达 timeout_time 指定的的绝对时间点则为 std::cv_status::timeout ，否则为 std::cv_status::no_timeout 。

2) 若度过 timeout_time 时限后 pred 仍求值为 false 则为 false ，否则为 true 。若已度过时限，则求值并返回 pred 的结果。

异常

1)

可抛出 std::system_error ，亦可传播 lock.lock() 或 lock.unlock() 所抛的异常	(C++14 前)
执行期间时钟、时间点或时长可能抛出的任何异常（标准库提供的时钟、时间点和时长决不抛出）	(C++14 起)

2) 同 (1) ，但亦可传播 pred 所抛的异常

注意

使用倾向 timeout_time 的时钟，不要求是单调时钟。若不连续地调节时钟，则不对此函数的行为保证，但既存实现将 timeout_time 从 Clock 转换到 std::chrono::system_clock ，并委托 POSIX pthread_cond_timedwait 以令等待忠实于系统时钟，但非用户提供 Clock 的调节。任何情况下，由于调度或资源争议延迟，函数可能等待长于抵达 timeout_time 。

即使使用的始终是 std::chrono::steady_clock 或另一单调时钟，系统时钟调节亦可能导致虚假唤醒。

notify_one()/notify_all() 的效果与 wait()/wait_for()/wait_until() 的三个原子部分的每一者（解锁+等待、唤醒和锁定）以能看做原子变量修改顺序单独全序发生：顺序对此单独的 condition_variable 是特定的。譬如，这使得 notify_one() 不可能被延迟并解锁正好在进行 notify_one() 调用后开始等待的线程。

调用示例

#include <iostream>
#include <atomic>
#include <condition_variable>
#include <thread>
#include <chrono>

std::condition_variable cv;
std::mutex cv_m;
std::atomic<int> i{0};

void waits(int idx)
{
    std::unique_lock<std::mutex> lk(cv_m);
    auto now = std::chrono::system_clock::now();
    auto func = []()
    {
        return i == 1;
    };

    if (cv.wait_until(lk, now + std::chrono::milliseconds(idx * 100), func))
    {
        std::cerr << "Thread " << idx << " finished waiting. i == " << i << '\n';
    }
    else
    {
        std::cerr << "Thread " << idx << " timed out. i == " << i << '\n';
    }
}

void signals()
{
    std::this_thread::sleep_for(std::chrono::milliseconds(120));
    std::cerr << "Notifying...\n";
    cv.notify_all();
    std::this_thread::sleep_for(std::chrono::milliseconds(100));
    i = 1;
    std::cerr << "Notifying again...\n";
    cv.notify_all();
}

int main()
{
    std::thread t1(waits, 1), t2(waits, 2), t3(waits, 3), t4(signals);
    t1.join();
    t2.join();
    t3.join();
    t4.join();
}

输出