< cpp‎ | thread‎ | future
Revision as of 21:00, 31 May 2013 by P12bot (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
template< class Rep, class Period >
std::future_status wait_for( const std::chrono::duration<Rep,Period>& timeout_duration ) const;
(since C++11)

Waits for the result to become available. Blocks until specified timeout_duration has elapsed or the result becomes available, whichever comes first. Returns value identifies the state of the result.

A steady clock is used to measure the duration. This function may block for longer than timeout_duration due to scheduling or resource contention delays.

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


[edit] Parameters

timeout_duration - maximum duration to block for

[edit] Return value

Constant Explanation
future_status::deferred The function to calculate the result has not been started yet
future_status::ready The result is ready
future_status::timeout The timeout has expired

[edit] Exceptions

Any exception thrown by clock, time_point, or duration during the execution (clocks, time points, and durations provided by the standard library never throw)

[edit] Notes

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

[edit] Example

#include <iostream>
#include <future>
#include <thread>
#include <chrono>
int main()
    std::future<int> future = std::async(std::launch::async, [](){ 
        return 8;  
    std::cout << "waiting...\n";
    std::future_status status;
    do {
        status = future.wait_for(std::chrono::seconds(1));
        if (status == std::future_status::deferred) {
            std::cout << "deferred\n";
        } else if (status == std::future_status::timeout) {
            std::cout << "timeout\n";
        } else if (status == std::future_status::ready) {
            std::cout << "ready!\n";
    } while (status != std::future_status::ready); 
    std::cout << "result is " << future.get() << '\n';

Possible output:

result is 8

[edit] See also

waits for the result to become available
(public member function) [edit]
waits for the result, returns if it is not available until specified time point has been reached
(public member function) [edit]