c++ std::future , std::promise和线程的返回值

原文链接：std::future , std::promise和线程的返回值，https://thispointer.com/c11-multithreading-part-8-stdfuture-stdpromise-and-returning-values-from-thread/

• std::future对象可以和asych，std::packaged_task，std::promise一起使用。这篇文章集中讨论std::future和std::promise。
• 我们经常会遇到需要得到线程返回结果的情况，现在的问题是我们如何实现。
• 假设在程序中，我们创建了一个压缩给定文件夹的线程，并且我们希望该线程能够返回新的zip文件的名称和大小。
• 有两种实现方式：
• 1、老方法：使用指针在线程间共享数据

• 传递一个指针到新的线程中，该线程将在其中设置数据。直到主线程继续等待使用条件变量。当新线程设置数据并通知条件变量时，主线程将唤醒并从该指针处获取数据。
• 为了实现这一简单功能，我们使用了一个条件变量、一个mutex锁和一个指针，来实现捕获返回值。
• 如果我们想要该线程在不同的时间点返回3个不同的值，问题会变得更加复杂，有没有一种简单的方法来从线程处获取返回值呢？
• 答案是使用std::future

• 2、c++11的方法：使用std::future 和 std::promise

• std::future是一个类模板(class template)，其对象存储未来的值，
• 到底什么是未来的值呢？事实上，一个std::future对象在内部存储一个将来会被赋值的值，并提供了一个访问该值的机制，通过get()成员函数实现。但如果有人视图在get()函数可用之前通过它来访问相关的值，那么get()函数将会阻塞，直到该值可用。
• std::promise也是一个类模板，其对象有可能在将来会被人为赋值，每个std::promise对象有一个对应的std::future对象，一旦由std::promise对象设置，std::future将会对其赋值。
• std::promise对象与其管理的std::future对象共享数据。

• 在线程1中创建一个std::promise对象

std::promise promiseObj;

• 目前为止，该promise对象没有任何管理的值，但它承诺肯定会有人对其进行赋值，一旦被赋值，就可以通过其管理的std::future对象来获取该值。假设线程1创建了该promise对象并将其传给线程2，那么线程1怎样知道线程2什么时候会对promise对象进行赋值呢？
• 答案是使用std::future对象
• 每个std::promise对象都有个对应的std::future对象，其他人可以通过它来获取promise设置的值。所以，线程1将会创建std::promise对象，然后在将其传递给线程2之前从它那里获取std::future对象。

std::future futureObj = promiseObj.get_future();

• 现在，线程1将promiseObj传递给线程2，那么线程1将会获取到线程2通过std::future的get函数设置在std::promise中的值。

int val = futureObj.get();

• 但是如果线程2还没有对该值进行设置，那么这个调用将会阻塞，直到线程2在promise对象中对该值进行设置。

promiseObj.set_value(45);

 

• 看一个完整的std::future和std::promise的例子：

#include 
#include 
#include 
 
void initiazer(std::promise* promObj){
	std::cout<<"Inside Thread"<set_value(35);
}
 
int main(){
	std::promise promiseObj;
	std::future futureObj = promiseObj.get_future();
	std::thread th(initiazer, &promiseObj);
	std::cout<

• 如果std::promise对象在赋值之前被销毁，那么管理的std::future对象上的get()调用将会抛出异常。
• 除此之外，如果想要线程在不同时间点返回多个值，只需要在线程中传输多个std::promise对象，并从相关的多个std::futur对象中获取多个返回值。
   

std::future对象使用说明

std::future介绍

• thread对象，它是C++11中提供异步创建多线程的工具。但是我们想要从线程中返回异步任务结果，一般需要依靠全局变量；从安全角度看，有些不妥；为此C++11提供了std::future类模板，future对象提供访问异步操作结果的机制，很轻松解决从异步任务中返回结果。
• 在C++标准库中，有两种“期望”，使用两种类型模板实现：
• 唯一期望(unique futures，std::future<>) std::future的实例只能与一个指定事件相关联。
• 共享期望(shared futures)(std::shared_future<>) std::shared_future的实例就能关联多个事件。

这里主要介绍的是唯一期望，std::future类模板定义头文件,其函数声明如下：

template< class T > 
class future;
//数据有关的期望
template< class T > 
class future;
//数据无关的期望
template<>          
class future;

• std::async 、 std::packaged_task 或 std::promise 能提供一个std::future对象给该异步操作的创建者
• 异步操作的创建者能用各种方法查询、等待或从 std::future 提取值。若异步操作仍未提供值，则这些方法可能阻塞。
• 异步操作准备好发送结果给创建者时，它能通过接口（eg,std::promise::set_value std::future） 修改共享状态的值。

细节说明

• wait系列操作
• 其函数声明如下：

void wait() const;

• 当共享状态值是不可以用时，调用wait接口可以一直阻塞，直到共享状态变为"就绪"时，就变为可以用了。
• get操作
• get是获取共享状态的结果它有以下三种形式：

//仅为泛型 future 模板的成员
T get();
//(仅为 future 模板特化的成员)
T& get();
//仅为 future 模板特化的成员
void get();

• 如果我们没有调用wait接口，而是直接掉用get接口，它等价于先调用wait()而后在调用get接口，得到异步操作的结果。
• 当调用此方法后 valid() 为 false ，共享状态被释放，即future对象释一次性的事件。

时序图

• std::future对象的使用以及内部逻辑用时序图进行表达，如下：

std::future使用

• 下面就用std::future对象来获取异步操作的结果，没有使用到全局变量，逻辑非常清晰，代码如下：

//通过async来获取异步操作结果
std::future  result = std::async([](){ 
    std::this_thread::sleep_for(std::chrono::milliseconds(500));
    return 8; 
});

std::cout << "the future result : " << result.get() << std::endl;
std::cout << "the future status : " << result.valid() << std::endl;
try
{
    result.wait();  //或者 result.get() ,会异常
  //因此std::future只能用于单线程中调用 ，多线程调用使用std::share_future();
}
catch (...)
{
    std::cout << "get error....\n ";
}