C++ future使用

前言：对比Java 线程通过run(callable)返回的future，C++ 11便准库提供了future来提供了一种访问异步操作结果的机制，从字面意思来理解，它表示未来，我觉得这个名字非常贴切，因为一个异步操作我们是不可能马上就获取操作结果的，只能在未来某个时候获取，但是我们可以以同步等待的方式来获取结果，可以通过查询future的状态（future_status）来获取异步操作的结果。
future_status有三种状态：

1. deferred：异步操作还没开始
2. ready：异步操作已经完成
3. timeout：异步操作超时
   //查询future的状态

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::future成员函数包括：

1. 构造函数：(1).不带参数的默认构造函数，此对象没有共享状态，因此它是无效的，但是可以通过移动赋值的方式将一个有效的future值赋值给它；(2).禁用拷贝构造；(3).支持移动构造。

2. 析构函数：销毁future对象，它是异常安全的。

3. get函数：(1).当共享状态就绪时，返回存储在共享状态中的值(或抛出异常)。(2).如果共享状态尚未就绪(即提供者尚未设置其值或异常)，则该函数将阻塞调用的线程直到就绪。(3).当共享状态就绪后，则该函数将取消阻塞并返回(或抛出)释放其共享状态，这使得future对象不再有效，因此对于每一个future共享状态，该函数最多应被调用一次。(4).std::future::get()不返回任何值，但仍等待共享状态就绪并释放它。(5).共享状态是作为原子操作(atomic operation)被访问。

4. operator=：(1).禁用拷贝赋值。(2).支持移动赋值：如果在调用之前，此对象是有效的(即它已经访问共享状态)，则将其与先前已关联的共享状态解除关联。如果它是与先前共享状态关联的唯一对象，则先前的共享状态也会被销毁。

5. share函数：获取共享的future，返回一个std::shared_future对象，该对象获取future对象的共享状态。future对象将不再有效。

6. valid函数：检查共享状态的有效性，返回当前的future对象是否与共享状态关联。一旦调用了std::future::get()函数，再调用此函数将返回false。

7. wait函数：(1).等待共享状态就绪。(2).如果共享状态尚未就绪(即提供者尚未设置其值或异常)，则该函数将阻塞调用的线程直到就绪。(3).当共享状态就绪后，则该函数将取消阻塞并void返回。

8. wait_for函数：(1).等待共享状态在指定的时间内(time span)准备就绪。(2). 如果共享状态尚未就绪(即提供者尚未设置其值或异常)，则该函数将阻塞调用的线程直到就绪或已达到设置的时间。(3).此函数的返回值类型为枚举类future_status。此枚举类有三种label：ready：共享状态已就绪；timeout：在指定的时间内未就绪；deferred：共享状态包含了一个延迟函数(deferred function)。

9. wait_until函数：(1). 等待共享状态在指定的时间点(time point)准备就绪。(2). 如果共享状态尚未就绪(即提供者尚未设置其值或异常)，则该函数将阻塞调用的线程直到就绪或已达到指定的时间点。(3).此函数的返回值类型为枚举类future_status。

#include "future.hpp"
#include <iostream>
#include <future>
#include <chrono>
#include <utility>
#include <thread>
  
