std::promise<R>::set_value_at_thread_exit

From cppreference.com
< cpp‎ | thread‎ | promise
 
C++
 
Concurrency support library
Threads
(C++11)
(C++20)
(C++20)
(C++20)
(C++20)
(C++17)(C++17)    
this_thread namespace
(C++11)
(C++11)
(C++11)
(C++11)
Atomic types
(C++11)
(C++20)
(C++11)
Initialization of atomic types
(C++11)(deprecated in C++20)
(C++11)(deprecated in C++20)
(C++11)
Free functions for atomic operations
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)(C++11)
(C++11)
(C++20)(C++20)
(C++20)
(C++20)
Free functions for atomic flags
(C++11)(C++11)
(C++11)(C++11)
(C++20)(C++20)
(C++20)(C++20)
(C++20)
(C++20)
Memory ordering
(C++11)
(C++11)
(C++11)
(C++11)
Mutual exclusion
(C++11)
(C++11)
(C++17)
Generic lock management
(C++11)
(C++17)
(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)
Semaphores
(C++20)(C++20)
Latches and barriers
(C++20)
(C++20)
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 behaves as though set_value, set_exception, set_value_at_thread_exit, and set_exception_at_thread_exit 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.

Calls to this function do not introduce data races with calls to get_future (therefore they need not synchronize with each other).

Parameters

value - value to store in the shared state

Return value

(none)

Exceptions

std::future_error on the following conditions:

  • *this has no shared state. The error code 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

Example

Run this code
#include <iostream>
#include <future>
#include <thread>
 
int main()
{
    using namespace std::chrono_literals;
    std::promise<int> p;
    std::future<int> f = p.get_future();
    std::thread([&p] {
          std::this_thread::sleep_for(1s);
          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

See also

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