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.

367 lines
24 KiB

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::Promise&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_promise.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. <!-- iframe showing the search results (closed by default) -->
  102. <div id="MSearchResultsWindow">
  103. <iframe src="javascript:void(0)" frameborder="0"
  104. name="MSearchResults" id="MSearchResults">
  105. </iframe>
  106. </div>
  107. <div class="header">
  108. <div class="summary">
  109. <a href="#pub-types">Public Types</a> &#124;
  110. <a href="#pub-methods">Public Member Functions</a> &#124;
  111. <a href="#pub-static-methods">Static Public Member Functions</a> &#124;
  112. <a href="classfsdk_1_1_promise-members.html">List of all members</a> </div>
  113. <div class="headertitle">
  114. <div class="title">fsdk::Promise&lt; T &gt; Class Template Reference</div> </div>
  115. </div><!--header-->
  116. <div class="contents">
  117. <p><a class="el" href="classfsdk_1_1_promise.html" title="Promise class to support asynchronous data retrieval Look into std::promise semantics to understand i...">Promise</a> class to support asynchronous data retrieval Look into std::promise semantics to understand it.
  118. <a href="classfsdk_1_1_promise.html#details">More...</a></p>
  119. <p><code>#include &lt;<a class="el" href="_future_8h_source.html">Future.h</a>&gt;</code></p>
  120. <div class="dynheader">
  121. Inheritance diagram for fsdk::Promise&lt; T &gt;:</div>
  122. <div class="dyncontent">
  123. <div class="center">
  124. <img src="classfsdk_1_1_promise.png" usemap="#fsdk::Promise&lt; T &gt;_map" alt=""/>
  125. <map id="fsdk::Promise&lt; T &gt;_map" name="fsdk::Promise&lt; T &gt;_map">
  126. <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,117,24"/>
  127. </map>
  128. </div></div>
  129. <table class="memberdecls">
  130. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
  131. Public Types</h2></td></tr>
  132. <tr class="memitem:ae3660c93bae2da9120c11546f132a87e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae3660c93bae2da9120c11546f132a87e"></a>
  133. using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_promise.html#ae3660c93bae2da9120c11546f132a87e">Error</a> = <a class="el" href="namespacefsdk.html#a4d0fbacdb0e56a6f79c2eb3e276c4e83">PromiseError</a></td></tr>
  134. <tr class="memdesc:ae3660c93bae2da9120c11546f132a87e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alias for associated error type. <br/></td></tr>
  135. <tr class="separator:ae3660c93bae2da9120c11546f132a87e"><td class="memSeparator" colspan="2">&#160;</td></tr>
  136. <tr class="memitem:a289da90b035b98d71ff87b366523d970"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a289da90b035b98d71ff87b366523d970"></a>
  137. using&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_promise.html#a289da90b035b98d71ff87b366523d970">DataType</a> = T</td></tr>
  138. <tr class="memdesc:a289da90b035b98d71ff87b366523d970"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alias for stored data type. <br/></td></tr>
  139. <tr class="separator:a289da90b035b98d71ff87b366523d970"><td class="memSeparator" colspan="2">&#160;</td></tr>
  140. </table><table class="memberdecls">
  141. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
  142. Public Member Functions</h2></td></tr>
  143. <tr class="memitem:a26f2ff77af845a32921508ac26184217"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26f2ff77af845a32921508ac26184217"></a>
  144. &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_promise.html#a26f2ff77af845a32921508ac26184217">Promise</a> () noexcept</td></tr>
  145. <tr class="memdesc:a26f2ff77af845a32921508ac26184217"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor for empty <a class="el" href="classfsdk_1_1_promise.html" title="Promise class to support asynchronous data retrieval Look into std::promise semantics to understand i...">Promise</a>. <br/></td></tr>
  146. <tr class="separator:a26f2ff77af845a32921508ac26184217"><td class="memSeparator" colspan="2">&#160;</td></tr>
  147. <tr class="memitem:a11a4723bb75f234e2e281f8d0c6177b1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a11a4723bb75f234e2e281f8d0c6177b1"></a>
  148. &#160;</td><td class="memItemRight" valign="bottom"><b>Promise</b> (<a class="el" href="classfsdk_1_1_promise.html">Promise</a> &amp;&amp;) noexcept</td></tr>
  149. <tr class="separator:a11a4723bb75f234e2e281f8d0c6177b1"><td class="memSeparator" colspan="2">&#160;</td></tr>
  150. <tr class="memitem:a22617556e5adc142030df7ef45e829d4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22617556e5adc142030df7ef45e829d4"></a>
  151. <a class="el" href="classfsdk_1_1_promise.html">Promise</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classfsdk_1_1_promise.html">Promise</a> &amp;&amp;) noexcept</td></tr>
  152. <tr class="separator:a22617556e5adc142030df7ef45e829d4"><td class="memSeparator" colspan="2">&#160;</td></tr>
  153. <tr class="memitem:a7a178efaed788e336ed5305580737e4a"><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#a4d0fbacdb0e56a6f79c2eb3e276c4e83">Error</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_promise.html#a7a178efaed788e336ed5305580737e4a">cancel</a> () noexcept</td></tr>
  154. <tr class="memdesc:a7a178efaed788e336ed5305580737e4a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel method. Think of it as acceptance of cancel requested by. <a href="#a7a178efaed788e336ed5305580737e4a">More...</a><br/></td></tr>
  155. <tr class="separator:a7a178efaed788e336ed5305580737e4a"><td class="memSeparator" colspan="2">&#160;</td></tr>
  156. <tr class="memitem:a0c73e4d84c3e6487d5a7e1f7b0c13ba0"><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#a4d0fbacdb0e56a6f79c2eb3e276c4e83">Error</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_promise.html#a0c73e4d84c3e6487d5a7e1f7b0c13ba0">fail</a> () noexcept</td></tr>
  157. <tr class="memdesc:a0c73e4d84c3e6487d5a7e1f7b0c13ba0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fail method. Think of it as valid failure to run some promised function. Only makes sense if underlying state is Promised. <a href="#a0c73e4d84c3e6487d5a7e1f7b0c13ba0">More...</a><br/></td></tr>
  158. <tr class="separator:a0c73e4d84c3e6487d5a7e1f7b0c13ba0"><td class="memSeparator" colspan="2">&#160;</td></tr>
  159. <tr class="memitem:a379829f59f04b7694423b3e82d501766"><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#a4d0fbacdb0e56a6f79c2eb3e276c4e83">Error</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_promise.html#a379829f59f04b7694423b3e82d501766">fulfill</a> (<a class="el" href="classfsdk_1_1_promise.html#a289da90b035b98d71ff87b366523d970">DataType</a> &amp;&amp;promisedData) noexcept</td></tr>
  160. <tr class="memdesc:a379829f59f04b7694423b3e82d501766"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fulfill promise with data. Only makes sense if underlying state is Promised. <a href="#a379829f59f04b7694423b3e82d501766">More...</a><br/></td></tr>
  161. <tr class="separator:a379829f59f04b7694423b3e82d501766"><td class="memSeparator" colspan="2">&#160;</td></tr>
  162. <tr class="memitem:accb944e8905435482b8604dfb805d690"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classfsdk_1_1_future.html">Future</a>&lt; <a class="el" href="classfsdk_1_1_promise.html#a289da90b035b98d71ff87b366523d970">DataType</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_promise.html#accb944e8905435482b8604dfb805d690">future</a> (<a class="el" href="structfsdk_1_1_result.html">Result</a>&lt; <a class="el" href="namespacefsdk.html#a4d0fbacdb0e56a6f79c2eb3e276c4e83">Error</a> &gt; &amp;error) noexcept</td></tr>
  163. <tr class="memdesc:accb944e8905435482b8604dfb805d690"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create tethered future object. Only makes sense if underlying state is Empty. <a href="#accb944e8905435482b8604dfb805d690">More...</a><br/></td></tr>
  164. <tr class="separator:accb944e8905435482b8604dfb805d690"><td class="memSeparator" colspan="2">&#160;</td></tr>
  165. <tr class="memitem:acb099562ad549c712fcdca295b379f5d"><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_promise.html#acb099562ad549c712fcdca295b379f5d">state</a> () const noexcept</td></tr>
  166. <tr class="memdesc:acb099562ad549c712fcdca295b379f5d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns current state of future-promise pair. <a href="#acb099562ad549c712fcdca295b379f5d">More...</a><br/></td></tr>
  167. <tr class="separator:acb099562ad549c712fcdca295b379f5d"><td class="memSeparator" colspan="2">&#160;</td></tr>
  168. </table><table class="memberdecls">
  169. <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
  170. Static Public Member Functions</h2></td></tr>
  171. <tr class="memitem:a9b3e58dc95742108177ca25db4a933eb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9b3e58dc95742108177ca25db4a933eb"></a>
  172. static void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_promise.html#a9b3e58dc95742108177ca25db4a933eb">swap</a> (<a class="el" href="classfsdk_1_1_promise.html">Promise</a> &amp;first, <a class="el" href="classfsdk_1_1_promise.html">Promise</a> &amp;second) noexcept</td></tr>
  173. <tr class="memdesc:a9b3e58dc95742108177ca25db4a933eb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Static method that swaps internal data between two passed promises. <br/></td></tr>
  174. <tr class="separator:a9b3e58dc95742108177ca25db4a933eb"><td class="memSeparator" colspan="2">&#160;</td></tr>
  175. </table>
  176. <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
  177. <div class="textblock"><h3>template&lt;typename T&gt;<br/>
  178. class fsdk::Promise&lt; T &gt;</h3>
  179. <p><a class="el" href="classfsdk_1_1_promise.html" title="Promise class to support asynchronous data retrieval Look into std::promise semantics to understand i...">Promise</a> class to support asynchronous data retrieval Look into std::promise semantics to understand it. </p>
  180. <dl class="section note"><dt>Note</dt><dd>Is not instantiable using this header only. </dd></dl>
  181. <dl class="tparams"><dt>Template Parameters</dt><dd>
  182. <table class="tparams">
  183. <tr><td class="paramname">T</td><td>data type to store. </td></tr>
  184. </table>
  185. </dd>
  186. </dl>
  187. </div><h2 class="groupheader">Member Function Documentation</h2>
  188. <a class="anchor" id="a7a178efaed788e336ed5305580737e4a"></a>
  189. <div class="memitem">
  190. <div class="memproto">
  191. <div class="memtemplate">
  192. template&lt;typename T &gt; </div>
  193. <table class="mlabels">
  194. <tr>
  195. <td class="mlabels-left">
  196. <table class="memname">
  197. <tr>
  198. <td class="memname"><a class="el" href="structfsdk_1_1_result.html">Result</a>&lt;<a class="el" href="namespacefsdk.html#a4d0fbacdb0e56a6f79c2eb3e276c4e83">Error</a>&gt; <a class="el" href="classfsdk_1_1_promise.html">fsdk::Promise</a>&lt; T &gt;::cancel </td>
  199. <td>(</td>
  200. <td class="paramname"></td><td>)</td>
  201. <td></td>
  202. </tr>
  203. </table>
  204. </td>
  205. <td class="mlabels-right">
  206. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  207. </tr>
  208. </table>
  209. </div><div class="memdoc">
  210. <p>Cancel method. Think of it as acceptance of cancel requested by. </p>
  211. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classfsdk_1_1_future.html#aaaed4d6e1ad65c21ac4ac4e547e93f53" title="Cancel method. Might be called on some heavy long running task that is not needed anymore...">Future::cancel</a>. Only makes sense if underlying <a class="el" href="classfsdk_1_1_promise.html#acb099562ad549c712fcdca295b379f5d" title="Returns current state of future-promise pair. ">state</a> is <a class="el" href="namespacefsdk.html#a48fe9106b62424a924a260074cd2c82badc5498d31e5fd9e499391ff2b26bfff8" title="State possible if. ">CancelRequested</a>. </dd></dl>
  212. <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>
  213. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classfsdk_1_1_promise.html#ae3660c93bae2da9120c11546f132a87e" title="Alias for associated error type. ">Error</a> code. </dd></dl>
  214. </div>
  215. </div>
  216. <a class="anchor" id="a0c73e4d84c3e6487d5a7e1f7b0c13ba0"></a>
  217. <div class="memitem">
  218. <div class="memproto">
  219. <div class="memtemplate">
  220. template&lt;typename T &gt; </div>
  221. <table class="mlabels">
  222. <tr>
  223. <td class="mlabels-left">
  224. <table class="memname">
  225. <tr>
  226. <td class="memname"><a class="el" href="structfsdk_1_1_result.html">Result</a>&lt;<a class="el" href="namespacefsdk.html#a4d0fbacdb0e56a6f79c2eb3e276c4e83">Error</a>&gt; <a class="el" href="classfsdk_1_1_promise.html">fsdk::Promise</a>&lt; T &gt;::fail </td>
  227. <td>(</td>
  228. <td class="paramname"></td><td>)</td>
  229. <td></td>
  230. </tr>
  231. </table>
  232. </td>
  233. <td class="mlabels-right">
  234. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  235. </tr>
  236. </table>
  237. </div><div class="memdoc">
  238. <p>Fail method. Think of it as valid failure to run some promised function. Only makes sense if underlying state is Promised. </p>
  239. <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>
  240. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classfsdk_1_1_promise.html#ae3660c93bae2da9120c11546f132a87e" title="Alias for associated error type. ">Error</a> code. </dd></dl>
  241. </div>
  242. </div>
  243. <a class="anchor" id="a379829f59f04b7694423b3e82d501766"></a>
  244. <div class="memitem">
  245. <div class="memproto">
  246. <div class="memtemplate">
  247. template&lt;typename T &gt; </div>
  248. <table class="mlabels">
  249. <tr>
  250. <td class="mlabels-left">
  251. <table class="memname">
  252. <tr>
  253. <td class="memname"><a class="el" href="structfsdk_1_1_result.html">Result</a>&lt;<a class="el" href="namespacefsdk.html#a4d0fbacdb0e56a6f79c2eb3e276c4e83">Error</a>&gt; <a class="el" href="classfsdk_1_1_promise.html">fsdk::Promise</a>&lt; T &gt;::fulfill </td>
  254. <td>(</td>
  255. <td class="paramtype"><a class="el" href="classfsdk_1_1_promise.html#a289da90b035b98d71ff87b366523d970">DataType</a> &amp;&amp;&#160;</td>
  256. <td class="paramname"><em>promisedData</em></td><td>)</td>
  257. <td></td>
  258. </tr>
  259. </table>
  260. </td>
  261. <td class="mlabels-right">
  262. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  263. </tr>
  264. </table>
  265. </div><div class="memdoc">
  266. <p>Fulfill promise with data. Only makes sense if underlying state is Promised. </p>
  267. <dl class="params"><dt>Parameters</dt><dd>
  268. <table class="params">
  269. <tr><td class="paramname">promisedData</td><td>Rvalue reference to promised data. </td></tr>
  270. </table>
  271. </dd>
  272. </dl>
  273. <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>
  274. <dl class="section see"><dt>See Also</dt><dd><a class="el" href="classfsdk_1_1_promise.html#ae3660c93bae2da9120c11546f132a87e" title="Alias for associated error type. ">Error</a> code. </dd></dl>
  275. </div>
  276. </div>
  277. <a class="anchor" id="accb944e8905435482b8604dfb805d690"></a>
  278. <div class="memitem">
  279. <div class="memproto">
  280. <div class="memtemplate">
  281. template&lt;typename T &gt; </div>
  282. <table class="mlabels">
  283. <tr>
  284. <td class="mlabels-left">
  285. <table class="memname">
  286. <tr>
  287. <td class="memname"><a class="el" href="classfsdk_1_1_future.html">Future</a>&lt;<a class="el" href="classfsdk_1_1_promise.html#a289da90b035b98d71ff87b366523d970">DataType</a>&gt; <a class="el" href="classfsdk_1_1_promise.html">fsdk::Promise</a>&lt; T &gt;::future </td>
  288. <td>(</td>
  289. <td class="paramtype"><a class="el" href="structfsdk_1_1_result.html">Result</a>&lt; <a class="el" href="namespacefsdk.html#a4d0fbacdb0e56a6f79c2eb3e276c4e83">Error</a> &gt; &amp;&#160;</td>
  290. <td class="paramname"><em>error</em></td><td>)</td>
  291. <td></td>
  292. </tr>
  293. </table>
  294. </td>
  295. <td class="mlabels-right">
  296. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  297. </tr>
  298. </table>
  299. </div><div class="memdoc">
  300. <p>Create tethered future object. Only makes sense if underlying state is Empty. </p>
  301. <dl class="params"><dt>Parameters</dt><dd>
  302. <table class="params">
  303. <tr><td class="paramname">error</td><td>Reference to error object to indicate of failure </td></tr>
  304. </table>
  305. </dd>
  306. </dl>
  307. <dl class="section return"><dt>Returns</dt><dd><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> object tethered to this promise. </dd></dl>
  308. </div>
  309. </div>
  310. <a class="anchor" id="acb099562ad549c712fcdca295b379f5d"></a>
  311. <div class="memitem">
  312. <div class="memproto">
  313. <div class="memtemplate">
  314. template&lt;typename T &gt; </div>
  315. <table class="mlabels">
  316. <tr>
  317. <td class="mlabels-left">
  318. <table class="memname">
  319. <tr>
  320. <td class="memname"><a class="el" href="namespacefsdk.html#a48fe9106b62424a924a260074cd2c82b">FuturePromiseState</a> <a class="el" href="classfsdk_1_1_promise.html">fsdk::Promise</a>&lt; T &gt;::state </td>
  321. <td>(</td>
  322. <td class="paramname"></td><td>)</td>
  323. <td> const</td>
  324. </tr>
  325. </table>
  326. </td>
  327. <td class="mlabels-right">
  328. <span class="mlabels"><span class="mlabel">noexcept</span></span> </td>
  329. </tr>
  330. </table>
  331. </div><div class="memdoc">
  332. <p>Returns current state of future-promise pair. </p>
  333. <dl class="section return"><dt>Returns</dt><dd>Current state </dd></dl>
  334. <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>
  335. </div>
  336. </div>
  337. <hr/>The documentation for this class was generated from the following file:<ul>
  338. <li>include/fsdk/Types/<a class="el" href="_future_8h_source.html">Future.h</a></li>
  339. </ul>
  340. </div><!-- contents -->
  341. </div><!-- doc-content -->
  342. <!-- start footer part -->
  343. <div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  344. <ul>
  345. <li class="navelem"><a class="el" href="namespacefsdk.html">fsdk</a></li><li class="navelem"><a class="el" href="classfsdk_1_1_promise.html">Promise</a></li>
  346. <li class="footer">Generated on Fri Jun 17 2022 12:19:44 for Face Engine SDK by
  347. <a href="http://www.doxygen.org/index.html">
  348. <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
  349. </ul>
  350. </div>
  351. </body>
  352. </html>