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
367 lines
24 KiB
<!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.5"/>
|
|
<title>Face Engine SDK: fsdk::Promise< T > 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="navtree.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(initResizable);
|
|
$(window).load(resizeHeight);
|
|
</script>
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="search/search.js"></script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
|
</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="projectlogo"><img alt="Logo" src="logo.png"/></td>
|
|
<td style="padding-left: 0.5em;">
|
|
<div id="projectname">Face Engine SDK
|
|
 <span id="projectnumber">5.8.0</span>
|
|
</div>
|
|
<div id="projectbrief">A face detection, recognition and tracking engine.</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
|
<script type="text/javascript">
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
|
</script>
|
|
<div id="navrow1" class="tabs">
|
|
<ul class="tablist">
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
|
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
|
<li>
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
|
<span class="left">
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
alt=""/>
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
|
</span><span class="right">
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
|
</span>
|
|
</div>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
<div id="navrow2" class="tabs2">
|
|
<ul class="tablist">
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
|
</ul>
|
|
</div>
|
|
</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('classfsdk_1_1_promise.html','');});
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- window showing the filter options -->
|
|
<div id="MSearchSelectWindow"
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Enumerator</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Macros</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(10)"><span class="SelectionMark"> </span>Groups</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(11)"><span class="SelectionMark"> </span>Pages</a></div>
|
|
|
|
<!-- iframe showing the search results (closed by default) -->
|
|
<div id="MSearchResultsWindow">
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
|
name="MSearchResults" id="MSearchResults">
|
|
</iframe>
|
|
</div>
|
|
|
|
<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="classfsdk_1_1_promise-members.html">List of all members</a> </div>
|
|
<div class="headertitle">
|
|
<div class="title">fsdk::Promise< T > Class Template Reference</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
|
|
<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.
|
|
<a href="classfsdk_1_1_promise.html#details">More...</a></p>
|
|
|
|
<p><code>#include <<a class="el" href="_future_8h_source.html">Future.h</a>></code></p>
|
|
<div class="dynheader">
|
|
Inheritance diagram for fsdk::Promise< T >:</div>
|
|
<div class="dyncontent">
|
|
<div class="center">
|
|
<img src="classfsdk_1_1_promise.png" usemap="#fsdk::Promise< T >_map" alt=""/>
|
|
<map id="fsdk::Promise< T >_map" name="fsdk::Promise< T >_map">
|
|
<area href="classfsdk_1_1_noncopyable.html" title="Helper class to block copy operator&constructor of its descendants. " alt="fsdk::Noncopyable" shape="rect" coords="0,0,117,24"/>
|
|
</map>
|
|
</div></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:ae3660c93bae2da9120c11546f132a87e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae3660c93bae2da9120c11546f132a87e"></a>
|
|
using </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>
|
|
<tr class="memdesc:ae3660c93bae2da9120c11546f132a87e"><td class="mdescLeft"> </td><td class="mdescRight">Alias for associated error type. <br/></td></tr>
|
|
<tr class="separator:ae3660c93bae2da9120c11546f132a87e"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a289da90b035b98d71ff87b366523d970"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a289da90b035b98d71ff87b366523d970"></a>
|
|
using </td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_promise.html#a289da90b035b98d71ff87b366523d970">DataType</a> = T</td></tr>
|
|
<tr class="memdesc:a289da90b035b98d71ff87b366523d970"><td class="mdescLeft"> </td><td class="mdescRight">Alias for stored data type. <br/></td></tr>
|
|
<tr class="separator:a289da90b035b98d71ff87b366523d970"><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:a26f2ff77af845a32921508ac26184217"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a26f2ff77af845a32921508ac26184217"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_promise.html#a26f2ff77af845a32921508ac26184217">Promise</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a26f2ff77af845a32921508ac26184217"><td class="mdescLeft"> </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>
|
|
<tr class="separator:a26f2ff77af845a32921508ac26184217"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a11a4723bb75f234e2e281f8d0c6177b1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a11a4723bb75f234e2e281f8d0c6177b1"></a>
|
|
 </td><td class="memItemRight" valign="bottom"><b>Promise</b> (<a class="el" href="classfsdk_1_1_promise.html">Promise</a> &&) noexcept</td></tr>
