std::experimental::when_any

 

C++

编译器支持

自由（freestanding）与宿主（hosted）

语言

标准库

标准库头文件

具名要求

特性测试宏 (C++20)

语言支持库

概念库 (C++20)

诊断库

内存管理库

元编程库 (C++11)

通用工具库

容器库

迭代器库

范围库 (C++20)

算法库

字符串库

文本处理库

数值库

日期和时间库

输入/输出库

文件系统库 (C++17)

并发支持库 (C++11)

执行控制库 (C++26)

技术规范

符号索引

外部库

 

实验性

技术规范

文件系统库 (文件系统 TS)

库基础 (库基础 TS)

库基础 2 (库基础 TS v2)

库基础 3 (库基础 TS v3)

并行性扩展 (并行性 TS)

并行性扩展 2 (并行性 TS v2)

并发性扩展 (并发性 TS)

并发扩展 2 (并发 TS v2)

概念 (概念 TS)

范围 (范围 TS)

反射 (反射 TS)

数学特殊函数 (特殊函数 TR)

实验性非 TS

模式匹配

线性代数

std::execution

契约

2D 图形

 

并发扩展

std::future 扩展

experimental::future

experimental::shared_future

experimental::when_all

experimental::when_any

experimental::make_ready_future

experimental::make_exceptional_future

锁存器和屏障

experimental::latch

experimental::barrier

experimental::flex_barrier

原子智能指针

experimental::atomic_shared_ptr

experimental::atomic_weak_ptr

 

定义于头文件 <experimental/future>
template< class Sequence > struct when_any_result {     std::size_t index;     Sequence futures; };		(并发技术规范)
template< class InputIt > auto when_any( InputIt first, InputIt last )     -> future<when_any_result<std::vector<typename std::iterator_traits<InputIt>::value_type>>>;	(1)	(并发技术规范)
template< class... Futures > auto when_any( Futures&&... futures )     -> future<when_any_result<std::tuple<std::decay_t<Futures>...>>>;	(2)	(并发技术规范)

创建一个 `future` 对象，当至少一个输入 `future` 和 `shared_future` 准备就绪时，该 `future` 对象也准备就绪。如果任何输入 `future` 或 `shared_future` 无效，则行为未定义。

具体来说，令 `Sequence` 为 std::vector<typename std::iterator_traits<InputIt>::value_type> 用于 (1)，为 std::tuple<std::decay_t<Futures>...> 用于 (2)。此函数模板创建一个包含 `when_any_result<Sequence>` 的共享状态，并返回一个引用该共享状态的 `future`。每个输入 `future` 都被移动到共享状态中 `when_any_result<Sequence>` 的 `futures` 成员中的相应对象，每个输入 `shared_future` 都被复制到共享状态中 `when_any_result<Sequence>` 的 `futures` 成员中的相应对象。`Sequence` 中对象的顺序与参数的顺序匹配。

1) 仅当 `InputIt` 的值类型（即 typename std::iterator_traits<InputIt>::value_type）是 std::experimental::future 或 std::experimental::shared_future 时，此函数才参与重载决议。

2) 仅当每个参数都是（可能带有 cv 限定的）std::experimental::shared_future 或 cv 无限定的 std::experimental::future 时，此函数才参与重载决议。（形式上，对于 `Futures` 中的每个类型 `Fn`，要么 std::remove_reference_t<Fn> 是 std::experimental::future<Rn>，要么 std::decay_t<Fn> 是 std::experimental::shared_future<Rn>。）

在此调用之后，每个输入的 `future` 不再有效；每个输入的 `shared_future` 仍然有效。

返回值

一个引用由调用创建的共享状态的 `future`。该 `future` 始终为 valid()，当调用中的至少一个输入 `future` 和 `shared_future` 准备就绪时，它也准备就绪。`when_any_result` 的 `index` 成员包含 `futures` 成员中准备就绪的 `future` 或 `shared_future` 的位置。

1) 如果范围为空（即 first == last），返回的 `future` 立即准备就绪；`when_any_result` 的 `futures` 字段是一个空向量，`index` 字段为 size_t(-1)。

2) 如果未提供任何参数，返回的 `future` 立即准备就绪；`when_any_result` 的 `futures` 字段是一个空元组，`index` 字段为 size_t(-1)。