apalak
/
luna_mobile_online
1
0
Fork 0
Code Issues 0 Pull Requests 0 Projects 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
7 Commits
3 Branches
304 MiB
Tree: 7c8fa6e2c6
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from '7c8fa6e2c6'
${ noResults }
luna_mobile_online/doc/fsdk/html/classfsdk_1_1_future.html

378 lines
25 KiB
Raw Normal View History

Initial commit
1 year ago
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
​
 
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  2. <html xmlns="http://www.w3.org/1999/xhtml">
  3. <head>
  4. <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
  5. <meta http-equiv="X-UA-Compatible" content="IE=9"/>
  6. <meta name="generator" content="Doxygen 1.8.5"/>
  7. <title>Face Engine SDK: fsdk::Future&lt; T &gt; Class Template Reference</title>
  8. <link href="tabs.css" rel="stylesheet" type="text/css"/>
  9. <script type="text/javascript" src="jquery.js"></script>
  10. <script type="text/javascript" src="dynsections.js"></script>
  11. <link href="navtree.css" rel="stylesheet" type="text/css"/>
  12. <script type="text/javascript" src="resize.js"></script>
  13. <script type="text/javascript" src="navtree.js"></script>
  14. <script type="text/javascript">
  15.   $(document).ready(initResizable);
  16.   $(window).load(resizeHeight);
  17. </script>
  18. <link href="search/search.css" rel="stylesheet" type="text/css"/>
  19. <script type="text/javascript" src="search/search.js"></script>
  20. <script type="text/javascript">
  21.   $(document).ready(function() { searchBox.OnSelectItem(0); });
  22. </script>
  23. <link href="doxygen.css" rel="stylesheet" type="text/css" />
  24. </head>
  25. <body>
  26. <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
  27. <div id="titlearea">
  28. <table cellspacing="0" cellpadding="0">
  29.  <tbody>
  30.  <tr style="height: 56px;">
  31.   <td id="projectlogo"><img alt="Logo" src="logo.png"/></td>
  32.   <td style="padding-left: 0.5em;">
  33.    <div id="projectname">Face Engine SDK
  34.    &#160;<span id="projectnumber">5.8.0</span>
  35.    </div>
  36.    <div id="projectbrief">A face detection, recognition and tracking engine.</div>
  37.   </td>
  38.  </tr>
  39.  </tbody>
  40. </table>
  41. </div>
  42. <!-- end header part -->
  43. <!-- Generated by Doxygen 1.8.5 -->
  44. <script type="text/javascript">
  45. var searchBox = new SearchBox("searchBox", "search",false,'Search');
  46. </script>
  47.   <div id="navrow1" class="tabs">
  48.     <ul class="tablist">
  49.       <li><a href="index.html"><span>Main&#160;Page</span></a></li>
  50.       <li><a href="modules.html"><span>Modules</span></a></li>
  51.       <li><a href="namespaces.html"><span>Namespaces</span></a></li>
  52.       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
  53.       <li><a href="files.html"><span>Files</span></a></li>
  54.       <li>
  55.         <div id="MSearchBox" class="MSearchBoxInactive">
  56.         <span class="left">
  57.           <img id="MSearchSelect" src="search/mag_sel.png"
  58.                onmouseover="return searchBox.OnSearchSelectShow()"
  59.                onmouseout="return searchBox.OnSearchSelectHide()"
  60.                alt=""/>
  61.           <input type="text" id="MSearchField" value="Search" accesskey="S"
  62.                onfocus="searchBox.OnSearchFieldFocus(true)" 
  63.                onblur="searchBox.OnSearchFieldFocus(false)" 
  64.                onkeyup="searchBox.OnSearchFieldChange(event)"/>
  65.           </span><span class="right">
  66.             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
  67.           </span>
  68.         </div>
  69.       </li>
  70.     </ul>
  71.   </div>
  72.   <div id="navrow2" class="tabs2">
  73.     <ul class="tablist">
  74.       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
  75.       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
  76.       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
  77.       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
  78.     </ul>
  79.   </div>
  80. </div><!-- top -->
  81. <div id="side-nav" class="ui-resizable side-nav-resizable">
  82.   <div id="nav-tree">
  83.     <div id="nav-tree-contents">
  84.       <div id="nav-sync" class="sync"></div>
  85.     </div>
  86.   </div>
  87.   <div id="splitbar" style="-moz-user-select:none;" 
  88.        class="ui-resizable-handle">
  89.   </div>
  90. </div>
  91. <script type="text/javascript">
  92. $(document).ready(function(){initNavTree('classfsdk_1_1_future.html','');});
  93. </script>
  94. <div id="doc-content">
  95. <!-- window showing the filter options -->
  96. <div id="MSearchSelectWindow"
  97.      onmouseover="return searchBox.OnSearchSelectShow()"
  98.      onmouseout="return searchBox.OnSearchSelectHide()"
  99.      onkeydown="return searchBox.OnSearchSelectKey(event)">
  100. <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark">&#160;</span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark">&#160;</span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark">&#160;</span>Pages</a></div>
  101. 

  102. <!-- iframe showing the search results (closed by default) -->
  103. <div id="MSearchResultsWindow">
  104. <iframe src="javascript:void(0)" frameborder="0" 
  105.         name="MSearchResults" id="MSearchResults">
  106. </iframe>
  107. </div>
  108. 

  109. <div class="header">
  110.   <div class="summary">
  111. <a href="#pub-types">Public Types</a> &#124;
  112. <a href="#pub-methods">Public Member Functions</a> &#124;
  113. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  114. <a href="classfsdk_1_1_future-members.html">List of all members</a>  </div>
  115.   <div class="headertitle">
  116. <div class="title">fsdk::Future&lt; T &gt; Class Template Reference</div>  </div>
  117. </div><!--header-->
  118. <div class="contents">
  119. 

  120. <p><a class="el" href="classfsdk_1_1_future.html" title="Future class to support asynchronous data retrieval Look into std::future semantics to understand it...">Future</a> class to support asynchronous data retrieval Look into std::future semantics to understand it.  
  121.  <a href="classfsdk_1_1_future.html#details">More...</a></p>
  122. 

  123. <p><code>#include &lt;<a class="el" href="_future_8h_source.html">Future.h</a>&gt;</code></p>
  124. <div class="dynheader">
  125. Inheritance diagram for fsdk::Future&lt; T &gt;:</div>
  126. <div class="dyncontent">
  127.  <div class="center">
  128.   <img src="classfsdk_1_1_future.png" usemap="#fsdk::Future&lt; T &gt;_map" alt=""/>
  129.   <map id="fsdk::Future&lt; T &gt;_map" name="fsdk::Future&lt; T &gt;_map">
  130. <area href="classfsdk_1_1_noncopyable.html" title="Helper class to block copy operator&amp;constructor of its descendants. " alt="fsdk::Noncopyable" shape="rect" coords="0,0,116,24"/>
  131. </map>
  132.  </div></div>
  133. <table class="memberdecls">
  134. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  135. Public Types</h2></td></tr>
  136. <tr class="memitem:ab792dd0d1b8eac18d3a0d875d215575f"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab792dd0d1b8eac18d3a0d875d215575f"></a>
  137. using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_future.html#ab792dd0d1b8eac18d3a0d875d215575f">USec</a> = int32_t</td></tr>
  138. <tr class="memdesc:ab792dd0d1b8eac18d3a0d875d215575f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alias for micro seconds type. <br/></td></tr>
  139. <tr class="separator:ab792dd0d1b8eac18d3a0d875d215575f"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. <tr class="memitem:a9a5efae2498601862b9514b6d58661c6"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9a5efae2498601862b9514b6d58661c6"></a>
  141. using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_future.html#a9a5efae2498601862b9514b6d58661c6">Error</a> = <a class="el" href="namespacefsdk.html#ab7f8be96a87fd4e85bd762a7f8f8f8fb">FutureError</a></td></tr>
  142. <tr class="memdesc:a9a5efae2498601862b9514b6d58661c6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alias for associated error type. <br/></td></tr>
  143. <tr class="separator:a9a5efae2498601862b9514b6d58661c6"><td class="memSeparator" colspan="2">&#160;</td></tr>
  144. <tr class="memitem:a38f572195de92595cbc6c847fb7470ec"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a38f572195de92595cbc6c847fb7470ec"></a>
  145. using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_future.html#a38f572195de92595cbc6c847fb7470ec">DataType</a> = T</td></tr>
  146. <tr class="memdesc:a38f572195de92595cbc6c847fb7470ec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alias for stored data type. <br/></td></tr>
  147. <tr class="separator:a38f572195de92595cbc6c847fb7470ec"><td class="memSeparator" colspan="2">&#160;</td></tr>
  148. </table><table class="memberdecls">
  149. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  150. Public Member Functions</h2></td></tr>
  151. <tr class="memitem:a88569ef592c8f9793067cb1139123aaf"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a88569ef592c8f9793067cb1139123aaf"></a>
  152. &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_future.html#a88569ef592c8f9793067cb1139123aaf">Future</a> () noexcept</td></tr>
  153. <tr class="memdesc:a88569ef592c8f9793067cb1139123aaf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for empty useless shell of a future. <br/></td></tr>
  154. <tr class="separator:a88569ef592c8f9793067cb1139123aaf"><td class="memSeparator" colspan="2">&#160;</td></tr>
  155. <tr class="memitem:aad456b58442c956f349975302ebf9c8e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aad456b58442c956f349975302ebf9c8e"></a>
  156. &#160;</td><td class="memItemRight" valign="bottom"><b>Future</b> (<a class="el" href="classfsdk_1_1_future.html">Future</a> &amp;&amp;mv) noexcept</td></tr>
  157. <tr class="separator:aad456b58442c956f349975302ebf9c8e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  158. <tr class="memitem:a942829f2284cae1feebbdeae05e9041d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a942829f2284cae1feebbdeae05e9041d"></a>
  159. <a class="el" href="classfsdk_1_1_future.html">Future</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classfsdk_1_1_future.html">Future</a> &amp;&amp;) noexcept</td></tr>
  160. <tr class="separator:a942829f2284cae1feebbdeae05e9041d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  161. <tr class="memitem:aaaed4d6e1ad65c21ac4ac4e547e93f53"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_result.html">Result</a>&lt; <a class="el" href="namespacefsdk.html#ab7f8be96a87fd4e85bd762a7f8f8f8fb">Error</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_future.html#aaaed4d6e1ad65c21ac4ac4e547e93f53">cancel</a> (const <a class="el" href="namespacefsdk.html#a0f4cbbc8c61f0127bd75695e76869860">ExecutionPolicy</a> policy) noexcept</td></tr>
  162. <tr class="memdesc:aaaed4d6e1ad65c21ac4ac4e547e93f53"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel method. Might be called on some heavy long running task that is not needed anymore. Only makes sense if underlying state is Promised.  <a href="#aaaed4d6e1ad65c21ac4ac4e547e93f53">More...</a><br/></td></tr>
  163. <tr class="separator:aaaed4d6e1ad65c21ac4ac4e547e93f53"><td class="memSeparator" colspan="2">&#160;</td></tr>
  164. <tr class="memitem:a2b52e6264dc9fb54d143712efdb783b8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacefsdk.html#a48fe9106b62424a924a260074cd2c82b">FuturePromiseState</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_future.html#a2b52e6264dc9fb54d143712efdb783b8">state</a> () const noexcept</td></tr>
  165. <tr class="memdesc:a2b52e6264dc9fb54d143712efdb783b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns current state of future-promise pair.  <a href="#a2b52e6264dc9fb54d143712efdb783b8">More...</a><br/></td></tr>
  166. <tr class="separator:a2b52e6264dc9fb54d143712efdb783b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
  167. <tr class="memitem:ac30c21fa31a1d66e732bfffada32e03a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_result.html">Result</a>&lt; <a class="el" href="namespacefsdk.html#ab7f8be96a87fd4e85bd762a7f8f8f8fb">Error</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_future.html#ac30c21fa31a1d66e732bfffada32e03a">takeInto</a> (<a class="el" href="classfsdk_1_1_future.html#a38f572195de92595cbc6c847fb7470ec">DataType</a> &amp;container) noexcept</td></tr>
  168. <tr class="memdesc:ac30c21fa31a1d66e732bfffada32e03a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Method to retrieve data out of fulfilled future. Only makes sense if current state is Fulfilled.  <a href="#ac30c21fa31a1d66e732bfffada32e03a">More...</a><br/></td></tr>
  169. <tr class="separator:ac30c21fa31a1d66e732bfffada32e03a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  170. <tr class="memitem:a7e85628150597362aad032ea8029dcf9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_result.html">Result</a>&lt; <a class="el" href="namespacefsdk.html#ab7f8be96a87fd4e85bd762a7f8f8f8fb">Error</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_future.html#a7e85628150597362aad032ea8029dcf9">wait</a> () const noexcept</td></tr>
  171. <tr class="memdesc:a7e85628150597362aad032ea8029dcf9"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocks called thread until internal state changes to Fulfilled, Canceled or Failed.  <a href="#a7e85628150597362aad032ea8029dcf9">More...</a><br/></td></tr>
  172. <tr class="separator:a7e85628150597362aad032ea8029dcf9"><td class="memSeparator" colspan="2">&#160;</td></tr>
  173. <tr class="memitem:ab1da1098643943411046bbe6a718fe74"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_result.html">Result</a>&lt; <a class="el" href="namespacefsdk.html#ab7f8be96a87fd4e85bd762a7f8f8f8fb">Error</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_future.html#ab1da1098643943411046bbe6a718fe74">waitFor</a> (const <a class="el" href="classfsdk_1_1_future.html#ab792dd0d1b8eac18d3a0d875d215575f">USec</a> usec) const noexcept</td></tr>
  174. <tr class="memdesc:ab1da1098643943411046bbe6a718fe74"><td class="mdescLeft">&#160;</td><td class="mdescRight">Blocks called thread until internal state changes to Fulfilled, Canceled or Failed, OR passed time is over.  <a href="#ab1da1098643943411046bbe6a718fe74">More...</a><br/></td></tr>
  175. <tr class="separator:ab1da1098643943411046bbe6a718fe74"><td class="memSeparator" colspan="2">&#160;</td></tr>
  176. </table><table class="memberdecls">
  177. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  178. Static Public Member Functions</h2></td></tr>
  179. <tr class="memitem:a7f7977f3ac4805fda79869a23f9f8686"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f7977f3ac4805fda79869a23f9f8686"></a>
  180. static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_future.html#a7f7977f3ac4805fda79869a23f9f8686">swap</a> (<a class="el" href="classfsdk_1_1_future.html">Future</a> &amp;first, <a class="el" href="classfsdk_1_1_future.html">Future</a> &amp;second) noexcept</td></tr>
  181. <tr class="memdesc:a7f7977f3ac4805fda79869a23f9f8686"><td class="mdescLeft">&#160;</td><td class="mdescRight">Static method that swaps internal data between two passed futures. <br/></td></tr>
  182. <tr class="separator:a7f7977f3ac4805fda79869a23f9f8686"><td class="memSeparator" colspan="2">&#160;</td></tr>
  183. </table>
  184. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  185. <div class="textblock"><h3>template&lt;typename T&gt;<br/>
  186. class fsdk::Future&lt; T &gt;</h3>
  187. 

  188. <p><a class="el" href="classfsdk_1_1_future.html" title="Future class to support asynchronous data retrieval Look into std::future semantics to understand it...">Future</a> class to support asynchronous data retrieval Look into std::future semantics to understand it. </p>
  189. <dl class="section note"><dt>Note</dt><dd>Is not instantiable using this header only. </dd></dl>
  190. <dl class="tparams"><dt>Template Parameters</dt><dd>
  191.   <table class="tparams">
  192.     <tr><td class="paramname">T</td><td>data type to store. </td></tr>
  193.   </table>
  194.   </dd>
  195. </dl>
  196. </div><h2 class="groupheader">Member Function Documentation</h2>
  197. <a class="anchor" id="aaaed4d6e1ad65c21ac4ac4e547e93f53"></a>
  198. <div class="memitem">
  199. <div class="memproto">
  200. <div class="memtemplate">
  201. template&lt;typename T &gt; </div>
  202. <table class="mlabels">
  203.   <tr>
  204.   <td class="mlabels-left">
  205.       <table class="memname">
  206.         <tr>
  207.           <td class="memname"><a class="el" href="structfsdk_1_1_result.html">Result</a>&lt;<a class="el" href="namespacefsdk.html#ab7f8be96a87fd4e85bd762a7f8f8f8fb">Error</a>&gt; <a class="el" href="classfsdk_1_1_future.html">fsdk::Future</a>&lt; T &gt;::cancel </td>
  208.           <td>(</td>
  209.           <td class="paramtype">const <a class="el" href="namespacefsdk.html#a0f4cbbc8c61f0127bd75695e76869860">ExecutionPolicy</a>&#160;</td>
  210.           <td class="paramname"><em>policy</em></td><td>)</td>
  211.           <td></td>
  212.         </tr>
  213.       </table>
  214.   </td>
  215.   <td class="mlabels-right">
  216. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  217.   </tr>
  218. </table>
  219. </div><div class="memdoc">
  220. 

  221. <p>Cancel method. Might be called on some heavy long running task that is not needed anymore. Only makes sense if underlying state is Promised. </p>
  222. <dl class="params"><dt>Parameters</dt><dd>
  223.   <table class="params">
  224.     <tr><td class="paramname">policy</td><td>Policy on how to behave: block till state becomes Canceled or run async. </td></tr>
  225.   </table>
  226.   </dd>
  227. </dl>
  228. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> type containing </dd></dl>
  229. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classfsdk_1_1_future.html#a9a5efae2498601862b9514b6d58661c6" title="Alias for associated error type. ">Error</a> code. </dd></dl>
  230. 

  231. </div>
  232. </div>
  233. <a class="anchor" id="a2b52e6264dc9fb54d143712efdb783b8"></a>
  234. <div class="memitem">
  235. <div class="memproto">
  236. <div class="memtemplate">
  237. template&lt;typename T &gt; </div>
  238. <table class="mlabels">
  239.   <tr>
  240.   <td class="mlabels-left">
  241.       <table class="memname">
  242.         <tr>
  243.           <td class="memname"><a class="el" href="namespacefsdk.html#a48fe9106b62424a924a260074cd2c82b">FuturePromiseState</a> <a class="el" href="classfsdk_1_1_future.html">fsdk::Future</a>&lt; T &gt;::state </td>
  244.           <td>(</td>
  245.           <td class="paramname"></td><td>)</td>
  246.           <td> const</td>
  247.         </tr>
  248.       </table>
  249.   </td>
  250.   <td class="mlabels-right">
  251. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  252.   </tr>
  253. </table>
  254. </div><div class="memdoc">
  255. 

  256. <p>Returns current state of future-promise pair. </p>
  257. <dl class="section return"><dt>Returns</dt><dd>Current state </dd></dl>
  258. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="namespacefsdk.html#a48fe9106b62424a924a260074cd2c82b" title="Enumeration of possible future or promise states. ">FuturePromiseState</a>. </dd></dl>
  259. 

  260. </div>
  261. </div>
  262. <a class="anchor" id="ac30c21fa31a1d66e732bfffada32e03a"></a>
  263. <div class="memitem">
  264. <div class="memproto">
  265. <div class="memtemplate">
  266. template&lt;typename T &gt; </div>
  267. <table class="mlabels">
  268.   <tr>
  269.   <td class="mlabels-left">
  270.       <table class="memname">
  271.         <tr>
  272.           <td class="memname"><a class="el" href="structfsdk_1_1_result.html">Result</a>&lt;<a class="el" href="namespacefsdk.html#ab7f8be96a87fd4e85bd762a7f8f8f8fb">Error</a>&gt; <a class="el" href="classfsdk_1_1_future.html">fsdk::Future</a>&lt; T &gt;::takeInto </td>
  273.           <td>(</td>
  274.           <td class="paramtype"><a class="el" href="classfsdk_1_1_future.html#a38f572195de92595cbc6c847fb7470ec">DataType</a> &amp;&#160;</td>
  275.           <td class="paramname"><em>container</em></td><td>)</td>
  276.           <td></td>
  277.         </tr>
  278.       </table>
  279.   </td>
  280.   <td class="mlabels-right">
  281. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  282.   </tr>
  283. </table>
  284. </div><div class="memdoc">
  285. 

  286. <p>Method to retrieve data out of fulfilled future. Only makes sense if current state is Fulfilled. </p>
  287. <dl class="params"><dt>Parameters</dt><dd>
  288.   <table class="params">
  289.     <tr><td class="paramname">container</td><td>Reference to DataType object to fill with future' data. </td></tr>
  290.   </table>
  291.   </dd>
  292. </dl>
  293. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> type containing </dd></dl>
  294. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classfsdk_1_1_future.html#a9a5efae2498601862b9514b6d58661c6" title="Alias for associated error type. ">Error</a> code. </dd></dl>
  295. 

  296. </div>
  297. </div>
  298. <a class="anchor" id="a7e85628150597362aad032ea8029dcf9"></a>
  299. <div class="memitem">
  300. <div class="memproto">
  301. <div class="memtemplate">
  302. template&lt;typename T &gt; </div>
  303. <table class="mlabels">
  304.   <tr>
  305.   <td class="mlabels-left">
  306.       <table class="memname">
  307.         <tr>
  308.           <td class="memname"><a class="el" href="structfsdk_1_1_result.html">Result</a>&lt;<a class="el" href="namespacefsdk.html#ab7f8be96a87fd4e85bd762a7f8f8f8fb">Error</a>&gt; <a class="el" href="classfsdk_1_1_future.html">fsdk::Future</a>&lt; T &gt;::wait </td>
  309.           <td>(</td>
  310.           <td class="paramname"></td><td>)</td>
  311.           <td> const</td>
  312.         </tr>
  313.       </table>
  314.   </td>
  315.   <td class="mlabels-right">
  316. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  317.   </tr>
  318. </table>
  319. </div><div class="memdoc">
  320. 

  321. <p>Blocks called thread until internal state changes to Fulfilled, Canceled or Failed. </p>
  322. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> type containing </dd></dl>
  323. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classfsdk_1_1_future.html#a9a5efae2498601862b9514b6d58661c6" title="Alias for associated error type. ">Error</a> code. </dd></dl>
  324. 

  325. </div>
  326. </div>
  327. <a class="anchor" id="ab1da1098643943411046bbe6a718fe74"></a>
  328. <div class="memitem">
  329. <div class="memproto">
  330. <div class="memtemplate">
  331. template&lt;typename T &gt; </div>
  332. <table class="mlabels">
  333.   <tr>
  334.   <td class="mlabels-left">
  335.       <table class="memname">
  336.         <tr>
  337.           <td class="memname"><a class="el" href="structfsdk_1_1_result.html">Result</a>&lt;<a class="el" href="namespacefsdk.html#ab7f8be96a87fd4e85bd762a7f8f8f8fb">Error</a>&gt; <a class="el" href="classfsdk_1_1_future.html">fsdk::Future</a>&lt; T &gt;::waitFor </td>
  338.           <td>(</td>
  339.           <td class="paramtype">const <a class="el" href="classfsdk_1_1_future.html#ab792dd0d1b8eac18d3a0d875d215575f">USec</a>&#160;</td>
  340.           <td class="paramname"><em>usec</em></td><td>)</td>
  341.           <td> const</td>
  342.         </tr>
  343.       </table>
  344.   </td>
  345.   <td class="mlabels-right">
  346. <span class="mlabels"><span class="mlabel">noexcept</span></span>  </td>
  347.   </tr>
  348. </table>
  349. </div><div class="memdoc">
  350. 

  351. <p>Blocks called thread until internal state changes to Fulfilled, Canceled or Failed, OR passed time is over. </p>
  352. <dl class="params"><dt>Parameters</dt><dd>
  353.   <table class="params">
  354.     <tr><td class="paramname">usec</td><td>Upper bound of microseconds to wait. </td></tr>
  355.   </table>
  356.   </dd>
  357. </dl>
  358. <dl class="section return"><dt>Returns</dt><dd><a class="el" href="structfsdk_1_1_result.html" title="A structure that encapsulates an action result enumeration. ">Result</a> type containing </dd></dl>
  359. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classfsdk_1_1_future.html#a9a5efae2498601862b9514b6d58661c6" title="Alias for associated error type. ">Error</a> code. </dd></dl>
  360. 

  361. </div>
  362. </div>
  363. <hr/>The documentation for this class was generated from the following file:<ul>
  364. <li>include/fsdk/Types/<a class="el" href="_future_8h_source.html">Future.h</a></li>
  365. </ul>
  366. </div><!-- contents -->
  367. </div><!-- doc-content -->
  368. <!-- start footer part -->
  369. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  370.   <ul>
  371.     <li class="navelem"><a class="el" href="namespacefsdk.html">fsdk</a></li><li class="navelem"><a class="el" href="classfsdk_1_1_future.html">Future</a></li>
  372.     <li class="footer">Generated on Fri Jun 17 2022 12:19:44 for Face Engine SDK by
  373.     <a href="http://www.doxygen.org/index.html">
  374.     <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
  375.   </ul>
  376. </div>
  377. </body>
  378. </html>