Namespaces
Variants
Views
Actions

std::shared_future::get

From cppreference.com
< cpp‎ | thread‎ | shared future
Revision as of 21:02, 31 May 2013 by P12bot (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
const T& get() const;
(1) (member only of generic shared_future template)
(since C++11)
T& get() const;
(2) (member only of shared_future<T&> template specialization)
(since C++11)
void get() const;
(3) (member only of shared_future<void> template specialization)
(since C++11)

The get method waits until the shared_future has a valid result and (depending on which template is used) retrieves it. It effectively calls wait() in order to wait for the result.

The generic template and two template specializations each contain a single version of get. The three versions of get differ only in the return type.

The behavior is undefined if valid() is false before the call to this function.


Contents

[edit] Parameters

(none)

[edit] Return value

1) Const reference to the value stored in the shared state. Accessing the value through this reference is undefined after the shared state has been destroyed.
2) Reference to the value in the shared state.
3) Nothing.

[edit] Exceptions

If an exception was stored in the shared state referenced by the future (e.g. via a call to std::promise::set_exception()) then that exception will be thrown.

[edit] Notes

The implementations are encouraged to detect the case when valid() is false before the call and throw a std::future_error with an error condition of std::future_errc::no_state.

[edit] Example

[edit] See also

checks if the future has a shared state
(public member function) [edit]