std::promise::set_value_at_thread_exit

From cppreference.com
< cpp‎ | thread‎ | promise
 
C++
 
Thread support library
Threads
(C++11)
this_thread namespace
(C++11)
(C++11)
(C++11)
(C++11)
Mutual exclusion
(C++11)
(C++11)
(C++17)
Generic lock management
(C++11)
(C++11)
(C++14)
(C++11)(C++11)(C++11)
(C++11)
(C++11)
(C++11)(C++11)(C++11)
(C++11)
(C++11)
Condition variables
(C++11)
(C++11)
(C++11)
(C++11)
Futures
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
 
std::promise
 
void set_value_at_thread_exit( const R& value );
 (1) (member only of generic promise template)
(since C++11)
void set_value_at_thread_exit( R&& value );
 (2) (member only of generic promise template)
(since C++11)
void set_value_at_thread_exit( R& value );
 (3) (member only of promise<R&> template specialization)
(since C++11)
void set_value_at_thread_exit()
 (4) (member only of promise<void> template specialization)
(since C++11)

Stores the value into the shared state without making the state ready immediately. The state is made ready when the current thread exits, after all variables with thread-local storage duration have been destroyed.

The operation is atomic, i.e. it behaves as though they acquire a single mutex associated with the promise object while updating the promise object.

An exception is thrown if there is no shared state or the shared state already stores a value or exception.

Contents

[edit] Parameters

value - value to store in the shared state

[edit] Return value

(none)

[edit] Exceptions

std::future_error on the following conditions:

  • *this has no shared state. The error category is set to no_state.

Additionally:

1-2) Any exception thrown by the copy constructor of value
3) Any exception thrown by the move constructor of value

[edit] Example

Run this code
#include <iostream>
#include <future>
#include <thread>
 
using namespace std::literals::chrono_literals;
int main()
{
    std::promise<int> p;
    std::future<int> f = p.get_future();
    std::thread([p=std::move(p)]() mutable {
          std::this_thread::sleep_for(5s);
          p.set_value_at_thread_exit(9);
    }).detach();
 
    std::cout << "Waiting..." << std::flush;
    f.wait();
    std::cout << "Done!\nResult is: " << f.get() << '\n';
}

Output: 

Waiting...Done!
Result is: 9

[edit] See also

sets the result to specific value
(public member function)
Retrieved from "http://en.cppreference.com/mwiki/index.php?title=cpp/thread/promise/set_value_at_thread_exit&oldid=78247"