std::call_once

来自cppreference.com
< cpp‎ | thread
 
 
并发支持库
线程
(C++11)
(C++20)
this_thread 命名空间
(C++11)
(C++11)
(C++11)
协作式取消
互斥
通用锁管理
(C++11)
(C++11)
(C++11)
call_once
(C++11)
条件变量
(C++11)
信号量
闩与屏障
(C++20)
(C++20)
未来体
(C++11)
(C++11)
(C++11)
安全回收
风险指针
原子类型
(C++11)
(C++20)
原子类型的初始化
(C++11)(C++20 弃用)
(C++11)(C++20 弃用)
内存定序
(C++11)(C++26 弃用)
原子操作的自由函数
原子标志的自由函数
 
在标头 <mutex> 定义
template<class Callable, class... Args>
void call_once(std::once_flag& flag, Callable&& f, Args&&... args);
(C++11 起)

准确执行一次可调用(Callable) 对象 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,并保证以同一 flagstd::call_once 的其他调用为消极

同一 flag 上的所有积极 调用组成单独全序,它们由零或多个异常 调用后随一个返回 调用组成。该顺序中,每个积极 调用的结尾同步于下个积极 调用。

返回 调用的返回同步于同一 flag 上的所有消极 调用:这表示保证所有对 std::call_once 的同时调用都观察到积极 调用所做的任何副效应,而无需额外同步。

目录

[编辑]参数

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<<"简单样例:调用一次\n";});}   void may_throw_function(bool do_throw){if(do_throw){std::cout<<"抛出:call_once 会重试\n";// 这会出现不止一次throwstd::exception();}std::cout<<"没有抛出,call_once 不会再重试\n";// 保证一次}   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();}

可能的输出:

简单样例:调用一次 抛出:call_once 会重试 抛出:call_once 会重试 抛出:call_once 会重试 没有抛出,call_once 不会再重试

[编辑]缺陷报告

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

缺陷报告 应用于 出版时的行为 正确行为
LWG 2080 C++11 f 无效时会抛出 std::invalid_argument,但是没有指定在什么情况下 f 会失效 移除此错误条件
LWG 2442 C++11 在调用前会复制和/或移动参数 不进行复制/移动

[编辑]参阅

(C++11)
确保 call_once 只调用函数一次的帮助对象
(类)[编辑]
call_once 的 C 文档
close