| <!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.6.0/cppdoc/classignite_1_1Ignite.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> Apache Ignite C++: ignite::Ignite 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> |
| <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"> 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 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 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> |
| <!-- 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_1Ignite.html">Ignite</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="summary"> |
| <a href="#pub-methods">Public Member Functions</a> | |
| <a href="#friends">Friends</a> | |
| <a href="classignite_1_1Ignite-members.html">List of all members</a> </div> |
| <div class="headertitle"> |
| <div class="title">ignite::Ignite Class Reference</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| |
| <p>Main interface to operate with Ignite. |
| <a href="classignite_1_1Ignite.html#details">More...</a></p> |
| |
| <p><code>#include <<a class="el" href="ignite_8h_source.html">ignite.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:a200628ace06d6a5240f0e881e5f696ba"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a200628ace06d6a5240f0e881e5f696ba"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Ignite.html#a200628ace06d6a5240f0e881e5f696ba">Ignite</a> ()</td></tr> |
| <tr class="memdesc:a200628ace06d6a5240f0e881e5f696ba"><td class="mdescLeft"> </td><td class="mdescRight">Default constructor. <br /></td></tr> |
| <tr class="separator:a200628ace06d6a5240f0e881e5f696ba"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a4caf21b9a15391ddc58bff2e02e94822"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4caf21b9a15391ddc58bff2e02e94822"></a> |
|  </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Ignite.html#a4caf21b9a15391ddc58bff2e02e94822">Ignite</a> (impl::IgniteImpl *impl)</td></tr> |
| <tr class="memdesc:a4caf21b9a15391ddc58bff2e02e94822"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <br /></td></tr> |
| <tr class="separator:a4caf21b9a15391ddc58bff2e02e94822"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:acc8312cdb2817e21a74206984ba35424"><td class="memItemLeft" align="right" valign="top">const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Ignite.html#acc8312cdb2817e21a74206984ba35424">GetName</a> () const </td></tr> |
| <tr class="memdesc:acc8312cdb2817e21a74206984ba35424"><td class="mdescLeft"> </td><td class="mdescRight">Get <a class="el" href="classignite_1_1Ignite.html" title="Main interface to operate with Ignite. ">Ignite</a> instance name. <a href="#acc8312cdb2817e21a74206984ba35424">More...</a><br /></td></tr> |
| <tr class="separator:acc8312cdb2817e21a74206984ba35424"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac752be43394e4a1bd51ade7095c6dcfe"><td class="memItemLeft" align="right" valign="top">const <a class="el" href="structignite_1_1IgniteConfiguration.html">IgniteConfiguration</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Ignite.html#ac752be43394e4a1bd51ade7095c6dcfe">GetConfiguration</a> () const </td></tr> |
| <tr class="memdesc:ac752be43394e4a1bd51ade7095c6dcfe"><td class="mdescLeft"> </td><td class="mdescRight">Get node configuration. <a href="#ac752be43394e4a1bd51ade7095c6dcfe">More...</a><br /></td></tr> |
| <tr class="separator:ac752be43394e4a1bd51ade7095c6dcfe"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a228adab59e935565341e1f59e6105fc2"><td class="memTemplParams" colspan="2">template<typename K , typename V > </td></tr> |
| <tr class="memitem:a228adab59e935565341e1f59e6105fc2"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1cache_1_1Cache.html">cache::Cache</a>< K, V > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classignite_1_1Ignite.html#a228adab59e935565341e1f59e6105fc2">GetCache</a> (const char *name)</td></tr> |
| <tr class="memdesc:a228adab59e935565341e1f59e6105fc2"><td class="mdescLeft"> </td><td class="mdescRight">Get cache. <a href="#a228adab59e935565341e1f59e6105fc2">More...</a><br /></td></tr> |
| <tr class="separator:a228adab59e935565341e1f59e6105fc2"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a93b1f8ce74129dcf66bf6d94e6485ced"><td class="memTemplParams" colspan="2">template<typename K , typename V > </td></tr> |
| <tr class="memitem:a93b1f8ce74129dcf66bf6d94e6485ced"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1cache_1_1Cache.html">cache::Cache</a>< K, V > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classignite_1_1Ignite.html#a93b1f8ce74129dcf66bf6d94e6485ced">GetCache</a> (const char *name, <a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &err)</td></tr> |
| <tr class="memdesc:a93b1f8ce74129dcf66bf6d94e6485ced"><td class="mdescLeft"> </td><td class="mdescRight">Get cache. <a href="#a93b1f8ce74129dcf66bf6d94e6485ced">More...</a><br /></td></tr> |
| <tr class="separator:a93b1f8ce74129dcf66bf6d94e6485ced"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac066d021e231265dfb6cce35a5d8cde6"><td class="memTemplParams" colspan="2">template<typename K , typename V > </td></tr> |
| <tr class="memitem:ac066d021e231265dfb6cce35a5d8cde6"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1cache_1_1Cache.html">cache::Cache</a>< K, V > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classignite_1_1Ignite.html#ac066d021e231265dfb6cce35a5d8cde6">GetOrCreateCache</a> (const char *name)</td></tr> |
| <tr class="memdesc:ac066d021e231265dfb6cce35a5d8cde6"><td class="mdescLeft"> </td><td class="mdescRight">Get or create cache. <a href="#ac066d021e231265dfb6cce35a5d8cde6">More...</a><br /></td></tr> |
| <tr class="separator:ac066d021e231265dfb6cce35a5d8cde6"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ac5edb29bbf71656b0ec2c4397121e08b"><td class="memTemplParams" colspan="2">template<typename K , typename V > </td></tr> |
| <tr class="memitem:ac5edb29bbf71656b0ec2c4397121e08b"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1cache_1_1Cache.html">cache::Cache</a>< K, V > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classignite_1_1Ignite.html#ac5edb29bbf71656b0ec2c4397121e08b">GetOrCreateCache</a> (const char *name, <a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &err)</td></tr> |
| <tr class="memdesc:ac5edb29bbf71656b0ec2c4397121e08b"><td class="mdescLeft"> </td><td class="mdescRight">Get or create cache. <a href="#ac5edb29bbf71656b0ec2c4397121e08b">More...</a><br /></td></tr> |
| <tr class="separator:ac5edb29bbf71656b0ec2c4397121e08b"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a8f979e79ca480259d62654fe04d12e08"><td class="memTemplParams" colspan="2">template<typename K , typename V > </td></tr> |
| <tr class="memitem:a8f979e79ca480259d62654fe04d12e08"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1cache_1_1Cache.html">cache::Cache</a>< K, V > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classignite_1_1Ignite.html#a8f979e79ca480259d62654fe04d12e08">CreateCache</a> (const char *name)</td></tr> |
| <tr class="memdesc:a8f979e79ca480259d62654fe04d12e08"><td class="mdescLeft"> </td><td class="mdescRight">Create cache. <a href="#a8f979e79ca480259d62654fe04d12e08">More...</a><br /></td></tr> |
| <tr class="separator:a8f979e79ca480259d62654fe04d12e08"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3a8bebe601fd0ae19af43f7498c9f958"><td class="memTemplParams" colspan="2">template<typename K , typename V > </td></tr> |
| <tr class="memitem:a3a8bebe601fd0ae19af43f7498c9f958"><td class="memTemplItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1cache_1_1Cache.html">cache::Cache</a>< K, V > </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classignite_1_1Ignite.html#a3a8bebe601fd0ae19af43f7498c9f958">CreateCache</a> (const char *name, <a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> &err)</td></tr> |
| <tr class="memdesc:a3a8bebe601fd0ae19af43f7498c9f958"><td class="mdescLeft"> </td><td class="mdescRight">Create cache. <a href="#a3a8bebe601fd0ae19af43f7498c9f958">More...</a><br /></td></tr> |
| <tr class="separator:a3a8bebe601fd0ae19af43f7498c9f958"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a5455dd6d8f8453073fbd32c60fe0c3af"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Ignite.html#a5455dd6d8f8453073fbd32c60fe0c3af">IsActive</a> ()</td></tr> |
| <tr class="memdesc:a5455dd6d8f8453073fbd32c60fe0c3af"><td class="mdescLeft"> </td><td class="mdescRight">Check if the <a class="el" href="classignite_1_1Ignite.html" title="Main interface to operate with Ignite. ">Ignite</a> grid is active. <a href="#a5455dd6d8f8453073fbd32c60fe0c3af">More...</a><br /></td></tr> |
| <tr class="separator:a5455dd6d8f8453073fbd32c60fe0c3af"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a481375583b96f54119ef604338cfc5b8"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Ignite.html#a481375583b96f54119ef604338cfc5b8">SetActive</a> (bool active)</td></tr> |
| <tr class="memdesc:a481375583b96f54119ef604338cfc5b8"><td class="mdescLeft"> </td><td class="mdescRight">Change <a class="el" href="classignite_1_1Ignite.html" title="Main interface to operate with Ignite. ">Ignite</a> grid state to active or inactive. <a href="#a481375583b96f54119ef604338cfc5b8">More...</a><br /></td></tr> |
| <tr class="separator:a481375583b96f54119ef604338cfc5b8"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a3689391946e2196ca06ae9672c548711"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1transactions_1_1Transactions.html">transactions::Transactions</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Ignite.html#a3689391946e2196ca06ae9672c548711">GetTransactions</a> ()</td></tr> |
| <tr class="memdesc:a3689391946e2196ca06ae9672c548711"><td class="mdescLeft"> </td><td class="mdescRight">Get transactions. <a href="#a3689391946e2196ca06ae9672c548711">More...</a><br /></td></tr> |
| <tr class="separator:a3689391946e2196ca06ae9672c548711"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a9ccb33becca6d2e74d9447c33a3b1527"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1compute_1_1Compute.html">compute::Compute</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Ignite.html#a9ccb33becca6d2e74d9447c33a3b1527">GetCompute</a> ()</td></tr> |
| <tr class="memdesc:a9ccb33becca6d2e74d9447c33a3b1527"><td class="mdescLeft"> </td><td class="mdescRight">Get compute. <a href="#a9ccb33becca6d2e74d9447c33a3b1527">More...</a><br /></td></tr> |
| <tr class="separator:a9ccb33becca6d2e74d9447c33a3b1527"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:ad01b323b036fb4c4235ce49d632578d4"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1IgniteBinding.html">IgniteBinding</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Ignite.html#ad01b323b036fb4c4235ce49d632578d4">GetBinding</a> ()</td></tr> |
| <tr class="memdesc:ad01b323b036fb4c4235ce49d632578d4"><td class="mdescLeft"> </td><td class="mdescRight">Get ignite binding. <a href="#ad01b323b036fb4c4235ce49d632578d4">More...</a><br /></td></tr> |
| <tr class="separator:ad01b323b036fb4c4235ce49d632578d4"><td class="memSeparator" colspan="2"> </td></tr> |
| <tr class="memitem:a21a987a6fdb740e2f06f63dd36cca91e"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1Ignite.html#a21a987a6fdb740e2f06f63dd36cca91e">IsValid</a> () const </td></tr> |
| <tr class="memdesc:a21a987a6fdb740e2f06f63dd36cca91e"><td class="mdescLeft"> </td><td class="mdescRight">Check if the instance is valid. <a href="#a21a987a6fdb740e2f06f63dd36cca91e">More...</a><br /></td></tr> |
| <tr class="separator:a21a987a6fdb740e2f06f63dd36cca91e"><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:ac021f46714add1bc48c4bb8e631c886d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac021f46714add1bc48c4bb8e631c886d"></a> |
| class </td><td class="memItemRight" valign="bottom"><b>impl::IgniteImpl</b></td></tr> |
| <tr class="separator:ac021f46714add1bc48c4bb8e631c886d"><td class="memSeparator" colspan="2"> </td></tr> |
| </table> |
| <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> |
| <div class="textblock"><p>Main interface to operate with Ignite. </p> |
| <p>This class 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 released automatically once all the instances are destructed. </p> |
| </div><h2 class="groupheader">Member Function Documentation</h2> |
| <a class="anchor" id="a8f979e79ca480259d62654fe04d12e08"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename K , typename V > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classignite_1_1cache_1_1Cache.html">cache::Cache</a><K, V> ignite::Ignite::CreateCache </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>name</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>Create cache. </p> |
| <p>This method should only be used on the valid instance.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>Cache name. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Cache. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3a8bebe601fd0ae19af43f7498c9f958"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename K , typename V > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classignite_1_1cache_1_1Cache.html">cache::Cache</a><K, V> ignite::Ignite::CreateCache </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> & </td> |
| <td class="paramname"><em>err</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>Create cache. </p> |
| <p>This method should only be used on the valid instance.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>Cache name. </td></tr> |
| <tr><td class="paramname">err</td><td>Error; </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Cache. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ad01b323b036fb4c4235ce49d632578d4"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classignite_1_1IgniteBinding.html">IgniteBinding</a> ignite::Ignite::GetBinding </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get ignite binding. </p> |
| <p>This method should only be used on the valid instance.</p> |
| <dl class="section return"><dt>Returns</dt><dd><a class="el" href="classignite_1_1IgniteBinding.html" title="Ignite Binding. ">IgniteBinding</a> class instance. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a228adab59e935565341e1f59e6105fc2"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename K , typename V > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classignite_1_1cache_1_1Cache.html">cache::Cache</a><K, V> ignite::Ignite::GetCache </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>name</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>Get cache. </p> |
| <p>This method should only be used on the valid instance.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>Cache name. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Cache. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a93b1f8ce74129dcf66bf6d94e6485ced"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename K , typename V > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classignite_1_1cache_1_1Cache.html">cache::Cache</a><K, V> ignite::Ignite::GetCache </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> & </td> |
| <td class="paramname"><em>err</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>Get cache. </p> |
| <p>This method should only be used on the valid instance.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>Cache name. </td></tr> |
| <tr><td class="paramname">err</td><td>Error; </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Cache. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a9ccb33becca6d2e74d9447c33a3b1527"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classignite_1_1compute_1_1Compute.html">compute::Compute</a> ignite::Ignite::GetCompute </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get compute. </p> |
| <p>This method should only be called on the valid instance.</p> |
| <dl class="section return"><dt>Returns</dt><dd>Compute class instance. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac752be43394e4a1bd51ade7095c6dcfe"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const <a class="el" href="structignite_1_1IgniteConfiguration.html">IgniteConfiguration</a> & ignite::Ignite::GetConfiguration </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get node configuration. </p> |
| <p>This method should only be used on the valid instance.</p> |
| <dl class="section return"><dt>Returns</dt><dd>Node configuration. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="acc8312cdb2817e21a74206984ba35424"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">const char * ignite::Ignite::GetName </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td> const</td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get <a class="el" href="classignite_1_1Ignite.html" title="Main interface to operate with Ignite. ">Ignite</a> instance name. </p> |
| <dl class="section return"><dt>Returns</dt><dd>Name. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac066d021e231265dfb6cce35a5d8cde6"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename K , typename V > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classignite_1_1cache_1_1Cache.html">cache::Cache</a><K, V> ignite::Ignite::GetOrCreateCache </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>name</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>Get or create cache. </p> |
| <p>This method should only be used on the valid instance.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>Cache name. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Cache. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="ac5edb29bbf71656b0ec2c4397121e08b"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <div class="memtemplate"> |
| template<typename K , typename V > </div> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classignite_1_1cache_1_1Cache.html">cache::Cache</a><K, V> ignite::Ignite::GetOrCreateCache </td> |
| <td>(</td> |
| <td class="paramtype">const char * </td> |
| <td class="paramname"><em>name</em>, </td> |
| </tr> |
| <tr> |
| <td class="paramkey"></td> |
| <td></td> |
| <td class="paramtype"><a class="el" href="classignite_1_1IgniteError.html">IgniteError</a> & </td> |
| <td class="paramname"><em>err</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>Get or create cache. </p> |
| <p>This method should only be used on the valid instance.</p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">name</td><td>Cache name. </td></tr> |
| <tr><td class="paramname">err</td><td>Error; </td></tr> |
| </table> |
| </dd> |
| </dl> |
| <dl class="section return"><dt>Returns</dt><dd>Cache. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a3689391946e2196ca06ae9672c548711"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname"><a class="el" href="classignite_1_1transactions_1_1Transactions.html">transactions::Transactions</a> ignite::Ignite::GetTransactions </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Get transactions. </p> |
| <p>This method should only be used on the valid instance.</p> |
| <dl class="section return"><dt>Returns</dt><dd>Transaction class instance. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a5455dd6d8f8453073fbd32c60fe0c3af"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool ignite::Ignite::IsActive </td> |
| <td>(</td> |
| <td class="paramname"></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Check if the <a class="el" href="classignite_1_1Ignite.html" title="Main interface to operate with Ignite. ">Ignite</a> grid is active. </p> |
| <dl class="section return"><dt>Returns</dt><dd>True if grid is active and false otherwise. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a21a987a6fdb740e2f06f63dd36cca91e"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="mlabels"> |
| <tr> |
| <td class="mlabels-left"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">bool ignite::Ignite::IsValid </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>Check if the instance is valid. </p> |
| <p>Invalid instance can be returned if some of the previous operations have resulted in a failure. For example invalid instance can be returned by not-throwing version of method in case of error. Invalid instances also often can be created using default constructor.</p> |
| <dl class="section return"><dt>Returns</dt><dd>True if the instance is valid and can be used. </dd></dl> |
| |
| </div> |
| </div> |
| <a class="anchor" id="a481375583b96f54119ef604338cfc5b8"></a> |
| <div class="memitem"> |
| <div class="memproto"> |
| <table class="memname"> |
| <tr> |
| <td class="memname">void ignite::Ignite::SetActive </td> |
| <td>(</td> |
| <td class="paramtype">bool </td> |
| <td class="paramname"><em>active</em></td><td>)</td> |
| <td></td> |
| </tr> |
| </table> |
| </div><div class="memdoc"> |
| |
| <p>Change <a class="el" href="classignite_1_1Ignite.html" title="Main interface to operate with Ignite. ">Ignite</a> grid state to active or inactive. </p> |
| <dl class="params"><dt>Parameters</dt><dd> |
| <table class="params"> |
| <tr><td class="paramname">active</td><td>If true start activation process. If false start deactivation process. </td></tr> |
| </table> |
| </dd> |
| </dl> |
| |
| </div> |
| </div> |
| <hr/>The documentation for this class was generated from the following files:<ul> |
| <li><a class="el" href="ignite_8h_source.html">ignite.h</a></li> |
| <li>ignite.cpp</li> |
| </ul> |
| </div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Tue Jul 10 2018 10:57:32 for Apache Ignite C++ by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="doxygen.png" alt="doxygen"/> |
| </a> 1.8.11 |
| </small></address> |
| </body> |
| </html> |
