Namespaces
Variants
Views
Actions

std::future::share

From cppreference.com
< cpp‎ | thread‎ | future
 
 
Thread support library
Threads
(C++11)
this_thread namespace
(C++11)
(C++11)
(C++11)
Mutual exclusion
(C++11)
Generic lock management
(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)
(C++11)
(C++11)
Condition variables
(C++11)
Futures
(C++11)
(C++11)
(C++11)
(C++11)
 
 
std::shared_future<T> share();

Transfers the shared state of *this, if any, to a std::shared_future object. Multiple std::shared_future objects may reference the same shared state, which is not possible with std::future.

After calling share on a std::future, valid() == false.

Contents

[edit] Parameters

(none)

[edit] Return value

A std::shared_future object containing the shared state previously held by *this, if any, constructed as if by std::shared_future<T>(std:move(*this)).

[edit] Exceptions

noexcept specification:  
noexcept
  

[edit] Example

[edit] Defect reports

The following behavior-changing defect reports were applied retroactively to previously published C++ standards.

DR Applied to Behavior as published Correct behavior
LWG 2556 C++11 share() requires valid() to be true requirement removed and made noexcept

[edit] See also

waits for a value (possibly referenced by other futures) that is set asynchronously
(class template) [edit]