blob: 637bb399843c491f28371dfbddae6a1f49cacc26 [file] [log] [blame]
<!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>
<link rel="canonical" href="https://ignite.apache.org/releases/2.7.0/cppdoc/classignite_1_1Future.html" />
<META NAME="ROBOTS" CONTENT="NOINDEX">
<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.11"/>
<title>&nbsp; Apache Ignite C++: ignite::Future&lt; T &gt; 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<script>
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
})(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
ga('create', 'UA-61232409-1', 'auto');
ga('send', 'pageview');
</script></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="ignite_logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">&nbsp; Apache Ignite C++
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<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&#160;Page</span></a></li>
<li><a href="pages.html"><span>Related&#160;Pages</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&#160;List</span></a></li>
<li><a href="classes.html"><span>Class&#160;Index</span></a></li>
<li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class&#160;Members</span></a></li>
</ul>
</div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceignite.html">ignite</a></li><li class="navelem"><a class="el" href="classignite_1_1Future.html">Future</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#friends">Friends</a> &#124;
<a href="classignite_1_1Future-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ignite::Future&lt; T &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p><a class="el" href="classignite_1_1Future.html" title="Future class template. ">Future</a> class template.
<a href="classignite_1_1Future.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="future_8h_source.html">future.h</a>&gt;</code></p>
<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:a9d30e65c248b3b2dddb620bf99e0c06a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a9d30e65c248b3b2dddb620bf99e0c06a"></a>
typedef T&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Future.html#a9d30e65c248b3b2dddb620bf99e0c06a">ValueType</a></td></tr>
<tr class="memdesc:a9d30e65c248b3b2dddb620bf99e0c06a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Template value type. <br /></td></tr>
<tr class="separator:a9d30e65c248b3b2dddb620bf99e0c06a"><td class="memSeparator" colspan="2">&#160;</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:a5dd1c5eb96ad2d3cae49f03cfd7b7c8d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Future.html#a5dd1c5eb96ad2d3cae49f03cfd7b7c8d">Future</a> (const <a class="el" href="classignite_1_1Future.html">Future</a>&lt; <a class="el" href="classignite_1_1Future.html#a9d30e65c248b3b2dddb620bf99e0c06a">ValueType</a> &gt; &amp;src)</td></tr>
<tr class="memdesc:a5dd1c5eb96ad2d3cae49f03cfd7b7c8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <a href="#a5dd1c5eb96ad2d3cae49f03cfd7b7c8d">More...</a><br /></td></tr>
<tr class="separator:a5dd1c5eb96ad2d3cae49f03cfd7b7c8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab22e443f0d35cecfdd677dc237c0c4f7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1Future.html">Future</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Future.html#ab22e443f0d35cecfdd677dc237c0c4f7">operator=</a> (const <a class="el" href="classignite_1_1Future.html">Future</a>&lt; <a class="el" href="classignite_1_1Future.html#a9d30e65c248b3b2dddb620bf99e0c06a">ValueType</a> &gt; &amp;other)</td></tr>
<tr class="memdesc:ab22e443f0d35cecfdd677dc237c0c4f7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator. <a href="#ab22e443f0d35cecfdd677dc237c0c4f7">More...</a><br /></td></tr>
<tr class="separator:ab22e443f0d35cecfdd677dc237c0c4f7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d130b07c96c9a4077bda10df7844181"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Future.html#a2d130b07c96c9a4077bda10df7844181">Wait</a> () const </td></tr>
<tr class="memdesc:a2d130b07c96c9a4077bda10df7844181"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for value to be set. <a href="#a2d130b07c96c9a4077bda10df7844181">More...</a><br /></td></tr>
<tr class="separator:a2d130b07c96c9a4077bda10df7844181"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad33d4c003657d5f61ed1066e1b2761e4"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Future.html#ad33d4c003657d5f61ed1066e1b2761e4">WaitFor</a> (int32_t msTimeout) const </td></tr>
<tr class="memdesc:ad33d4c003657d5f61ed1066e1b2761e4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for value to be set for specified time. <a href="#ad33d4c003657d5f61ed1066e1b2761e4">More...</a><br /></td></tr>
<tr class="separator:ad33d4c003657d5f61ed1066e1b2761e4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abcd99fe69de65478b946f3c37e1aa084"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="classignite_1_1Future.html#a9d30e65c248b3b2dddb620bf99e0c06a">ValueType</a> &amp;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Future.html#abcd99fe69de65478b946f3c37e1aa084">GetValue</a> () const </td></tr>
<tr class="memdesc:abcd99fe69de65478b946f3c37e1aa084"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the set value. <a href="#abcd99fe69de65478b946f3c37e1aa084">More...</a><br /></td></tr>
<tr class="separator:abcd99fe69de65478b946f3c37e1aa084"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a01ea459a52a53e861c22d7c1ba6669d1"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a01ea459a52a53e861c22d7c1ba6669d1"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Future.html#a01ea459a52a53e861c22d7c1ba6669d1">Cancel</a> ()</td></tr>
<tr class="memdesc:a01ea459a52a53e861c22d7c1ba6669d1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel related operation. <br /></td></tr>
<tr class="separator:a01ea459a52a53e861c22d7c1ba6669d1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:abd7a19a568856867d220383751af553b"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="abd7a19a568856867d220383751af553b"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Future.html#abd7a19a568856867d220383751af553b">IsReady</a> ()</td></tr>
<tr class="memdesc:abd7a19a568856867d220383751af553b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the future ready. <br /></td></tr>
<tr class="separator:abd7a19a568856867d220383751af553b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="friends"></a>
Friends</h2></td></tr>
<tr class="memitem:ab1fab912ba0e2d09e9ac1998374d433e"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab1fab912ba0e2d09e9ac1998374d433e"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>common::Promise&lt; T &gt;</b></td></tr>
<tr class="separator:ab1fab912ba0e2d09e9ac1998374d433e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;typename T&gt;<br />
class ignite::Future&lt; T &gt;</h3>
<p><a class="el" href="classignite_1_1Future.html" title="Future class template. ">Future</a> class template. </p>
<p>Used to get result of the asynchroniously started computation.</p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td><a class="el" href="classignite_1_1Future.html" title="Future class template. ">Future</a> value type. </td></tr>
</table>
</dd>
</dl>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a5dd1c5eb96ad2d3cae49f03cfd7b7c8d"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classignite_1_1Future.html">ignite::Future</a>&lt; T &gt;::<a class="el" href="classignite_1_1Future.html">Future</a> </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classignite_1_1Future.html">Future</a>&lt; <a class="el" href="classignite_1_1Future.html#a9d30e65c248b3b2dddb620bf99e0c06a">ValueType</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>src</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Copy constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>Instance to copy. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="abcd99fe69de65478b946f3c37e1aa084"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const <a class="el" href="classignite_1_1Future.html#a9d30e65c248b3b2dddb620bf99e0c06a">ValueType</a>&amp; <a class="el" href="classignite_1_1Future.html">ignite::Future</a>&lt; T &gt;::GetValue </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the set value. </p>
<p>Active thread will be blocked until value or error will be set.</p>
<dl class="exception"><dt>Exceptions</dt><dd>
<table class="exception">
<tr><td class="paramname"><a class="el" href="classignite_1_1IgniteError.html" title="Ignite error information. ">IgniteError</a></td><td>if error has been set. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Value that has been set on success. </dd></dl>
</div>
</div>
<a class="anchor" id="ab22e443f0d35cecfdd677dc237c0c4f7"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classignite_1_1Future.html">Future</a>&amp; <a class="el" href="classignite_1_1Future.html">ignite::Future</a>&lt; T &gt;::operator= </td>
<td>(</td>
<td class="paramtype">const <a class="el" href="classignite_1_1Future.html">Future</a>&lt; <a class="el" href="classignite_1_1Future.html#a9d30e65c248b3b2dddb620bf99e0c06a">ValueType</a> &gt; &amp;&#160;</td>
<td class="paramname"><em>other</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Assignment operator. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">other</td><td>Other instance. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>*this. </dd></dl>
</div>
</div>
<a class="anchor" id="a2d130b07c96c9a4077bda10df7844181"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void <a class="el" href="classignite_1_1Future.html">ignite::Future</a>&lt; T &gt;::Wait </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Wait for value to be set. </p>
<p>Active thread will be blocked until value or error will be set. </p>
</div>
</div>
<a class="anchor" id="ad33d4c003657d5f61ed1066e1b2761e4"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;typename T&gt; </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classignite_1_1Future.html">ignite::Future</a>&lt; T &gt;::WaitFor </td>
<td>(</td>
<td class="paramtype">int32_t&#160;</td>
<td class="paramname"><em>msTimeout</em></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Wait for value to be set for specified time. </p>
<p>Active thread will be blocked until value or error will be set or timeout will end.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">msTimeout</td><td>Timeout in milliseconds. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if the object has been triggered and false in case of timeout. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="future_8h_source.html">future.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Nov 30 2018 20:09:21 for &nbsp; Apache Ignite C++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>