| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.17"/> |
| <meta name="viewport" content="width=device-width, initial-scale=1"/> |
| <title> Apache Ignite C++: ignite::Future< void > Class 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> |
| <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="ignite_logo.png"/></td> |
| <td id="projectalign" style="padding-left: 0.5em;"> |
| <div id="projectname"> Apache Ignite C++ |
| </div> |
| </td> |
| </tr> |
| </tbody> |
| </table> |
| </div> |
| <!-- end header part --> |
| <!-- Generated by Doxygen 1.8.17 --> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| var searchBox = new SearchBox("searchBox", "search",false,'Search'); |
| /* @license-end */ |
| </script> |
| <script type="text/javascript" src="menudata.js"></script> |
| <script type="text/javascript" src="menu.js"></script> |
| <script type="text/javascript"> |
| /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */ |
| $(function() { |
| initMenu('',true,false,'search.php','Search'); |
| $(document).ready(function() { init_search(); }); |
| }); |
| /* @license-end */</script> |
| <div id="main-nav"></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< void ></a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-types">Public Types</a> | |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#friends">Friends</a> | |
| <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< void > Class 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 <<a class="el" href="future_8h_source.html">future.h</a>></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 id="ab0fe288cfa7d13ef9f2243f6313990d7"></a> |
| typedef void </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"> </td><td class="mdescRight">Template value type. <br /></td></tr> |
| <tr class="separator:ab0fe288cfa7d13ef9f2243f6313990d7"><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:a759984cc1557ce3ed6430a8f93e82f61"><td class="memItemLeft" align="right" valign="top"> </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>< <a class="el" href="classignite_1_1Future_3_01void_01_4.html#ab0fe288cfa7d13ef9f2243f6313990d7">ValueType</a> > &src)</td></tr> |
| <tr class="memdesc:a759984cc1557ce3ed6430a8f93e82f61"><td class="mdescLeft"> </td><td class="mdescRight">Copy constructor. <a href="classignite_1_1Future_3_01void_01_4.html#a759984cc1557ce3ed6430a8f93e82f61">More...</a><br /></td></tr> |
| <tr class="separator:a759984cc1557ce3ed6430a8f93e82f61"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae5463b058aa141dc9321df728bed98d5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1Future.html">Future</a> & </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>< <a class="el" href="classignite_1_1Future_3_01void_01_4.html#ab0fe288cfa7d13ef9f2243f6313990d7">ValueType</a> > &other)</td></tr> |
| <tr class="memdesc:ae5463b058aa141dc9321df728bed98d5"><td class="mdescLeft"> </td><td class="mdescRight">Assignment operator. <a href="classignite_1_1Future_3_01void_01_4.html#ae5463b058aa141dc9321df728bed98d5">More...</a><br /></td></tr> |
| <tr class="separator:ae5463b058aa141dc9321df728bed98d5"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abfb2edf9b58faafefa6ec5dde9d72ebe"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Future_3_01void_01_4.html#abfb2edf9b58faafefa6ec5dde9d72ebe">Wait</a> () const</td></tr> |
| <tr class="memdesc:abfb2edf9b58faafefa6ec5dde9d72ebe"><td class="mdescLeft"> </td><td class="mdescRight">Wait for value to be set. <a href="classignite_1_1Future_3_01void_01_4.html#abfb2edf9b58faafefa6ec5dde9d72ebe">More...</a><br /></td></tr> |
| <tr class="separator:abfb2edf9b58faafefa6ec5dde9d72ebe"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ab93e601bf38da51a4df68f592eeb6c3f"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Future_3_01void_01_4.html#ab93e601bf38da51a4df68f592eeb6c3f">WaitFor</a> (int32_t msTimeout) const</td></tr> |
| <tr class="memdesc:ab93e601bf38da51a4df68f592eeb6c3f"><td class="mdescLeft"> </td><td class="mdescRight">Wait for value to be set for specified time. <a href="classignite_1_1Future_3_01void_01_4.html#ab93e601bf38da51a4df68f592eeb6c3f">More...</a><br /></td></tr> |
| <tr class="separator:ab93e601bf38da51a4df68f592eeb6c3f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9d915f14c46a3b5d2c8d43f78a9d2a37"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Future_3_01void_01_4.html#a9d915f14c46a3b5d2c8d43f78a9d2a37">GetValue</a> () const</td></tr> |
| <tr class="memdesc:a9d915f14c46a3b5d2c8d43f78a9d2a37"><td class="mdescLeft"> </td><td class="mdescRight">Wait for operation complition or error. <a href="classignite_1_1Future_3_01void_01_4.html#a9d915f14c46a3b5d2c8d43f78a9d2a37">More...</a><br /></td></tr> |
| <tr class="separator:a9d915f14c46a3b5d2c8d43f78a9d2a37"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acca8bb514dd248d61bd28768fccb9cad"><td class="memItemLeft" align="right" valign="top"><a id="acca8bb514dd248d61bd28768fccb9cad"></a> |
| void </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"> </td><td class="mdescRight">Cancel related operation. <br /></td></tr> |
| <tr class="separator:acca8bb514dd248d61bd28768fccb9cad"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:af83cc0bc375a9f42b588362743832f39"><td class="memItemLeft" align="right" valign="top"><a id="af83cc0bc375a9f42b588362743832f39"></a> |
| bool </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"> </td><td class="mdescRight">Check if the future ready. <br /></td></tr> |
| <tr class="separator:af83cc0bc375a9f42b588362743832f39"><td class="memSeparator" colspan="2"> </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 id="ae436b7581649aef421432f7ab1d5d410"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>common::Promise< void ></b></td></tr> |
| <tr class="separator:ae436b7581649aef421432f7ab1d5d410"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Specialization for void type. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a759984cc1557ce3ed6430a8f93e82f61"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a759984cc1557ce3ed6430a8f93e82f61">◆ </a></span>Future()</h2> |
| |
| <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>< void >::<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>< <a class="el" href="classignite_1_1Future_3_01void_01_4.html#ab0fe288cfa7d13ef9f2243f6313990d7">ValueType</a> > & </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 id="a9d915f14c46a3b5d2c8d43f78a9d2a37"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a9d915f14c46a3b5d2c8d43f78a9d2a37">◆ </a></span>GetValue()</h2> |
| |
| <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>< void >::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 id="ae5463b058aa141dc9321df728bed98d5"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae5463b058aa141dc9321df728bed98d5">◆ </a></span>operator=()</h2> |
| |
| <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>& <a class="el" href="classignite_1_1Future.html">ignite::Future</a>< void >::operator= </td> |
| <td>(</td> |
| <td class="paramtype">const <a class="el" href="classignite_1_1Future.html">Future</a>< <a class="el" href="classignite_1_1Future_3_01void_01_4.html#ab0fe288cfa7d13ef9f2243f6313990d7">ValueType</a> > & </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 id="abfb2edf9b58faafefa6ec5dde9d72ebe"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abfb2edf9b58faafefa6ec5dde9d72ebe">◆ </a></span>Wait()</h2> |
| |
| <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>< void >::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 id="ab93e601bf38da51a4df68f592eeb6c3f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ab93e601bf38da51a4df68f592eeb6c3f">◆ </a></span>WaitFor()</h2> |
| |
| <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>< void >::WaitFor </td> |
| <td>(</td> |
| <td class="paramtype">int32_t </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 Jan 10 2022 11:02:04 for Apache Ignite C++ by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.17 |
| </small></address> |
| </body> |
| </html> |