|
|
<tr class="separator:a11a4723bb75f234e2e281f8d0c6177b1"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a22617556e5adc142030df7ef45e829d4"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a22617556e5adc142030df7ef45e829d4"></a>
|
|
<a class="el" href="classfsdk_1_1_promise.html">Promise</a> & </td><td class="memItemRight" valign="bottom"><b>operator=</b> (<a class="el" href="classfsdk_1_1_promise.html">Promise</a> &&) noexcept</td></tr>
|
|
<tr class="separator:a22617556e5adc142030df7ef45e829d4"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a7a178efaed788e336ed5305580737e4a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="namespacefsdk.html#a4d0fbacdb0e56a6f79c2eb3e276c4e83">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_promise.html#a7a178efaed788e336ed5305580737e4a">cancel</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a7a178efaed788e336ed5305580737e4a"><td class="mdescLeft"> </td><td class="mdescRight">Cancel method. Think of it as acceptance of cancel requested by. <a href="#a7a178efaed788e336ed5305580737e4a">More...</a><br/></td></tr>
|
|
<tr class="separator:a7a178efaed788e336ed5305580737e4a"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a0c73e4d84c3e6487d5a7e1f7b0c13ba0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="namespacefsdk.html#a4d0fbacdb0e56a6f79c2eb3e276c4e83">Error</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_promise.html#a0c73e4d84c3e6487d5a7e1f7b0c13ba0">fail</a> () noexcept</td></tr>
|
|
<tr class="memdesc:a0c73e4d84c3e6487d5a7e1f7b0c13ba0"><td class="mdescLeft"> </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>
|
|
<tr class="separator:a0c73e4d84c3e6487d5a7e1f7b0c13ba0"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:a379829f59f04b7694423b3e82d501766"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="namespacefsdk.html#a4d0fbacdb0e56a6f79c2eb3e276c4e83">Error</a> > </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> &&promisedData) noexcept</td></tr>
|
|
<tr class="memdesc:a379829f59f04b7694423b3e82d501766"><td class="mdescLeft"> </td><td class="mdescRight">Fulfill promise with data. Only makes sense if underlying state is Promised. <a href="#a379829f59f04b7694423b3e82d501766">More...</a><br/></td></tr>
|
|
<tr class="separator:a379829f59f04b7694423b3e82d501766"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:accb944e8905435482b8604dfb805d690"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classfsdk_1_1_future.html">Future</a>< <a class="el" href="classfsdk_1_1_promise.html#a289da90b035b98d71ff87b366523d970">DataType</a> > </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>< <a class="el" href="namespacefsdk.html#a4d0fbacdb0e56a6f79c2eb3e276c4e83">Error</a> > &error) noexcept</td></tr>
|
|
<tr class="memdesc:accb944e8905435482b8604dfb805d690"><td class="mdescLeft"> </td><td class="mdescRight">Create tethered future object. Only makes sense if underlying state is Empty. <a href="#accb944e8905435482b8604dfb805d690">More...</a><br/></td></tr>
|
|
<tr class="separator:accb944e8905435482b8604dfb805d690"><td class="memSeparator" colspan="2"> </td></tr>
|
|
<tr class="memitem:acb099562ad549c712fcdca295b379f5d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="namespacefsdk.html#a48fe9106b62424a924a260074cd2c82b">FuturePromiseState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classfsdk_1_1_promise.html#acb099562ad549c712fcdca295b379f5d">state</a> () const noexcept</td></tr>
|
|
<tr class="memdesc:acb099562ad549c712fcdca295b379f5d"><td class="mdescLeft"> </td><td class="mdescRight">Returns current state of future-promise pair. <a href="#acb099562ad549c712fcdca295b379f5d">More...</a><br/></td></tr>
|
|
<tr class="separator:acb099562ad549c712fcdca295b379f5d"><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:a9b3e58dc95742108177ca25db4a933eb"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9b3e58dc95742108177ca25db4a933eb"></a>
|
|
static void </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> &first, <a class="el" href="classfsdk_1_1_promise.html">Promise</a> &second) noexcept</td></tr>
|
|
<tr class="memdesc:a9b3e58dc95742108177ca25db4a933eb"><td class="mdescLeft"> </td><td class="mdescRight">Static method that swaps internal data between two passed promises. <br/></td></tr>
|
|
<tr class="separator:a9b3e58dc95742108177ca25db4a933eb"><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 T><br/>
|
|
class fsdk::Promise< T ></h3>
|
|
|
|
<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>
|
|
<dl class="section note"><dt>Note</dt><dd>Is not instantiable using this header only. </dd></dl>
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
|
<table class="tparams">
|
|
<tr><td class="paramname">T</td><td>data type to store. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
</div><h2 class="groupheader">Member Function Documentation</h2>
|
|
<a class="anchor" id="a7a178efaed788e336ed5305580737e4a"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="namespacefsdk.html#a4d0fbacdb0e56a6f79c2eb3e276c4e83">Error</a>> <a class="el" href="classfsdk_1_1_promise.html">fsdk::Promise</a>< T >::cancel </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>Cancel method. Think of it as acceptance of cancel requested by. </p>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a0c73e4d84c3e6487d5a7e1f7b0c13ba0"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="namespacefsdk.html#a4d0fbacdb0e56a6f79c2eb3e276c4e83">Error</a>> <a class="el" href="classfsdk_1_1_promise.html">fsdk::Promise</a>< T >::fail </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>Fail method. Think of it as valid failure to run some promised function. Only makes sense if underlying state is Promised. </p>
|
|
<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>
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="a379829f59f04b7694423b3e82d501766"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="structfsdk_1_1_result.html">Result</a><<a class="el" href="namespacefsdk.html#a4d0fbacdb0e56a6f79c2eb3e276c4e83">Error</a>> <a class="el" href="classfsdk_1_1_promise.html">fsdk::Promise</a>< T >::fulfill </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="classfsdk_1_1_promise.html#a289da90b035b98d71ff87b366523d970">DataType</a> && </td>
|
|
<td class="paramname"><em>promisedData</em></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>Fulfill promise with data. Only makes sense if underlying state is Promised. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">promisedData</td><td>Rvalue reference to promised data. </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="accb944e8905435482b8604dfb805d690"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="classfsdk_1_1_future.html">Future</a><<a class="el" href="classfsdk_1_1_promise.html#a289da90b035b98d71ff87b366523d970">DataType</a>> <a class="el" href="classfsdk_1_1_promise.html">fsdk::Promise</a>< T >::future </td>
|
|
<td>(</td>
|
|
<td class="paramtype"><a class="el" href="structfsdk_1_1_result.html">Result</a>< <a class="el" href="namespacefsdk.html#a4d0fbacdb0e56a6f79c2eb3e276c4e83">Error</a> > & </td>
|
|
<td class="paramname"><em>error</em></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>Create tethered future object. Only makes sense if underlying state is Empty. </p>
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
|
<table class="params">
|
|
<tr><td class="paramname">error</td><td>Reference to error object to indicate of failure </td></tr>
|
|
</table>
|
|
</dd>
|
|
</dl>
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<a class="anchor" id="acb099562ad549c712fcdca295b379f5d"></a>
|
|
<div class="memitem">
|
|
<div class="memproto">
|
|
<div class="memtemplate">
|
|
template<typename T > </div>
|
|
<table class="mlabels">
|
|
<tr>
|
|
<td class="mlabels-left">
|
|
<table class="memname">
|
|
<tr>
|
|
<td class="memname"><a class="el" href="namespacefsdk.html#a48fe9106b62424a924a260074cd2c82b">FuturePromiseState</a> <a class="el" href="classfsdk_1_1_promise.html">fsdk::Promise</a>< T >::state </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">noexcept</span></span> </td>
|
|
</tr>
|
|
</table>
|
|
</div><div class="memdoc">
|
|
|
|
<p>Returns current state of future-promise pair. </p>
|
|
<dl class="section return"><dt>Returns</dt><dd>Current state </dd></dl>
|
|
<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>
|
|
|
|
</div>
|
|
</div>
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
|
<li>include/fsdk/Types/<a class="el" href="_future_8h_source.html">Future.h</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="namespacefsdk.html">fsdk</a></li><li class="navelem"><a class="el" href="classfsdk_1_1_promise.html">Promise</a></li>
|
|
<li class="footer">Generated on Fri Jun 17 2022 12:19:44 for Face Engine SDK by
|
|
<a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|