Google Git
Sign in
apache / ignite-website / refs/heads/revert-3-syntax-highlighter-replacement / . / releases / 2.4.0 / cppdoc / classignite_1_1Future_3_01void_01_4.html
blob: 55741af30413dd0b79cc1eb2aece122b453769ed [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.4.0/cppdoc/classignite_1_1Future_3_01void_01_4.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; void &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="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_3_01void_01_4.html">Future&lt; void &gt;</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_3_01void_01_4-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ignite::Future&lt; void &gt; Class Template Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Specialization for void type.
<a href="classignite_1_1Future_3_01void_01_4.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:ab0fe288cfa7d13ef9f2243f6313990d7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ab0fe288cfa7d13ef9f2243f6313990d7"></a>
typedef void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Future_3_01void_01_4.html#ab0fe288cfa7d13ef9f2243f6313990d7">ValueType</a></td></tr>
<tr class="memdesc:ab0fe288cfa7d13ef9f2243f6313990d7"><td class="mdescLeft">&#160;</td><td class="mdescRight">Template value type. <br /></td></tr>
<tr class="separator:ab0fe288cfa7d13ef9f2243f6313990d7"><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:a759984cc1557ce3ed6430a8f93e82f61"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Future_3_01void_01_4.html#a759984cc1557ce3ed6430a8f93e82f61">Future</a> (const <a class="el" href="classignite_1_1Future.html">Future</a>&lt; <a class="el" href="classignite_1_1Future_3_01void_01_4.html#ab0fe288cfa7d13ef9f2243f6313990d7">ValueType</a> &gt; &amp;src)</td></tr>
<tr class="memdesc:a759984cc1557ce3ed6430a8f93e82f61"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copy constructor. <a href="#a759984cc1557ce3ed6430a8f93e82f61">More...</a><br /></td></tr>
<tr class="separator:a759984cc1557ce3ed6430a8f93e82f61"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ae5463b058aa141dc9321df728bed98d5"><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_3_01void_01_4.html#ae5463b058aa141dc9321df728bed98d5">operator=</a> (const <a class="el" href="classignite_1_1Future.html">Future</a>&lt; <a class="el" href="classignite_1_1Future_3_01void_01_4.html#ab0fe288cfa7d13ef9f2243f6313990d7">ValueType</a> &gt; &amp;other)</td></tr>
<tr class="memdesc:ae5463b058aa141dc9321df728bed98d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Assignment operator. <a href="#ae5463b058aa141dc9321df728bed98d5">More...</a><br /></td></tr>
<tr class="separator:ae5463b058aa141dc9321df728bed98d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7d5d3f278bdfeafdf7f156e5ef4524af"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Future_3_01void_01_4.html#a7d5d3f278bdfeafdf7f156e5ef4524af">Wait</a> () const </td></tr>
<tr class="memdesc:a7d5d3f278bdfeafdf7f156e5ef4524af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for value to be set. <a href="#a7d5d3f278bdfeafdf7f156e5ef4524af">More...</a><br /></td></tr>
<tr class="separator:a7d5d3f278bdfeafdf7f156e5ef4524af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8d8f6cf4741d314fa3c60b30cf3e90c3"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Future_3_01void_01_4.html#a8d8f6cf4741d314fa3c60b30cf3e90c3">WaitFor</a> (int32_t msTimeout) const </td></tr>
<tr class="memdesc:a8d8f6cf4741d314fa3c60b30cf3e90c3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for value to be set for specified time. <a href="#a8d8f6cf4741d314fa3c60b30cf3e90c3">More...</a><br /></td></tr>
<tr class="separator:a8d8f6cf4741d314fa3c60b30cf3e90c3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a53ecb61d7765c7b256a49c43345e20db"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Future_3_01void_01_4.html#a53ecb61d7765c7b256a49c43345e20db">GetValue</a> () const </td></tr>
<tr class="memdesc:a53ecb61d7765c7b256a49c43345e20db"><td class="mdescLeft">&#160;</td><td class="mdescRight">Wait for operation complition or error. <a href="#a53ecb61d7765c7b256a49c43345e20db">More...</a><br /></td></tr>
<tr class="separator:a53ecb61d7765c7b256a49c43345e20db"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acca8bb514dd248d61bd28768fccb9cad"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="acca8bb514dd248d61bd28768fccb9cad"></a>
void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Future_3_01void_01_4.html#acca8bb514dd248d61bd28768fccb9cad">Cancel</a> ()</td></tr>
<tr class="memdesc:acca8bb514dd248d61bd28768fccb9cad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Cancel related operation. <br /></td></tr>
<tr class="separator:acca8bb514dd248d61bd28768fccb9cad"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af83cc0bc375a9f42b588362743832f39"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="af83cc0bc375a9f42b588362743832f39"></a>
bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Future_3_01void_01_4.html#af83cc0bc375a9f42b588362743832f39">IsReady</a> ()</td></tr>
<tr class="memdesc:af83cc0bc375a9f42b588362743832f39"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if the future ready. <br /></td></tr>
<tr class="separator:af83cc0bc375a9f42b588362743832f39"><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:ae436b7581649aef421432f7ab1d5d410"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ae436b7581649aef421432f7ab1d5d410"></a>
class&#160;</td><td class="memItemRight" valign="bottom"><b>common::Promise&lt; void &gt;</b></td></tr>
<tr class="separator:ae436b7581649aef421432f7ab1d5d410"><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;&gt;<br />
class ignite::Future&lt; void &gt;</h3>
<p>Specialization for void type. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a759984cc1557ce3ed6430a8f93e82f61"></a>
<div class="memitem">
<div class="memproto">
<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; void &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_3_01void_01_4.html#ab0fe288cfa7d13ef9f2243f6313990d7">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="a53ecb61d7765c7b256a49c43345e20db"></a>
<div class="memitem">
<div class="memproto">
<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; void &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>Wait for operation complition or error. </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>
</div>
</div>
<a class="anchor" id="ae5463b058aa141dc9321df728bed98d5"></a>
<div class="memitem">
<div class="memproto">
<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; void &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_3_01void_01_4.html#ab0fe288cfa7d13ef9f2243f6313990d7">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="a7d5d3f278bdfeafdf7f156e5ef4524af"></a>
<div class="memitem">
<div class="memproto">
<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; void &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="a8d8f6cf4741d314fa3c60b30cf3e90c3"></a>
<div class="memitem">
<div class="memproto">
<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; void &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 Mon Mar 5 2018 10:33:58 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>