hpx::wait_all#
Defined in header hpx/future.hpp.
See Public API for a list of names and headers that are part of the public HPX API.
See also:
-
template<typename InputIter>
void hpx::wait_all(InputIter first, InputIter last)# The function wait_all is an operator allowing to join on the result of all given futures. It AND-composes all future objects given and returns after they finished executing.
Note
The function wait_all returns after all futures have become ready. All input futures are still valid after wait_all returns.
Note
The function wait_all will rethrow any exceptions captured by the futures while becoming ready. If this behavior is undesirable, use wait_all_nothrow instead.
Note
The caller is responsible for keeping the futures container alive, unmoved, and unmodified until wait_all returns and all inspection of the futures is complete.
- Parameters:
first – The iterator pointing to the first element of a sequence of future or shared_future objects for which wait_all should wait.
last – The iterator pointing to the element after the last one of a sequence of future or shared_future objects for which wait_all should wait.
-
template<typename R>
void hpx::wait_all(std::vector<future<R>> &&futures)# The function wait_all is an operator allowing to join on the result of all given futures. It AND-composes all future objects given and returns after they finished executing.
Note
The function wait_all returns after all futures have become ready. All input futures are still valid after wait_all returns.
Note
The function wait_all will rethrow any exceptions captured by the futures while becoming ready. If this behavior is undesirable, use wait_all_nothrow instead.
Note
The caller is responsible for keeping the futures container alive, unmoved, and unmodified until wait_all returns and all inspection of the futures is complete.
- Parameters:
futures – A vector or array holding an arbitrary amount of future or shared_future objects for which wait_all should wait.
-
template<typename R, std::size_t N>
void hpx::wait_all(std::array<future<R>, N> &&futures)# The function wait_all is an operator allowing to join on the result of all given futures. It AND-composes all future objects given and returns after they finished executing.
Note
The function wait_all returns after all futures have become ready. All input futures are still valid after wait_all returns.
Note
The function wait_all will rethrow any exceptions captured by the futures while becoming ready. If this behavior is undesirable, use wait_all_nothrow instead.
Note
The caller is responsible for keeping the futures container alive, unmoved, and unmodified until wait_all returns and all inspection of the futures is complete.
- Parameters:
futures – A vector or array holding an arbitrary amount of future or shared_future objects for which wait_all should wait.
-
template<typename T>
void hpx::wait_all(hpx::future<T> const &f)# The function wait_all is an operator allowing to join on the result of all given futures. It AND-composes all future objects given and returns after they finished executing.
Note
The function wait_all returns after the future has become ready. The input future is still valid after wait_all returns.
Note
The function wait_all will rethrow any exceptions captured by the future while becoming ready. If this behavior is undesirable, use wait_all_nothrow instead.
- Parameters:
f – A future or shared_future for which wait_all should wait.
-
template<typename ...T>
void hpx::wait_all(T&&... futures)# The function wait_all is an operator allowing to join on the result of all given futures. It AND-composes all future objects given and returns after they finished executing.
Note
The function wait_all returns after all futures have become ready. All input futures are still valid after wait_all returns.
Note
The function wait_all will rethrow any exceptions captured by the futures while becoming ready. If this behavior is undesirable, use wait_all_nothrow instead.
- Parameters:
futures – An arbitrary number of future or shared_future objects, possibly holding different types for which wait_all should wait.