std::promise::set_value

 

C++

Language

Concepts

Utilities library

Strings library

Containers library

Algorithms library

Iterators library

Numerics library

Input/output library

Localizations library

Regular expressions library (C++11)

Atomic operations library (C++11)

Thread support library (C++11)

 

Thread support library

Threads
thread (C++11)
this_thread namespace
get_id (C++11) yield (C++11)	sleep_for (C++11) sleep_until (C++11)
Mutual exclusion
mutex (C++11) timed_mutex (C++11)	recursive_mutex (C++11) recursive_timed_mutex (C++11)
Generic lock management
lock_guard (C++11) unique_lock (C++11) defer_lock_t try_to_lock_t adopt_lock_t (C++11) (C++11) (C++11)	lock (C++11) try_lock (C++11) defer_lock try_to_lock adopt_lock (C++11) (C++11) (C++11)
Condition variables
condition_variable (C++11)
condition_variable_any (C++11)
notify_all_at_thread_exit (C++11)
cv_status (C++11)
Futures
promise (C++11) future (C++11) shared_future (C++11) packaged_task (C++11) async (C++11)	launch (C++11) future_status (C++11) future_error (C++11) future_category (C++11) future_errc (C++11)

 

std::promise

Member functions

promise::promise

promise::~promise

promise::operator=

promise::swap

Getting the result

promise::get_future

Setting the result

promise::set_value

promise::set_value_at_thread_exit

promise::set_exception

promise::set_exception_at_thread_exit

 

void set_value( const R& value );	(1)	(member only of generic promise template) (since C++11)
void set_value( R&& value );	(2)	(member only of generic promise template) (since C++11)
void set_value( R& value );	(3)	(member only of promise<R&> template specialization) (since C++11)
void set_value()	(4)	(member only of promise<void> template specialization) (since C++11)

Stores the value into the shared state and makes the state ready.

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.

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 category is set to no_state.

• The shared state already stores a value or exception. The error category is set to promise_already_satisfied.

Additionally:

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

3) Any exception thrown by the move constructor of value

See also

set_exception	sets the result to indicate an exception (public member function)