<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <meta http-equiv="X-UA-Compatible" content="IE=9"/> <meta name="generator" content="Doxygen 1.8.13"/> <meta name="viewport" content="width=device-width, initial-scale=1"/> <title>libstdc++: std::future< _Res & > Class Template Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="jquery.js"></script> <script type="text/javascript" src="dynsections.js"></script> <link href="navtree.css" rel="stylesheet" type="text/css"/> <script type="text/javascript" src="resize.js"></script> <script type="text/javascript" src="navtreedata.js"></script> <script type="text/javascript" src="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); </script> <link href="doxygen.css" rel="stylesheet" type="text/css" /> </head> <body> <div id="top"><!-- do not remove this div, it is closed by doxygen! --> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td id="projectalign" style="padding-left: 0.5em;"> <div id="projectname">libstdc++ </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.13 --> </div><!-- top --> <div id="side-nav" class="ui-resizable side-nav-resizable"> <div id="nav-tree"> <div id="nav-tree-contents"> <div id="nav-sync" class="sync"></div> </div> </div> <div id="splitbar" style="-moz-user-select:none;" class="ui-resizable-handle"> </div> </div> <script type="text/javascript"> $(document).ready(function(){initNavTree('a02765.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#pub-types">Public Types</a> | <a href="#pub-methods">Public Member Functions</a> | <a href="#pub-static-methods">Static Public Member Functions</a> | <a href="#pro-types">Protected Types</a> | <a href="#pro-methods">Protected Member Functions</a> | <a href="#friends">Friends</a> | <a href="a02762.html">List of all members</a> </div> <div class="headertitle"> <div class="title">std::future< _Res & > Class Template Reference<div class="ingroups"><a class="el" href="a01417.html">Concurrency</a> » <a class="el" href="a01422.html">Futures</a></div></div> </div> </div><!--header--> <div class="contents"> <div class="dynheader"> Inheritance diagram for std::future< _Res & >:</div> <div class="dyncontent"> <div class="center"><iframe scrolling="no" frameborder="0" src="a02764.svg" width="146" height="196"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe> </div> <center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a> Public Types</h2></td></tr> <tr class="memitem:a832cc3cad4729e395bea2475e1b3a741"><td class="memTemplParams" colspan="2">template<typename _Res > </td></tr> <tr class="memitem:a832cc3cad4729e395bea2475e1b3a741"><td class="memTemplItemLeft" align="right" valign="top">using </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="a02673.html#a832cc3cad4729e395bea2475e1b3a741">_Ptr</a> = <a class="el" href="a06853.html">unique_ptr</a>< _Res, _Result_base::_Deleter ></td></tr> <tr class="separator:a832cc3cad4729e395bea2475e1b3a741"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac8ced3b29c8d9221a9ae084afd66093b"><td class="memItemLeft" align="right" valign="top"><a id="ac8ced3b29c8d9221a9ae084afd66093b"></a> using </td><td class="memItemRight" valign="bottom"><b>_State_base</b> = _State_baseV2</td></tr> <tr class="separator:ac8ced3b29c8d9221a9ae084afd66093b"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a> Public Member Functions</h2></td></tr> <tr class="memitem:a290550ce931d18ccad7d296e4875ddb3"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="a02765.html#a290550ce931d18ccad7d296e4875ddb3">future</a> (<a class="el" href="a02657.html">future</a> &&__uf) noexcept</td></tr> <tr class="separator:a290550ce931d18ccad7d296e4875ddb3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac08b6af48a83ba0d056df355b687bdb3"><td class="memItemLeft" align="right" valign="top"><a id="ac08b6af48a83ba0d056df355b687bdb3"></a>  </td><td class="memItemRight" valign="bottom"><b>future</b> (const <a class="el" href="a02657.html">future</a> &)=delete</td></tr> <tr class="separator:ac08b6af48a83ba0d056df355b687bdb3"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a02dd6ce87e29a3baadfc1061430df774"><td class="memItemLeft" align="right" valign="top">_Res & </td><td class="memItemRight" valign="bottom"><a class="el" href="a02765.html#a02dd6ce87e29a3baadfc1061430df774">get</a> ()</td></tr> <tr class="separator:a02dd6ce87e29a3baadfc1061430df774"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a79a263363601c5fe55e69da98d68cab4"><td class="memItemLeft" align="right" valign="top"><a id="a79a263363601c5fe55e69da98d68cab4"></a> <a class="el" href="a02657.html">future</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (const <a class="el" href="a02657.html">future</a> &)=delete</td></tr> <tr class="separator:a79a263363601c5fe55e69da98d68cab4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac08caea6a869da42e83f13551a53318b"><td class="memItemLeft" align="right" valign="top"><a id="ac08caea6a869da42e83f13551a53318b"></a> <a class="el" href="a02657.html">future</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="a02657.html">future</a> &&__fut) noexcept</td></tr> <tr class="separator:ac08caea6a869da42e83f13551a53318b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ac9c7e3197ca43efc0b94d613a5b80505"><td class="memItemLeft" align="right" valign="top"><a id="ac9c7e3197ca43efc0b94d613a5b80505"></a> <a class="el" href="a02661.html">shared_future</a>< _Res & > </td><td class="memItemRight" valign="bottom"><b>share</b> ()</td></tr> <tr class="separator:ac9c7e3197ca43efc0b94d613a5b80505"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a88fd6c028a80fd3664f02ba6ea26ec63"><td class="memItemLeft" align="right" valign="top"><a id="a88fd6c028a80fd3664f02ba6ea26ec63"></a> bool </td><td class="memItemRight" valign="bottom"><b>valid</b> () const noexcept</td></tr> <tr class="separator:a88fd6c028a80fd3664f02ba6ea26ec63"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5ceb9b34ec347b6a3f05164809b8f300"><td class="memItemLeft" align="right" valign="top"><a id="a5ceb9b34ec347b6a3f05164809b8f300"></a> void </td><td class="memItemRight" valign="bottom"><b>wait</b> () const</td></tr> <tr class="separator:a5ceb9b34ec347b6a3f05164809b8f300"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:acab3bc59f416109486f8925bdb9c870f"><td class="memItemLeft" align="right" valign="top"><a id="acab3bc59f416109486f8925bdb9c870f"></a> <a class="el" href="a01422.html#ga528eb8f3b350394c0406d4d58ab7dbf4">future_status</a> </td><td class="memItemRight" valign="bottom"><b>wait_for</b> (const <a class="el" href="a01773.html">chrono::duration</a>< _Rep, _Period > &__rel) const</td></tr> <tr class="separator:acab3bc59f416109486f8925bdb9c870f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a35396a432f77cc1631b8434ddd9cad6e"><td class="memItemLeft" align="right" valign="top"><a id="a35396a432f77cc1631b8434ddd9cad6e"></a> <a class="el" href="a01422.html#ga528eb8f3b350394c0406d4d58ab7dbf4">future_status</a> </td><td class="memItemRight" valign="bottom"><b>wait_until</b> (const <a class="el" href="a01777.html">chrono::time_point</a>< _Clock, _Duration > &__abs) const</td></tr> <tr class="separator:a35396a432f77cc1631b8434ddd9cad6e"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a> Static Public Member Functions</h2></td></tr> <tr class="memitem:acce430d2440c7dcad1e304ac25ab01eb"><td class="memTemplParams" colspan="2"><a id="acce430d2440c7dcad1e304ac25ab01eb"></a> template<typename _Res , typename _Allocator > </td></tr> <tr class="memitem:acce430d2440c7dcad1e304ac25ab01eb"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="a02673.html#a832cc3cad4729e395bea2475e1b3a741">_Ptr</a>< <a class="el" href="a02689.html">_Result_alloc</a>< _Res, _Allocator > > </td><td class="memTemplItemRight" valign="bottom"><b>_S_allocate_result</b> (const _Allocator &__a)</td></tr> <tr class="separator:acce430d2440c7dcad1e304ac25ab01eb"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:aaabd993cb789d1d0670699bbf34fa44b"><td class="memTemplParams" colspan="2"><a id="aaabd993cb789d1d0670699bbf34fa44b"></a> template<typename _Res , typename _Tp > </td></tr> <tr class="memitem:aaabd993cb789d1d0670699bbf34fa44b"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="a02673.html#a832cc3cad4729e395bea2475e1b3a741">_Ptr</a>< <a class="el" href="a02685.html">_Result</a>< _Res > > </td><td class="memTemplItemRight" valign="bottom"><b>_S_allocate_result</b> (const <a class="el" href="a04137.html">std::allocator</a>< _Tp > &__a)</td></tr> <tr class="separator:aaabd993cb789d1d0670699bbf34fa44b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga375deada08a36f6aa58f47771811d65b"><td class="memTemplParams" colspan="2"> template<typename _BoundFn > </td></tr> <tr class="memitem:ga375deada08a36f6aa58f47771811d65b"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="a06085.html">std::shared_ptr</a>< _State_base > </td><td class="memTemplItemRight" valign="bottom"><b>_S_make_async_state</b> (_BoundFn &&__fn)</td></tr> <tr class="separator:ga375deada08a36f6aa58f47771811d65b"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga3369fca66866fa01dbf00aa5b322b3d9"><td class="memTemplParams" colspan="2"> template<typename _BoundFn > </td></tr> <tr class="memitem:ga3369fca66866fa01dbf00aa5b322b3d9"><td class="memTemplItemLeft" align="right" valign="top">static <a class="el" href="a06085.html">std::shared_ptr</a>< _State_base > </td><td class="memTemplItemRight" valign="bottom"><b>_S_make_deferred_state</b> (_BoundFn &&__fn)</td></tr> <tr class="separator:ga3369fca66866fa01dbf00aa5b322b3d9"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:accf70d948921733750f138b5b49e836d"><td class="memTemplParams" colspan="2"><a id="accf70d948921733750f138b5b49e836d"></a> template<typename _Res_ptr , typename _BoundFn > </td></tr> <tr class="memitem:accf70d948921733750f138b5b49e836d"><td class="memTemplItemLeft" align="right" valign="top">static _Task_setter< _Res_ptr, _BoundFn > </td><td class="memTemplItemRight" valign="bottom"><b>_S_task_setter</b> (_Res_ptr &__ptr, _BoundFn &__call)</td></tr> <tr class="separator:accf70d948921733750f138b5b49e836d"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-types"></a> Protected Types</h2></td></tr> <tr class="memitem:a748614f7a0518bf851f65aca7674c0f5"><td class="memItemLeft" align="right" valign="top"><a id="a748614f7a0518bf851f65aca7674c0f5"></a> typedef <a class="el" href="a02685.html">__future_base::_Result</a>< _Res & > & </td><td class="memItemRight" valign="bottom"><b>__result_type</b></td></tr> <tr class="separator:a748614f7a0518bf851f65aca7674c0f5"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a> Protected Member Functions</h2></td></tr> <tr class="memitem:a71d62e5218e561c5c4507eb3e7f70474"><td class="memItemLeft" align="right" valign="top"><a class="el" href="a02685.html">__result_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a02757.html#a71d62e5218e561c5c4507eb3e7f70474">_M_get_result</a> () const</td></tr> <tr class="separator:a71d62e5218e561c5c4507eb3e7f70474"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a5c8360e51da774112201f64bcf3e8f3e"><td class="memItemLeft" align="right" valign="top"><a id="a5c8360e51da774112201f64bcf3e8f3e"></a> void </td><td class="memItemRight" valign="bottom"><b>_M_swap</b> (<a class="el" href="a02757.html">__basic_future</a> &__that) noexcept</td></tr> <tr class="separator:a5c8360e51da774112201f64bcf3e8f3e"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a> Friends</h2></td></tr> <tr class="memitem:a3e346987d6e9fd8c1ea01e129ac9d719"><td class="memTemplParams" colspan="2"><a id="a3e346987d6e9fd8c1ea01e129ac9d719"></a> template<typename _Fn , typename... _Args> </td></tr> <tr class="memitem:a3e346987d6e9fd8c1ea01e129ac9d719"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="a02657.html">future</a>< typename result_of< _Fn(_Args...)>::type > </td><td class="memTemplItemRight" valign="bottom"><b>async</b> (<a class="el" href="a01422.html#ga6f4ad125d364f01560e2ed20a3c8bb5b">launch</a>, _Fn &&, _Args &&...)</td></tr> <tr class="separator:a3e346987d6e9fd8c1ea01e129ac9d719"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a01a090c398a08d8c1a25a8f2f3e4ec6a"><td class="memTemplParams" colspan="2"><a id="a01a090c398a08d8c1a25a8f2f3e4ec6a"></a> template<typename > </td></tr> <tr class="memitem:a01a090c398a08d8c1a25a8f2f3e4ec6a"><td class="memTemplItemLeft" align="right" valign="top">class </td><td class="memTemplItemRight" valign="bottom"><b>packaged_task</b></td></tr> <tr class="separator:a01a090c398a08d8c1a25a8f2f3e4ec6a"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:a71d095025365c8c5e01fef1a370aa0c1"><td class="memItemLeft" align="right" valign="top"><a id="a71d095025365c8c5e01fef1a370aa0c1"></a> class </td><td class="memItemRight" valign="bottom"><b>promise< _Res &></b></td></tr> <tr class="separator:a71d095025365c8c5e01fef1a370aa0c1"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <div class="textblock"><h3>template<typename _Res><br /> class std::future< _Res & ></h3> <p>Partial specialization for future<R&> </p> <p class="definition">Definition at line <a class="el" href="a00068_source.html#l00767">767</a> of file <a class="el" href="a00068_source.html">future</a>.</p> </div><h2 class="groupheader">Member Typedef Documentation</h2> <a id="a832cc3cad4729e395bea2475e1b3a741"></a> <h2 class="memtitle"><span class="permalink"><a href="#a832cc3cad4729e395bea2475e1b3a741">◆ </a></span>_Ptr</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Res > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">using <a class="el" href="a02673.html#a832cc3cad4729e395bea2475e1b3a741">std::__future_base::_Ptr</a> = <a class="el" href="a06853.html">unique_ptr</a><_Res, _Result_base::_Deleter></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inherited</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>A unique_ptr for result objects. </p> <p class="definition">Definition at line <a class="el" href="a00068_source.html#l00207">207</a> of file <a class="el" href="a00068_source.html">future</a>.</p> </div> </div> <h2 class="groupheader">Constructor & Destructor Documentation</h2> <a id="a290550ce931d18ccad7d296e4875ddb3"></a> <h2 class="memtitle"><span class="permalink"><a href="#a290550ce931d18ccad7d296e4875ddb3">◆ </a></span>future()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Res > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a02657.html">std::future</a>< _Res & >::<a class="el" href="a02657.html">future</a> </td> <td>(</td> <td class="paramtype"><a class="el" href="a02657.html">future</a>< _Res & > && </td> <td class="paramname"><em>__uf</em></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">noexcept</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Move constructor. </p> <p class="definition">Definition at line <a class="el" href="a00068_source.html#l00785">785</a> of file <a class="el" href="a00068_source.html">future</a>.</p> </div> </div> <h2 class="groupheader">Member Function Documentation</h2> <a id="a71d62e5218e561c5c4507eb3e7f70474"></a> <h2 class="memtitle"><span class="permalink"><a href="#a71d62e5218e561c5c4507eb3e7f70474">◆ </a></span>_M_get_result()</h2> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname"><a class="el" href="a02685.html">__result_type</a> <a class="el" href="a02757.html">std::__basic_future</a>< _Res & >::_M_get_result </td> <td>(</td> <td class="paramname"></td><td>)</td> <td> const</td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span><span class="mlabel">inherited</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Wait for the state to be ready and rethrow any stored exception. </p> <p class="definition">Definition at line <a class="el" href="a00068_source.html#l00677">677</a> of file <a class="el" href="a00068_source.html">future</a>.</p> </div> </div> <a id="a02dd6ce87e29a3baadfc1061430df774"></a> <h2 class="memtitle"><span class="permalink"><a href="#a02dd6ce87e29a3baadfc1061430df774">◆ </a></span>get()</h2> <div class="memitem"> <div class="memproto"> <div class="memtemplate"> template<typename _Res > </div> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">_Res& <a class="el" href="a02657.html">std::future</a>< _Res & >::get </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">inline</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Retrieving the value. </p> <p class="definition">Definition at line <a class="el" href="a00068_source.html#l00799">799</a> of file <a class="el" href="a00068_source.html">future</a>.</p> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="a00068_source.html">future</a></li> </ul> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="navelem"><a class="el" href="a01487.html">std</a></li><li class="navelem"><a class="el" href="a02765.html">future< _Res & ></a></li> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> </ul> </div> </body> </html>