| <!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::thin::compute::ComputeClient 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="namespaceignite_1_1thin.html">thin</a></li><li class="navelem"><b>compute</b></li><li class="navelem"><a class="el" href="classignite_1_1thin_1_1compute_1_1ComputeClient.html">ComputeClient</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="classignite_1_1thin_1_1compute_1_1ComputeClient-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">ignite::thin::compute::ComputeClient Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Client Compute API. |
| <a href="classignite_1_1thin_1_1compute_1_1ComputeClient.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="compute__client_8h_source.html">compute_client.h</a>></code></p> |
| <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:a91affd6deb16b723b48e074d2bf11d37"><td class="memItemLeft" align="right" valign="top"><a id="a91affd6deb16b723b48e074d2bf11d37"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1compute_1_1ComputeClient.html#a91affd6deb16b723b48e074d2bf11d37">ComputeClient</a> ()</td></tr> |
| <tr class="memdesc:a91affd6deb16b723b48e074d2bf11d37"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr> |
| <tr class="separator:a91affd6deb16b723b48e074d2bf11d37"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3d5d385aca324a58700dcb1e25afb021"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1compute_1_1ComputeClient.html#a3d5d385aca324a58700dcb1e25afb021">ComputeClient</a> (const SP_Void &impl)</td></tr> |
| <tr class="memdesc:a3d5d385aca324a58700dcb1e25afb021"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="classignite_1_1thin_1_1compute_1_1ComputeClient.html#a3d5d385aca324a58700dcb1e25afb021">More...</a><br /></td></tr> |
| <tr class="separator:a3d5d385aca324a58700dcb1e25afb021"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acc72f9378d6cbfced0ebda55d02e7bc2"><td class="memItemLeft" align="right" valign="top"><a id="acc72f9378d6cbfced0ebda55d02e7bc2"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1compute_1_1ComputeClient.html#acc72f9378d6cbfced0ebda55d02e7bc2">~ComputeClient</a> ()</td></tr> |
| <tr class="memdesc:acc72f9378d6cbfced0ebda55d02e7bc2"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr> |
| <tr class="separator:acc72f9378d6cbfced0ebda55d02e7bc2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8e5e8d6b1b559d976dfce3a3016a409d"><td class="memTemplParams" colspan="2">template<typename R , typename A > </td></tr> |
| <tr class="memitem:a8e5e8d6b1b559d976dfce3a3016a409d"><td class="memTemplItemLeft" align="right" valign="top">R </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1compute_1_1ComputeClient.html#a8e5e8d6b1b559d976dfce3a3016a409d">ExecuteJavaTask</a> (const std::string &taskName, const A &taskArg)</td></tr> |
| <tr class="memdesc:a8e5e8d6b1b559d976dfce3a3016a409d"><td class="mdescLeft"> </td><td class="mdescRight">Executes given Java task by class name. <a href="classignite_1_1thin_1_1compute_1_1ComputeClient.html#a8e5e8d6b1b559d976dfce3a3016a409d">More...</a><br /></td></tr> |
| <tr class="separator:a8e5e8d6b1b559d976dfce3a3016a409d"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:abf3a2123bb61a97c454a19a6912c5ced"><td class="memTemplParams" colspan="2">template<typename R > </td></tr> |
| <tr class="memitem:abf3a2123bb61a97c454a19a6912c5ced"><td class="memTemplItemLeft" align="right" valign="top">R </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1compute_1_1ComputeClient.html#abf3a2123bb61a97c454a19a6912c5ced">ExecuteJavaTask</a> (const std::string &taskName)</td></tr> |
| <tr class="memdesc:abf3a2123bb61a97c454a19a6912c5ced"><td class="mdescLeft"> </td><td class="mdescRight">Executes given Java task by class name. <a href="classignite_1_1thin_1_1compute_1_1ComputeClient.html#abf3a2123bb61a97c454a19a6912c5ced">More...</a><br /></td></tr> |
| <tr class="separator:abf3a2123bb61a97c454a19a6912c5ced"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac28afc1c253a3206d230d869965b5130"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1thin_1_1compute_1_1ComputeClient.html">ComputeClient</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1compute_1_1ComputeClient.html#ac28afc1c253a3206d230d869965b5130">WithTimeout</a> (int64_t timeoutMs)</td></tr> |
| <tr class="memdesc:ac28afc1c253a3206d230d869965b5130"><td class="mdescLeft"> </td><td class="mdescRight">Returns a new instance of <a class="el" href="classignite_1_1thin_1_1compute_1_1ComputeClient.html" title="Client Compute API.">ComputeClient</a> with a timeout for all task executions. <a href="classignite_1_1thin_1_1compute_1_1ComputeClient.html#ac28afc1c253a3206d230d869965b5130">More...</a><br /></td></tr> |
| <tr class="separator:ac28afc1c253a3206d230d869965b5130"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ae8182c721ea713cb15e71c01f0c9e87f"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1thin_1_1compute_1_1ComputeClient.html">ComputeClient</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1compute_1_1ComputeClient.html#ae8182c721ea713cb15e71c01f0c9e87f">WithNoFailover</a> ()</td></tr> |
| <tr class="memdesc:ae8182c721ea713cb15e71c01f0c9e87f"><td class="mdescLeft"> </td><td class="mdescRight">Returns a new instance of <a class="el" href="classignite_1_1thin_1_1compute_1_1ComputeClient.html" title="Client Compute API.">ComputeClient</a> with disabled failover. <a href="classignite_1_1thin_1_1compute_1_1ComputeClient.html#ae8182c721ea713cb15e71c01f0c9e87f">More...</a><br /></td></tr> |
| <tr class="separator:ae8182c721ea713cb15e71c01f0c9e87f"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a6ceec230bc588b5d45a9022c39af9020"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1thin_1_1compute_1_1ComputeClient.html">ComputeClient</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1thin_1_1compute_1_1ComputeClient.html#a6ceec230bc588b5d45a9022c39af9020">WithNoResultCache</a> ()</td></tr> |
| <tr class="memdesc:a6ceec230bc588b5d45a9022c39af9020"><td class="mdescLeft"> </td><td class="mdescRight">Returns a new instance of <a class="el" href="classignite_1_1thin_1_1compute_1_1ComputeClient.html" title="Client Compute API.">ComputeClient</a> with disabled result cache. <a href="classignite_1_1thin_1_1compute_1_1ComputeClient.html#a6ceec230bc588b5d45a9022c39af9020">More...</a><br /></td></tr> |
| <tr class="separator:a6ceec230bc588b5d45a9022c39af9020"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Client Compute API. </p> |
| <dl class="section see"><dt>See also</dt><dd><a class="el" href="classignite_1_1thin_1_1IgniteClient.html#a3628067cc14b1a5caa795f8b27a82cca" title="Get client compute API.">IgniteClient::GetCompute()</a></dd></dl> |
| <p>This class is implemented as a reference to an implementation so copying of this class instance will only create another reference to the same underlying object. Underlying object will be released automatically once all the instances are destructed. </p> |
| </div><h2 class="groupheader">Constructor & Destructor Documentation</h2> |
| <a id="a3d5d385aca324a58700dcb1e25afb021"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a3d5d385aca324a58700dcb1e25afb021">◆ </a></span>ComputeClient()</h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">ignite::thin::compute::ComputeClient::ComputeClient </td> |
| <td>(</td> |
| <td class="paramtype">const SP_Void & </td> |
| <td class="paramname"><em>impl</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>Constructor. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">impl</td><td>Implementation. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <h2 class="groupheader">Member Function Documentation</h2> |
| <a id="abf3a2123bb61a97c454a19a6912c5ced"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#abf3a2123bb61a97c454a19a6912c5ced">◆ </a></span>ExecuteJavaTask() <span class="overload">[1/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename R > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">R ignite::thin::compute::ComputeClient::ExecuteJavaTask </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>taskName</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>Executes given Java task by class name. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">taskName</td><td>Java task name. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Task result of type <code>R</code>.</dd></dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">R</td><td>Type of task result. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="a8e5e8d6b1b559d976dfce3a3016a409d"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a8e5e8d6b1b559d976dfce3a3016a409d">◆ </a></span>ExecuteJavaTask() <span class="overload">[2/2]</span></h2> |
| |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename R , typename A > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">R ignite::thin::compute::ComputeClient::ExecuteJavaTask </td> |
| <td>(</td> |
| <td class="paramtype">const std::string & </td> |
| <td class="paramname"><em>taskName</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype">const A & </td> |
| <td class="paramname"><em>taskArg</em> </td> |
| </tr> |
| <tr> |
| <td></td> |
| <td>)</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>Executes given Java task by class name. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">taskName</td><td>Java task name. </td></tr> |
| <tr><td class="paramname">taskArg</td><td>Argument of task execution of type A. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Task result of type <code>R</code>.</dd></dl> |
| <dl class="tparams"><dt>Template Parameters</dt><dd> |
| <table class="tparams"> |
| <tr><td class="paramname">R</td><td>Type of task result. </td></tr> |
| <tr><td class="paramname">A</td><td>Type of task argument. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <a id="ae8182c721ea713cb15e71c01f0c9e87f"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ae8182c721ea713cb15e71c01f0c9e87f">◆ </a></span>WithNoFailover()</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_1thin_1_1compute_1_1ComputeClient.html">ComputeClient</a> ignite::thin::compute::ComputeClient::WithNoFailover </td> |
| <td>(</td> |
| <td class="paramname"></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>Returns a new instance of <a class="el" href="classignite_1_1thin_1_1compute_1_1ComputeClient.html" title="Client Compute API.">ComputeClient</a> with disabled failover. </p> |
| <p>When failover is disabled, compute jobs won't be retried in case of node crashes.</p> |
| <dl class="section return"><dt>Returns</dt><dd>New Compute instance with disabled failover. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="a6ceec230bc588b5d45a9022c39af9020"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#a6ceec230bc588b5d45a9022c39af9020">◆ </a></span>WithNoResultCache()</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_1thin_1_1compute_1_1ComputeClient.html">ComputeClient</a> ignite::thin::compute::ComputeClient::WithNoResultCache </td> |
| <td>(</td> |
| <td class="paramname"></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>Returns a new instance of <a class="el" href="classignite_1_1thin_1_1compute_1_1ComputeClient.html" title="Client Compute API.">ComputeClient</a> with disabled result cache. </p> |
| <dl class="section return"><dt>Returns</dt><dd>New Compute instance with disabled result cache. </dd></dl> |
| |
| </div> |
| </div> |
| <a id="ac28afc1c253a3206d230d869965b5130"></a> |
| <h2 class="memtitle"><span class="permalink"><a href="#ac28afc1c253a3206d230d869965b5130">◆ </a></span>WithTimeout()</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_1thin_1_1compute_1_1ComputeClient.html">ComputeClient</a> ignite::thin::compute::ComputeClient::WithTimeout </td> |
| <td>(</td> |
| <td class="paramtype">int64_t </td> |
| <td class="paramname"><em>timeoutMs</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>Returns a new instance of <a class="el" href="classignite_1_1thin_1_1compute_1_1ComputeClient.html" title="Client Compute API.">ComputeClient</a> with a timeout for all task executions. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">timeoutMs</td><td>Timeout in milliseconds. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>New <a class="el" href="classignite_1_1thin_1_1compute_1_1ComputeClient.html" title="Client Compute API.">ComputeClient</a> instance with timeout. </dd></dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following file:<ul> |
| <li><a class="el" href="compute__client_8h_source.html">compute_client.h</a></li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Wed Apr 20 2022 15:34:31 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> |
