std::call_once
来自 cppreference.cn
| 定义于头文件 <mutex> |
||
| template< class Callable, class... Args > void call_once( std::once_flag& flag, Callable&& f, Args&&... args ); |
(自 C++11 起) | |
正好执行 可调用 对象 f 一次，即使从多个线程并发调用也是如此。
详细说明
- 如果当调用
std::call_once时，flag 指示 f 已经调用过，则std::call_once立即返回（这种std::call_once调用被称为被动）。
- 否则，
std::call_once调用 INVOKE(std::forward<Callable>(f), std::forward<Args>(args)...)。 与 std::thread 构造函数或 std::async 不同，参数不会被移动或复制，因为它们不需要传输到另一个执行线程（这种std::call_once调用被称为主动）。
- 如果该调用抛出异常，则异常会传播到
std::call_once的调用者，并且 flag 不会被翻转，以便可以尝试另一次调用（这种std::call_once调用被称为异常）。 - 如果该调用正常返回（这种
std::call_once调用被称为返回），则 flag 会被翻转，并且所有其他使用相同 flag 的std::call_once调用都保证是被动的。
- 如果该调用抛出异常，则异常会传播到
在同一个 flag 上的所有主动调用形成一个单一的总顺序，该顺序由零个或多个异常调用组成，后跟一个返回调用。 每个主动调用的结束与该顺序中的下一个主动调用同步。
来自返回调用的返回与来自同一 flag 上的所有被动调用的返回同步：这意味着保证所有并发的 std::call_once 调用都观察到主动调用所做的任何副作用，而无需额外的同步。
目录 |
[编辑] 参数
| flag | - | 一个对象，对于该对象，恰好执行一个函数 |
| f | - | 可调用 对象以调用 |
| args... | - | 传递给函数的参数 |
[编辑] 返回值
(无)
[编辑] 异常
- std::system_error 如果任何条件阻止对
std::call_once的调用按指定方式执行。 - 由 f 抛出的任何异常。
[编辑] 注释
如果对 std::call_once 的并发调用传递不同的函数 f，则未指定将调用哪个 f。 所选函数在与其传递的 std::call_once 调用相同的线程中运行。
函数局部静态变量的初始化保证只发生一次，即使从多个线程调用也是如此，并且可能比使用 std::call_once 的等效代码更有效。
此函数的 POSIX 等效项是 pthread_once。
[编辑] 示例
运行此代码
#include <iostream> #include <mutex> #include <thread> std::once_flag flag1, flag2; void simple_do_once() { std::call_once(flag1, [](){ std::cout << "Simple example: called once\n"; }); } void may_throw_function(bool do_throw) { if (do_throw) { std::cout << "Throw: call_once will retry\n"; // this may appear more than once throw std::exception(); } std::cout << "Did not throw, call_once will not attempt again\n"; // guaranteed once } void do_once(bool do_throw) { try { std::call_once(flag2, may_throw_function, do_throw); } catch (...) {} } int main() { std::thread st1(simple_do_once); std::thread st2(simple_do_once); std::thread st3(simple_do_once); std::thread st4(simple_do_once); st1.join(); st2.join(); st3.join(); st4.join(); std::thread t1(do_once, true); std::thread t2(do_once, true); std::thread t3(do_once, false); std::thread t4(do_once, true); t1.join(); t2.join(); t3.join(); t4.join(); }
可能的输出
Simple example: called once Throw: call_once will retry Throw: call_once will retry Throw: call_once will retry Did not throw, call_once will not attempt again
[编辑] 缺陷报告
以下行为变更缺陷报告被追溯应用于先前发布的 C++ 标准。
| DR | 应用于 | 已发布行为 | 正确行为 |
|---|---|---|---|
| LWG 2080 | C++11 | 如果 f 无效，则会抛出 std::invalid_argument， 但未指定 f 失效的情况 |
移除了此错误条件 |
| LWG 2442 | C++11 | 参数在调用之前被复制和/或移动 | 不执行复制/移动 |
[编辑] 参见
| (C++11) |
帮助对象以确保 call_once 仅调用函数一次 (类) |
| C 文档 关于 call_once
| |
