std::promise::get_future

From cppreference.com
< cpp‎ | thread‎ | promise
 
 
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)
Condition variables
(C++11)
Futures
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
(C++11)
 
 
std::future<T> get_future();
(since C++11)

Returns a future object associated with the same shared state as *this.

Exception is thrown if *this has no shared state or get_future has already been called. To get multiple "pop" ends of the promise-future communication channel, use std::future::share.

[edit] Parameters

(none)

[edit] Return value

A future referring to the shared state of *this

[edit] Exceptions

std::future_error on the following conditions:

  • *this has no shared state. The error category is set to no_state.
  • get_future() has already been called on a promise with the same shared state as *this. The error category is set to future_already_retrieved.