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这个可调用 (Callable) 对象也只会被精确地执行一次。
详细说明
- 如果，当调用
std::call_once时，flag指示f已被调用过，std::call_once会立即返回（这种对std::call_once的调用被称为被动 (passive)）。
- 否则，
std::call_once会调用INVOKE(std::forward<Callable>(f), std::forward<Args>(args)...)。与std::thread构造函数或std::async不同，参数不会被移动或复制，因为它们不需要转移到另一个执行线程（这种对std::call_once的调用被称为主动 (active)）。
- 如果该调用抛出异常，则该异常会传播到
std::call_once的调用者，并且flag不会被翻转，以便再次尝试调用（这种对std::call_once的调用被称为异常 (exceptional)）。 - 如果该调用正常返回（这种对
std::call_once的调用被称为返回 (returning)），则flag会被翻转，并且所有其他使用相同flag的std::call_once调用都保证是被动 (passive)的。
- 如果该调用抛出异常，则该异常会传播到
对相同flag的所有主动 (active)调用形成一个单一的总顺序，该顺序由零个或多个异常 (exceptional)调用，后跟一个返回 (returning)调用组成。每个主动 (active)调用的结束与该顺序中的下一个主动 (active)调用同步。
返回 (returning)调用的返回与使用相同flag的所有被动 (passive)调用的返回同步：这意味着所有对std::call_once的并发调用都保证能够观察到主动 (active)调用所产生的任何副作用，而无需额外的同步。
目录 |
[编辑] 参数
| flag | - | 一个对象，其关联的函数只会执行一次。 |
| f | - | 要调用的可调用 (Callable) 对象。 |
| args... | - | 要传递给函数的参数。 |
[编辑] 返回值
(无)
[编辑] 异常
- 如果任何条件阻止
std::call_once按照指定执行，则抛出std::system_error。 - 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++ 标准。
| 缺陷报告 | 应用于 | 发布时的行为 | 正确的行为 |
|---|---|---|---|
| LWG 2080 | C++11 | 如果f无效，则会抛出std::invalid_argument， 但f失效的场景未指定 |
移除了此错误条件 |
| LWG 2442 | C++11 | 参数在调用前被复制和/或移动 | 不执行复制/移动 |
[编辑] 参阅
| (C++11) |
辅助对象，确保call_once只调用函数一次 (类) |
| C 文档，关于call_once
| |
