C++11 std::future
and std::promise
在許多時候,我們會有這樣的需求——即我們想要得到線程返回的值。
但是在C++11 多線程中我們注意到,std::thread對象會忽略頂層函數的返回值。
那問題來了,我們要怎么獲得線程的返回值呢?
我們通過一個例子來說明如何實現這個需求。
假設我們的app會創建一個線程來壓縮一個文件夾,該線程在壓縮完文件夾后會返回壓縮文件 *.zip 和這個zip文件的大小,我們現在就想獲得這個線程的返回值。
有兩種方法可以實現這個需求:
1. 傳統的方法:在線程間共享指針
傳遞一個指針給壓縮文件的線程,表示壓縮文件的線程將會把值寫入指針指向的內存空間。此時主線程將用條件變量等待值被寫入,當壓縮文件線程把值寫入指針指定的內存后,將喚醒(signal)條件變量,然后主線程將被喚醒,然后從指針指向的內存中獲取返回值。
為了實現獲取一個返回值的需求,使用傳統的方法,我們需要條件變量(condition variable), 互斥量(mutex),和指針三個對象。
如果假設,我們需要獲得壓縮線程里三個返回值,情況會變得更加復雜。
那std::future就是來簡化這個編程過程的
2. C++11的方法:使用std::future和std::promise
人如其名,std::future和std::promise對象就和他們的名字一樣。這兩個類在獲取程序返回值的時候需要配合使用
std::future,是一個類模板,它存儲着一個未來的值。
那問題來了,未來的值是什么鬼?
實際上一個std::future對象里存儲着一個在未來會被賦值的變量,這個變量可以通過std::future提供的成員函數std::future::get()來得到。如果在這個變量被賦值之前就有別的線程試圖通過std::future::get()獲取這個變量,那么這個線程將會被阻塞到這個變量可以獲取為止。
std::promise同樣也是一個類模板,它的對象承諾會在未來設置變量(這個變量也就是std::future中的變量)。每一個std::promise對象都有一個與之關聯的std::future對象。當std::promise設置值的時候,這個值就會賦給std::future中的對象了。
我們一步一步來看一下如何做
- 在主線程中創建std::promise對象
std::promise<int> promiseObj;
上面定義的promise對象還沒有任何關聯的值。但是它承諾某個線程將會設置與其關聯的值,並且,當值被設置以后,可以通過與promise關聯的std::future
對象來獲取該值。
假設我們的主線程將創建的std::promise對象傳遞給了壓縮線程,那主線程要怎么知道壓縮線程已經設置好了值呢?
答案就是使用 std::future對象
// main thread
std::future<int> futureObj = promiseObj.get_future();
int val = futureObj.get();
// compression thread
promiseObj.set_value(45);
在compression thread未執行set_value()時,如果主線程調用了futureObj.get(),那么主線程將會被阻塞。
看整個時序圖:
最終代碼
#include<iostream> //std::cout std::endl
#include<thread> //std::thread
#include<future> //std::future std::promise
#include<utility> //std::ref
#include<chrono> //std::chrono::seconds
void initiazer(std::promise<int> &promiseObj){
std::cout << "Inside thread: " << std::this_thread::get_id() << std::endl;
std::this_thread::sleep_for(std::chrono::seconds(1));
promiseObj.set_value(35);
}
int main(){
std::promise<int> promiseObj;
std::future<int> futureObj = promiseObj.get_future();
std::thread th(initiazer, std::ref(promiseObj));
std::cout << futureObj.get() << std::endl;
th.join();
return 0;
}
本文參考於C++11 Multithreading – Part 8: std::future , std::promise and Returning values from Thread,並做了適當修改