C++标准库笔记-多线程-低层接口Promise

前文C++标准库笔记-多线程-细说Future中，async()返回的future来实现线程之间传递结果和处理异常，class std::future<>允许你等待线程结束并获取其结果，可以获取到线程函数的返回值或者是一个异常；
那么高级接口如async()如何实现这一技术呢？
如果想要把参数传递给线程，可以把它们作为实参来传递；
如果想要把线程的运行结果，可以使用by reference方式传递；
另外一个用来传递运行结果和异常（结果的另外一种方式）的一般机制是：class std::promise.
下面记录我从《C++标准库》学习的笔记；

Promise

如同thread与async()的关系，promise和future也是一种配对关系，二者都能暂时持有一个shared state（用来表现一个结果值或一个异常）；但future object允许你使用get()取回数据，promise object却是需要使用者提供数据（set_…()函数群中的一个）。
下面借由一个例子，来学习promise怎么使用；

示例代码

#include <thread>
#include <future>
#include <string>
#include <exception>
#include <stdexcept>
#include <functional>
#include <utility>
#include <iostream>
using namespace std;

void doSomething(promise<string>& p)
{
	try
	{
		cout << "read char ('x' for exception): " << endl;
		char c = cin.get();
		if (c == 'x')
		{
			throw runtime_error(string("char ") + c + " read");
		}

		string s = string("char ") + c + " processed";
		p.set_value(std::move(s));
	}
	catch (...)
	{
		p.set_exception(current_exception());
	}
}

int main()
{
	try
	{
		promise<string> p;
		thread t(doSomething, std::ref(p));
		t.detach();

		future<string> f(p.get_future());
		cout << "result: " << f.get() << endl;
	}
	catch (const std::exception& e)
	{
		cerr << "EXCEPTION: " << e.what() << endl;
	}
	catch (...)
	{
		cerr << "EXCEPION " << endl;
	}
    system("pause");
}

代码刨析

声明promise object，需要令它针对“持有值”或“返回值”特化（如果两者都是none，就特化为void）：

std::promise<std::string> p;

promise内部会建立一个shared state，在这里被用来存放一个相应类型的值或一个异常，并可被future object取其数据当作线程结果；
然后这个promise随后被传给一个在分离线程(detached thread)中运行中的任务：

std::thread t(doSomething,std::ref(p));

借由ref确保了promise以by reference方式传递，使其状态得以被改变；
在分离线程中使用函数set_value或set_exception，便得以在promise中存放一个值或一个异常；

p.set_value(std::move(s));
p.set_exception(current_exception());

current_exception()函数会将当前异常以类型std::exception_ptr生成出来，如果当前并无异常就生成nullptr，这个异常会被存放于promise object内部；
一旦shared state存有某值或某个异常，其状态就会转变为ready。于是就可以在其他地方取出promise中的内容；
从promise中取出结果值或异常，需要借助“共享相同的shared state”的future object，所以需要调用promise的get_future()函数，建立起这一相应的future object，也可以在启动线程之前建立该future object；

std::future<std::string> f(p.get_future());

然后通过get()就可以取得“被存储的结果”或令“被存储的异常”再次被抛出，内部是针对被存储的exception_ptr调用std::rethrow_exception()；

promise成员函数

操作	效果
promise p	Default 构造函数；建立一个带shared state的promise
promise p(allocator_arg,alloc)	建立一个带shared state的promise，以alloc为分配器
promise p(rv)	Move构造函数；建立一个新的promise，它取rv的状态并从rv手中移走shared state
p.~promise()	释放shared state，并且如果它不是ready（也就是无值亦无异常），就存储一个future_error异常并夹带broken_promise
p = rv	Move assignment；move assign rv的状态至p。如果p不是ready，就存储一个future_error异常并夹带broken_promise
swap(p1,p2)	互换p1和p2的状态
p1.swap(p2)	互换p1和p2的状态
p.get_future()	产生一个future object用以取回shared state（那是线程的执行成果）
p.set_value(val)	设val为值并令状态为ready（或是抛出std::future_error）
p.set_value_at_thread_exit(val)	设val为值并令状态为ready——在当前线程结束时（或是抛出std::future_error）
p.set_exception(e)	设e为异常并令状态为ready（或是抛出std::future_error）
p.set_exception_at_thread_exit(e)	设e为异常并令状态为ready——在当前线程结束时（或是抛出std::future_error）

promise使用注意

注意：get()会停滞直到shared state成为ready——当promise的set_value()或set_exception()执行后便是如此。但这并不是意味着设定此promise的线程已经结束；该线程可能在执行其他的语句，甚至还会存储其他结果放入其他的promise中；
注意：如果想令shared state在线程确实结束时变成ready——以确保线程的local object及其他资源在“结果被处理之前”有所清除——你就不该调用set_value或set_exception，必须调用set_value_at_thread_exit()或set_exception_at_thread_exit()；
注意：不要对同一个promise对象多次进行set_value或者set_exception;
是因为在future中_Set_value_raw函数在锁定块中存储结果，直到线程结束都不能再向promise中写入数据，否则，报“mutex destroy while busy”；
注意：promise和future不限于解决多线程的问题，在单线程程序中同样可以使用promise持有一个结果或异常；
注意：同一个promise，不能既存储结果值又存储异常；如果这么做了，会导致future_error并带有错误码future_errc::promise_already_satisfied；
注意：只能调用get_future()一次，第二次调用会抛出std::future_error异常并带有错误码std::future_errc::future_already_retrieved。如果没有相应的shared state，则该调用会抛出std::future_error异常并带着错误码std::future_errc::no_state;
注意：所有用来设定数值或异常的成员函数都是线程安全的；

文献

1.《C++标准库》第二版；