namespace future_ {
  
///
// reference: http://www.cplusplus.com/reference/future/future/
int test_future_1()
{
{ // constructor/get/operator=
 auto get_value = []() { return 10; };
 std::future<int> foo; // default-constructed
 std::future<int> bar = std::async(get_value); // move-constructed
  
 int x = bar.get();
 std::cout << "value: " << x << '\n'; // 10
  
 //int x2 = bar.get(); // crash, 对于每个future的共享状态，get函数最多仅被调用一次
 //std::cout << "value: " << x2 << '\n';
  
 std::future<int> foo2(std::async(get_value));
 std::cout << "value: " << foo2.get() << '\n'; // 10
}
  
{ // share
 std::future<int> fut = std::async([]() { return 10; });
 std::shared_future<int> shfut = fut.share();
  
 //std::cout << "value: " << fut.get() << '\n'; // crash, 执行完fut.share()后，fut对象将变得无效
 std::cout << "fut valid: " << fut.valid() << '\n';// 0
  
 // shared futures can be accessed multiple times:
 std::cout << "value: " << shfut.get() << '\n'; // 10
 std::cout << "its double: " << shfut.get() * 2 << '\n'; // 20, 对于std::shared_future对象，get函数可以被多次访问
}
  
{ // valid
 std::future<int> foo, bar;
 foo = std::async([]() { return 10; });
 bar = std::move(foo);
  
 if (foo.valid()) std::cout << "foo's value: " << foo.get() << '\n';
 else std::cout << "foo is not valid\n"; // foo is not valid
  
 if (bar.valid()) std::cout << "bar's value: " << bar.get() << '\n'; // 10
 else std::cout << "bar is not valid\n";
}
  
{ // wait
 auto is_prime = [](int x) {
 for (int i = 2; i < x; ++i) if (x%i == 0) return false;
 return true;
 };
  
 // call function asynchronously:
 std::future<bool> fut = std::async(is_prime, 194232491);
  
 std::cout << "checking...\n";
 fut.wait();
  
 std::cout << "\n194232491 ";
 if (fut.get()) // guaranteed to be ready (and not block) after wait returns
 std::cout << "is prime.\n";
 else
 std::cout << "is not prime.\n";
}
  
{ // wait_for
 auto is_prime = [](int x) {
 for (int i = 2; i < x; ++i) if (x%i == 0) return false;
 return true;
 };
  
 // call function asynchronously:
 std::future<bool> fut = std::async(is_prime, 700020007);
  
 // do something while waiting for function to set future:
 std::cout << "checking, please wait";
 std::chrono::milliseconds span(100);
 while (fut.wait_for(span) == std::future_status::timeout) // 可能多次调用std::future::wait_for函数
 std::cout << '.';
  
 bool x = fut.get(); // retrieve return value
 std::cout << "\n700020007 " << (x ? "is" : "is not") << " prime.\n";
}
  
 return 0;
}
  
///
// reference: https://en.cppreference.com/w/cpp/thread/future
int test_future_2()
{
 // future from a packaged_task
 std::packaged_task<int()> task([] { return 7; }); // wrap the function
 std::future<int> f1 = task.get_future(); // get a future
 std::thread t(std::move(task)); // launch on a thread
  
 // future from an async()
 std::future<int> f2 = std::async(std::launch::async, [] { return 8; });
  
#ifdef _MSC_VER
 // future from a promise
 std::promise<int> p;
 std::future<int> f3 = p.get_future();
 std::thread([&p] { p.set_value_at_thread_exit(9); }).detach(); // gcc 4.9 don't support this function
#endif
  
 std::cout << "Waiting..." << std::flush;
 f1.wait();
 f2.wait();
#ifdef _MSC_VER
 f3.wait();
#endif
 std::cout << "Done!\nResults are: " << f1.get() << ' ' << f2.get() << ' '
#ifdef _MSC_VER
 << f3.get()
#endif
 << '\n';
 t.join();
  
 return 0;
}
  
///
// reference: https://thispointer.com/c11-multithreading-part-8-stdfuture-stdpromise-and-returning-values-from-thread/
void initiazer(std::promise<int> * promObj)
{
 std::cout << "Inside Thread" << std::endl;
 promObj->set_value(35);
}
  
int test_future_3()
{
 std::promise<int> promiseObj;
 std::future<int> futureObj = promiseObj.get_future();
 std::thread th(initiazer, &promiseObj);
 std::cout << "value: " << futureObj.get() << std::endl;
 th.join();
  
 // If std::promise object is destroyed before setting the value the calling get() function on associated std::future object will throw exception.
 // A part from this, if you want your thread to return multiple values at different point of time then
 // just pass multiple std::promise objects in thread and fetch multiple return values from thier associated multiple std::future objects.
  
 return 0;
}
  
} // namespace future_