<!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.3"/> <title>libstdc++: Futures</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="navtree.js"></script> <script type="text/javascript"> $(document).ready(initResizable); $(window).load(resizeHeight); </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 style="padding-left: 0.5em;"> <div id="projectname">libstdc++ </div> </td> </tr> </tbody> </table> </div> <!-- end header part --> <!-- Generated by Doxygen 1.8.3 --> </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('a01634.html','');}); </script> <div id="doc-content"> <div class="header"> <div class="summary"> <a href="#nested-classes">Classes</a> | <a href="#enum-members">Enumerations</a> | <a href="#func-members">Functions</a> </div> <div class="headertitle"> <div class="title">Futures<div class="ingroups"><a class="el" href="a01629.html">Concurrency</a></div></div> </div> </div><!--header--> <div class="contents"> <div class="dynheader"> Collaboration diagram for Futures:</div> <div class="dyncontent"> <center><table><tr><td><img src="a01634.png" border="0" alt="" usemap="#a01634"/> <map name="a01634" id="a01634"> <area shape="rect" id="node1" href="a01630.html" title="Exceptions" alt="" coords="349,6,432,31"/><area shape="rect" id="node3" href="a01629.html" title="Concurrency" alt="" coords="6,6,98,31"/></map> </td></tr></table></center> </div> <table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> Classes</h2></td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00670.html">std::future_error</a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="a00757.html">std::is_error_code_enum< future_errc ></a></td></tr> <tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a> Enumerations</h2></td></tr> <tr class="memitem:ga61938f7ac25df97b5362109e61bb46a6"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a01634.html#ga61938f7ac25df97b5362109e61bb46a6">std::future_errc</a> { <b>future_already_retrieved</b>, <b>promise_already_satisfied</b>, <b>no_state</b>, <b>broken_promise</b> }</td></tr> <tr class="separator:ga61938f7ac25df97b5362109e61bb46a6"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga528eb8f3b350394c0406d4d58ab7dbf4"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a01634.html#ga528eb8f3b350394c0406d4d58ab7dbf4">std::future_status</a> { <b>ready</b>, <b>timeout</b>, <b>deferred</b> }</td></tr> <tr class="separator:ga528eb8f3b350394c0406d4d58ab7dbf4"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga6f4ad125d364f01560e2ed20a3c8bb5b"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="a01634.html#ga6f4ad125d364f01560e2ed20a3c8bb5b">std::launch</a> { <b>async</b>, <b>deferred</b> }</td></tr> <tr class="separator:ga6f4ad125d364f01560e2ed20a3c8bb5b"><td class="memSeparator" colspan="2"> </td></tr> </table><table class="memberdecls"> <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a> Functions</h2></td></tr> <tr class="memitem:ga2c137820d42d02b5ec79d0ced40e69f0"><td class="memTemplParams" colspan="2"><a class="anchor" id="ga2c137820d42d02b5ec79d0ced40e69f0"></a> template<typename _Fn , typename... _Args> </td></tr> <tr class="memitem:ga2c137820d42d02b5ec79d0ced40e69f0"><td class="memTemplItemLeft" align="right" valign="top">future< typename <a class="el" href="a00466.html">result_of</a><br class="typebreak"/> < _Fn(_Args...)>::type > </td><td class="memTemplItemRight" valign="bottom"><b>std::async</b> (launch __policy, _Fn &&__fn, _Args &&...__args)</td></tr> <tr class="separator:ga2c137820d42d02b5ec79d0ced40e69f0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gab1bfa91d8b32df21a997d4f7999fd4d0"><td class="memTemplParams" colspan="2"><a class="anchor" id="gab1bfa91d8b32df21a997d4f7999fd4d0"></a> template<typename _Fn , typename... _Args> </td></tr> <tr class="memitem:gab1bfa91d8b32df21a997d4f7999fd4d0"><td class="memTemplItemLeft" align="right" valign="top">__async_sfinae_helper<br class="typebreak"/> < typename decay< _Fn >::type, <br class="typebreak"/> _Fn, _Args...>::type </td><td class="memTemplItemRight" valign="bottom"><b>std::async</b> (_Fn &&__fn, _Args &&...__args)</td></tr> <tr class="separator:gab1bfa91d8b32df21a997d4f7999fd4d0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga5b4abfa468beb197d5bdac89e20afdb0"><td class="memItemLeft" align="right" valign="top">const error_category & </td><td class="memItemRight" valign="bottom"><a class="el" href="a01634.html#ga5b4abfa468beb197d5bdac89e20afdb0">std::future_category</a> () noexcept</td></tr> <tr class="separator:ga5b4abfa468beb197d5bdac89e20afdb0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga32bbe57d8ae969ac5cee4f0c48c3e63f"><td class="memItemLeft" align="right" valign="top">error_code </td><td class="memItemRight" valign="bottom"><a class="el" href="a01634.html#ga32bbe57d8ae969ac5cee4f0c48c3e63f">std::make_error_code</a> (future_errc __errc) noexcept</td></tr> <tr class="separator:ga32bbe57d8ae969ac5cee4f0c48c3e63f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga298f6b4607ddc74c173e6f8887f72047"><td class="memItemLeft" align="right" valign="top">error_condition </td><td class="memItemRight" valign="bottom"><a class="el" href="a01634.html#ga298f6b4607ddc74c173e6f8887f72047">std::make_error_condition</a> (future_errc __errc) noexcept</td></tr> <tr class="separator:ga298f6b4607ddc74c173e6f8887f72047"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:gabaa9d7a0526d5e8fbf2b307b2f3fdb4f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="gabaa9d7a0526d5e8fbf2b307b2f3fdb4f"></a> constexpr launch </td><td class="memItemRight" valign="bottom"><b>std::operator&</b> (launch __x, launch __y)</td></tr> <tr class="separator:gabaa9d7a0526d5e8fbf2b307b2f3fdb4f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga6896352346bcb059e600276092408274"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga6896352346bcb059e600276092408274"></a> launch & </td><td class="memItemRight" valign="bottom"><b>std::operator&=</b> (launch &__x, launch __y)</td></tr> <tr class="separator:ga6896352346bcb059e600276092408274"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga2798df5614ec4ed91359eb5c467647e0"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga2798df5614ec4ed91359eb5c467647e0"></a> constexpr launch </td><td class="memItemRight" valign="bottom"><b>std::operator^</b> (launch __x, launch __y)</td></tr> <tr class="separator:ga2798df5614ec4ed91359eb5c467647e0"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga83c3738b85da1e630b1cbd09887f651f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga83c3738b85da1e630b1cbd09887f651f"></a> launch & </td><td class="memItemRight" valign="bottom"><b>std::operator^=</b> (launch &__x, launch __y)</td></tr> <tr class="separator:ga83c3738b85da1e630b1cbd09887f651f"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga98992bc36aeeb033d5fbfd2f4dd8ca66"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga98992bc36aeeb033d5fbfd2f4dd8ca66"></a> constexpr launch </td><td class="memItemRight" valign="bottom"><b>std::operator|</b> (launch __x, launch __y)</td></tr> <tr class="separator:ga98992bc36aeeb033d5fbfd2f4dd8ca66"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga85c395c77374ee74bda10499e1faad28"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga85c395c77374ee74bda10499e1faad28"></a> launch & </td><td class="memItemRight" valign="bottom"><b>std::operator|=</b> (launch &__x, launch __y)</td></tr> <tr class="separator:ga85c395c77374ee74bda10499e1faad28"><td class="memSeparator" colspan="2"> </td></tr> <tr class="memitem:ga19464d3078d872dc360e8da16148a339"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ga19464d3078d872dc360e8da16148a339"></a> constexpr launch </td><td class="memItemRight" valign="bottom"><b>std::operator~</b> (launch __x)</td></tr> <tr class="separator:ga19464d3078d872dc360e8da16148a339"><td class="memSeparator" colspan="2"> </td></tr> </table> <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> <p>Classes for futures support. </p> <h2 class="groupheader">Enumeration Type Documentation</h2> <a class="anchor" id="ga61938f7ac25df97b5362109e61bb46a6"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="a01634.html#ga61938f7ac25df97b5362109e61bb46a6">std::future_errc</a></td> </tr> </table> </div><div class="memdoc"> <p>Error code for futures. </p> <p>Definition at line <a class="el" href="a01205_source.html#l00061">61</a> of file <a class="el" href="a01205_source.html">future</a>.</p> </div> </div> <a class="anchor" id="ga528eb8f3b350394c0406d4d58ab7dbf4"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="a01634.html#ga528eb8f3b350394c0406d4d58ab7dbf4">std::future_status</a></td> </tr> </table> </div><div class="memdoc"> <p>Status code for futures. </p> <p>Definition at line <a class="el" href="a01205_source.html#l00163">163</a> of file <a class="el" href="a01205_source.html">future</a>.</p> </div> </div> <a class="anchor" id="ga6f4ad125d364f01560e2ed20a3c8bb5b"></a> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">enum <a class="el" href="a01634.html#ga6f4ad125d364f01560e2ed20a3c8bb5b">std::launch</a></td> </tr> </table> </div><div class="memdoc"> <p>Launch code for futures. </p> <p>Definition at line <a class="el" href="a01205_source.html#l00126">126</a> of file <a class="el" href="a01205_source.html">future</a>.</p> </div> </div> <h2 class="groupheader">Function Documentation</h2> <a class="anchor" id="ga5b4abfa468beb197d5bdac89e20afdb0"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">const error_category& std::future_category </td> <td>(</td> <td class="paramname"></td><td>)</td> <td></td> </tr> </table> </td> <td class="mlabels-right"> <span class="mlabels"><span class="mlabel">noexcept</span></span> </td> </tr> </table> </div><div class="memdoc"> <p>Points to a statically-allocated object derived from <a class="el" href="a00654.html" title="error_category">error_category</a>. </p> <p>Referenced by <a class="el" href="a01205_source.html#l00079">std::make_error_code()</a>, and <a class="el" href="a01205_source.html#l00084">std::make_error_condition()</a>.</p> </div> </div> <a class="anchor" id="ga32bbe57d8ae969ac5cee4f0c48c3e63f"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">error_code std::make_error_code </td> <td>(</td> <td class="paramtype">future_errc </td> <td class="paramname"><em>__errc</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>Overload for make_error_code. </p> <p>Definition at line <a class="el" href="a01205_source.html#l00079">79</a> of file <a class="el" href="a01205_source.html">future</a>.</p> <p>References <a class="el" href="a01634.html#ga5b4abfa468beb197d5bdac89e20afdb0">std::future_category()</a>.</p> </div> </div> <a class="anchor" id="ga298f6b4607ddc74c173e6f8887f72047"></a> <div class="memitem"> <div class="memproto"> <table class="mlabels"> <tr> <td class="mlabels-left"> <table class="memname"> <tr> <td class="memname">error_condition std::make_error_condition </td> <td>(</td> <td class="paramtype">future_errc </td> <td class="paramname"><em>__errc</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>Overload for make_error_condition. </p> <p>Definition at line <a class="el" href="a01205_source.html#l00084">84</a> of file <a class="el" href="a01205_source.html">future</a>.</p> <p>References <a class="el" href="a01634.html#ga5b4abfa468beb197d5bdac89e20afdb0">std::future_category()</a>.</p> </div> </div> </div><!-- contents --> </div><!-- doc-content --> <!-- start footer part --> <div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> <ul> <li class="footer">Generated by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li> </ul> </div> </body> </html>