blob: 949c3d71856598fd987b23abe8e2e3887231f284 [file] [log] [blame]
<!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>&nbsp; Apache Ignite C++: ignite::cluster::IgniteCluster 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">&nbsp; 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&amp;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&amp;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"><b>cluster</b></li><li class="navelem"><a class="el" href="classignite_1_1cluster_1_1IgniteCluster.html">IgniteCluster</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classignite_1_1cluster_1_1IgniteCluster-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">ignite::cluster::IgniteCluster Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Represents whole cluster (all available nodes).
<a href="classignite_1_1cluster_1_1IgniteCluster.html#details">More...</a></p>
<p><code>#include &lt;<a class="el" href="ignite__cluster_8h_source.html">ignite_cluster.h</a>&gt;</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:ab7636316aa98527bfef1000b010fd59c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cluster_1_1IgniteCluster.html#ab7636316aa98527bfef1000b010fd59c">IgniteCluster</a> (common::concurrent::SharedPointer&lt; ignite::impl::cluster::IgniteClusterImpl &gt; impl)</td></tr>
<tr class="memdesc:ab7636316aa98527bfef1000b010fd59c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor. <a href="classignite_1_1cluster_1_1IgniteCluster.html#ab7636316aa98527bfef1000b010fd59c">More...</a><br /></td></tr>
<tr class="separator:ab7636316aa98527bfef1000b010fd59c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3aa85b4bc7b9e27b8e432c662b0b380a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cluster_1_1IgniteCluster.html#a3aa85b4bc7b9e27b8e432c662b0b380a">IsActive</a> ()</td></tr>
<tr class="memdesc:a3aa85b4bc7b9e27b8e432c662b0b380a"><td class="mdescLeft">&#160;</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="classignite_1_1cluster_1_1IgniteCluster.html#a3aa85b4bc7b9e27b8e432c662b0b380a">More...</a><br /></td></tr>
<tr class="separator:a3aa85b4bc7b9e27b8e432c662b0b380a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a19bf40d6419f54113c40cf230db5555a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cluster_1_1IgniteCluster.html#a19bf40d6419f54113c40cf230db5555a">SetActive</a> (bool active)</td></tr>
<tr class="memdesc:a19bf40d6419f54113c40cf230db5555a"><td class="mdescLeft">&#160;</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="classignite_1_1cluster_1_1IgniteCluster.html#a19bf40d6419f54113c40cf230db5555a">More...</a><br /></td></tr>
<tr class="separator:a19bf40d6419f54113c40cf230db5555a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a15576e64bbd3ae505fbe7f0db106f097"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cluster_1_1IgniteCluster.html#a15576e64bbd3ae505fbe7f0db106f097">DisableWal</a> (std::string cacheName)</td></tr>
<tr class="memdesc:a15576e64bbd3ae505fbe7f0db106f097"><td class="mdescLeft">&#160;</td><td class="mdescRight">Disable write-ahead logging for specified cache. <a href="classignite_1_1cluster_1_1IgniteCluster.html#a15576e64bbd3ae505fbe7f0db106f097">More...</a><br /></td></tr>
<tr class="separator:a15576e64bbd3ae505fbe7f0db106f097"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acee0a58a3c7cef464b13bb9361ae4aba"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cluster_1_1IgniteCluster.html#acee0a58a3c7cef464b13bb9361ae4aba">EnableWal</a> (std::string cacheName)</td></tr>
<tr class="memdesc:acee0a58a3c7cef464b13bb9361ae4aba"><td class="mdescLeft">&#160;</td><td class="mdescRight">Enable write-ahead logging for specified cache. <a href="classignite_1_1cluster_1_1IgniteCluster.html#acee0a58a3c7cef464b13bb9361ae4aba">More...</a><br /></td></tr>
<tr class="separator:acee0a58a3c7cef464b13bb9361ae4aba"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2c1f26d1d56ac9128da3c5917d181712"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cluster_1_1IgniteCluster.html#a2c1f26d1d56ac9128da3c5917d181712">IsWalEnabled</a> (std::string cacheName)</td></tr>
<tr class="memdesc:a2c1f26d1d56ac9128da3c5917d181712"><td class="mdescLeft">&#160;</td><td class="mdescRight">Check if write - ahead logging is enabled for specified cache. <a href="classignite_1_1cluster_1_1IgniteCluster.html#a2c1f26d1d56ac9128da3c5917d181712">More...</a><br /></td></tr>
<tr class="separator:a2c1f26d1d56ac9128da3c5917d181712"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afbca46b0ec52d7469a95e4587fc75f38"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1cluster_1_1ClusterGroup.html">cluster::ClusterGroup</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cluster_1_1IgniteCluster.html#afbca46b0ec52d7469a95e4587fc75f38">ForLocal</a> ()</td></tr>
<tr class="memdesc:afbca46b0ec52d7469a95e4587fc75f38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a cluster group consisting from the local node. <a href="classignite_1_1cluster_1_1IgniteCluster.html#afbca46b0ec52d7469a95e4587fc75f38">More...</a><br /></td></tr>
<tr class="separator:afbca46b0ec52d7469a95e4587fc75f38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6438ceefeae9080b4f4a1772a483ac38"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1cluster_1_1ClusterNode.html">cluster::ClusterNode</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cluster_1_1IgniteCluster.html#a6438ceefeae9080b4f4a1772a483ac38">GetLocalNode</a> ()</td></tr>
<tr class="memdesc:a6438ceefeae9080b4f4a1772a483ac38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get local grid node. <a href="classignite_1_1cluster_1_1IgniteCluster.html#a6438ceefeae9080b4f4a1772a483ac38">More...</a><br /></td></tr>
<tr class="separator:a6438ceefeae9080b4f4a1772a483ac38"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0b6797cbceb7ea170ef25889a39ee19a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cluster_1_1IgniteCluster.html#a0b6797cbceb7ea170ef25889a39ee19a">SetBaselineTopologyVersion</a> (int64_t topVer)</td></tr>
<tr class="memdesc:a0b6797cbceb7ea170ef25889a39ee19a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set baseline topology constructed from the cluster topology of the given version. <a href="classignite_1_1cluster_1_1IgniteCluster.html#a0b6797cbceb7ea170ef25889a39ee19a">More...</a><br /></td></tr>
<tr class="separator:a0b6797cbceb7ea170ef25889a39ee19a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aebf7dcf1f1d51e004336c227876945d6"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cluster_1_1IgniteCluster.html#aebf7dcf1f1d51e004336c227876945d6">SetTxTimeoutOnPartitionMapExchange</a> (int64_t timeout)</td></tr>
<tr class="memdesc:aebf7dcf1f1d51e004336c227876945d6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set transaction timeout on partition map exchange. <a href="classignite_1_1cluster_1_1IgniteCluster.html#aebf7dcf1f1d51e004336c227876945d6">More...</a><br /></td></tr>
<tr class="separator:aebf7dcf1f1d51e004336c227876945d6"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a234aae299ac12964fa8f5d419478701b"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cluster_1_1IgniteCluster.html#a234aae299ac12964fa8f5d419478701b">PingNode</a> (<a class="el" href="classignite_1_1Guid.html">Guid</a> nid)</td></tr>
<tr class="memdesc:a234aae299ac12964fa8f5d419478701b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Ping node. <a href="classignite_1_1cluster_1_1IgniteCluster.html#a234aae299ac12964fa8f5d419478701b">More...</a><br /></td></tr>
<tr class="separator:a234aae299ac12964fa8f5d419478701b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a70554d3cced5771425677bce375b95c5"><td class="memItemLeft" align="right" valign="top">std::vector&lt; <a class="el" href="classignite_1_1cluster_1_1ClusterNode.html">ClusterNode</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cluster_1_1IgniteCluster.html#a70554d3cced5771425677bce375b95c5">GetTopology</a> (int64_t version)</td></tr>
<tr class="memdesc:a70554d3cced5771425677bce375b95c5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get a topology by version. <a href="classignite_1_1cluster_1_1IgniteCluster.html#a70554d3cced5771425677bce375b95c5">More...</a><br /></td></tr>
<tr class="separator:a70554d3cced5771425677bce375b95c5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2ab37de08bfe9b3cf6e51d2625e3e503"><td class="memItemLeft" align="right" valign="top">int64_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cluster_1_1IgniteCluster.html#a2ab37de08bfe9b3cf6e51d2625e3e503">GetTopologyVersion</a> ()</td></tr>
<tr class="memdesc:a2ab37de08bfe9b3cf6e51d2625e3e503"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get current topology version. <a href="classignite_1_1cluster_1_1IgniteCluster.html#a2ab37de08bfe9b3cf6e51d2625e3e503">More...</a><br /></td></tr>
<tr class="separator:a2ab37de08bfe9b3cf6e51d2625e3e503"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a557842993b06ffbd08821c4aa18cbf44"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classignite_1_1cluster_1_1ClusterGroup.html">ClusterGroup</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classignite_1_1cluster_1_1IgniteCluster.html#a557842993b06ffbd08821c4aa18cbf44">AsClusterGroup</a> ()</td></tr>
<tr class="memdesc:a557842993b06ffbd08821c4aa18cbf44"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get cluster group consisting of all cluster nodes. <a href="classignite_1_1cluster_1_1IgniteCluster.html#a557842993b06ffbd08821c4aa18cbf44">More...</a><br /></td></tr>
<tr class="separator:a557842993b06ffbd08821c4aa18cbf44"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Represents whole cluster (all available nodes). </p>
<p>Node-local map is useful for saving shared state between job executions on the grid. Additionally you can also ping, start, and restart remote nodes, map keys to caching nodes, and get other useful information about topology. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="ab7636316aa98527bfef1000b010fd59c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab7636316aa98527bfef1000b010fd59c">&#9670;&nbsp;</a></span>IgniteCluster()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">ignite::cluster::IgniteCluster::IgniteCluster </td>
<td>(</td>
<td class="paramtype">common::concurrent::SharedPointer&lt; ignite::impl::cluster::IgniteClusterImpl &gt;&#160;</td>
<td class="paramname"><em>impl</em></td><td>)</td>
<td></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>Pointer to ignite cluster implementation. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="a557842993b06ffbd08821c4aa18cbf44"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a557842993b06ffbd08821c4aa18cbf44">&#9670;&nbsp;</a></span>AsClusterGroup()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classignite_1_1cluster_1_1ClusterGroup.html">ClusterGroup</a> ignite::cluster::IgniteCluster::AsClusterGroup </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get cluster group consisting of all cluster nodes. </p>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="classignite_1_1cluster_1_1ClusterGroup.html" title="Defines a cluster group which contains all or a subset of cluster nodes.">ClusterGroup</a> instance. </dd></dl>
</div>
</div>
<a id="a15576e64bbd3ae505fbe7f0db106f097"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a15576e64bbd3ae505fbe7f0db106f097">&#9670;&nbsp;</a></span>DisableWal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ignite::cluster::IgniteCluster::DisableWal </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>cacheName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Disable write-ahead logging for specified cache. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cacheName</td><td>Cache name. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="acee0a58a3c7cef464b13bb9361ae4aba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#acee0a58a3c7cef464b13bb9361ae4aba">&#9670;&nbsp;</a></span>EnableWal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ignite::cluster::IgniteCluster::EnableWal </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>cacheName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Enable write-ahead logging for specified cache. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cacheName</td><td>Cache name. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="afbca46b0ec52d7469a95e4587fc75f38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afbca46b0ec52d7469a95e4587fc75f38">&#9670;&nbsp;</a></span>ForLocal()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classignite_1_1cluster_1_1ClusterGroup.html">ClusterGroup</a> ignite::cluster::IgniteCluster::ForLocal </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a cluster group consisting from the local node. </p>
<dl class="section return"><dt>Returns</dt><dd>Cluster group consisting from the local node. </dd></dl>
</div>
</div>
<a id="a6438ceefeae9080b4f4a1772a483ac38"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6438ceefeae9080b4f4a1772a483ac38">&#9670;&nbsp;</a></span>GetLocalNode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classignite_1_1cluster_1_1ClusterNode.html">ClusterNode</a> ignite::cluster::IgniteCluster::GetLocalNode </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get local grid node. </p>
<dl class="section return"><dt>Returns</dt><dd>Local node. </dd></dl>
</div>
</div>
<a id="a70554d3cced5771425677bce375b95c5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a70554d3cced5771425677bce375b95c5">&#9670;&nbsp;</a></span>GetTopology()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">std::vector&lt; <a class="el" href="classignite_1_1cluster_1_1ClusterNode.html">ClusterNode</a> &gt; ignite::cluster::IgniteCluster::GetTopology </td>
<td>(</td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>version</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get a topology by version. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">version</td><td>Topology version. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Nodes collection for the requested topology version. </dd></dl>
</div>
</div>
<a id="a2ab37de08bfe9b3cf6e51d2625e3e503"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2ab37de08bfe9b3cf6e51d2625e3e503">&#9670;&nbsp;</a></span>GetTopologyVersion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int64_t ignite::cluster::IgniteCluster::GetTopologyVersion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get current topology version. </p>
<dl class="section return"><dt>Returns</dt><dd>Current topology version. </dd></dl>
</div>
</div>
<a id="a3aa85b4bc7b9e27b8e432c662b0b380a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a3aa85b4bc7b9e27b8e432c662b0b380a">&#9670;&nbsp;</a></span>IsActive()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ignite::cluster::IgniteCluster::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 id="a2c1f26d1d56ac9128da3c5917d181712"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2c1f26d1d56ac9128da3c5917d181712">&#9670;&nbsp;</a></span>IsWalEnabled()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ignite::cluster::IgniteCluster::IsWalEnabled </td>
<td>(</td>
<td class="paramtype">std::string&#160;</td>
<td class="paramname"><em>cacheName</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Check if write - ahead logging is enabled for specified cache. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">cacheName</td><td>Cache name.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True if enabled. </dd></dl>
</div>
</div>
<a id="a234aae299ac12964fa8f5d419478701b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a234aae299ac12964fa8f5d419478701b">&#9670;&nbsp;</a></span>PingNode()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool ignite::cluster::IgniteCluster::PingNode </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classignite_1_1Guid.html">Guid</a>&#160;</td>
<td class="paramname"><em>nid</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Ping node. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">nid</td><td>Cluster node ID. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True in case of success. </dd></dl>
</div>
</div>
<a id="a19bf40d6419f54113c40cf230db5555a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a19bf40d6419f54113c40cf230db5555a">&#9670;&nbsp;</a></span>SetActive()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ignite::cluster::IgniteCluster::SetActive </td>
<td>(</td>
<td class="paramtype">bool&#160;</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>
<a id="a0b6797cbceb7ea170ef25889a39ee19a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0b6797cbceb7ea170ef25889a39ee19a">&#9670;&nbsp;</a></span>SetBaselineTopologyVersion()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ignite::cluster::IgniteCluster::SetBaselineTopologyVersion </td>
<td>(</td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>topVer</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set baseline topology constructed from the cluster topology of the given version. </p>
<p>The method succeeds only if the cluster topology has not changed.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">topVer</td><td>Topology version. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="aebf7dcf1f1d51e004336c227876945d6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aebf7dcf1f1d51e004336c227876945d6">&#9670;&nbsp;</a></span>SetTxTimeoutOnPartitionMapExchange()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void ignite::cluster::IgniteCluster::SetTxTimeoutOnPartitionMapExchange </td>
<td>(</td>
<td class="paramtype">int64_t&#160;</td>
<td class="paramname"><em>timeout</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set transaction timeout on partition map exchange. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">timeout</td><td>Timeout in milliseconds. </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__cluster_8h_source.html">ignite_cluster.h</a></li>
<li>ignite_cluster.cpp</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jan 10 2022 11:02:04 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.17
</small></address>
</body>
</html>