blob: f3eefac1288081b132091c709e9b7370c24bd961 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<link rel="canonical" href="https://ignite.apache.org/releases/latest/dotnetdoc/api/Apache.Ignite.Core.Client.IClientCluster.html" />
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Interface IClientCluster
| Apache Ignite.NET </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Interface IClientCluster
| Apache Ignite.NET ">
<meta name="generator" content="docfx 2.24.0.0">
<link rel="shortcut icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/docfx.vendor.css">
<link rel="stylesheet" href="../styles/docfx.css">
<link rel="stylesheet" href="../styles/main.css">
<meta property="docfx:navrel" content="../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../">
<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 data-spy="scroll" data-target="#affix">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../images/logo_ignite_32_32.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items"></div>
<ul id="pagination"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Apache.Ignite.Core.Client.IClientCluster">
<h1 id="Apache_Ignite_Core_Client_IClientCluster" data-uid="Apache.Ignite.Core.Client.IClientCluster" class="text-break">Interface IClientCluster
</h1>
<div class="markdown level0 summary"><p>Represents whole cluster (group of all nodes in a cluster).</p>
</div>
<div class="markdown level0 conceptual"></div>
<h6><strong>Namespace</strong>: <a class="xref" href="Apache.Ignite.Core.Client.html">Apache.Ignite.Core.Client</a></h6>
<h6><strong>Assembly</strong>: Apache.Ignite.Core.dll</h6>
<h5 id="Apache_Ignite_Core_Client_IClientCluster_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IClientCluster</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<a id="Apache_Ignite_Core_Client_IClientCluster_DisableWal_" data-uid="Apache.Ignite.Core.Client.IClientCluster.DisableWal*"></a>
<h4 id="Apache_Ignite_Core_Client_IClientCluster_DisableWal_System_String_" data-uid="Apache.Ignite.Core.Client.IClientCluster.DisableWal(System.String)">DisableWal(String)</h4>
<div class="markdown level1 summary"><p>Disables write-ahead logging for specified cache. When WAL is disabled, changes are not logged to disk.
This significantly improves cache update speed.The drawback is absence of local crash-recovery guarantees.
If node is crashed, local content of WAL-disabled cache will be cleared on restart
to avoid data corruption.
<p>
Internally this method will wait for all current cache operations to finish and prevent new cache
operations from being executed.Then checkpoint is initiated to flush all data to disk.Control is returned
to the callee when all dirty pages are prepared for checkpoint, but not necessarily flushed to disk.
<p>
WAL state can be changed only for persistent caches.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool DisableWal(string cacheName)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">cacheName</span></td>
<td><p>Name of the cache.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p>Whether WAL was enabled by this call.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Client_IClientCluster_EnableWal_" data-uid="Apache.Ignite.Core.Client.IClientCluster.EnableWal*"></a>
<h4 id="Apache_Ignite_Core_Client_IClientCluster_EnableWal_System_String_" data-uid="Apache.Ignite.Core.Client.IClientCluster.EnableWal(System.String)">EnableWal(String)</h4>
<div class="markdown level1 summary"><p>Enables write-ahead logging for specified cache. Restoring crash-recovery guarantees of a previous call to
<a class="xref" href="Apache.Ignite.Core.Client.IClientCluster.html#Apache_Ignite_Core_Client_IClientCluster_DisableWal_System_String_">DisableWal(String)</a>.
<p>
Internally this method will wait for all current cache operations to finish and prevent new cache
operations from being executed. Then checkpoint is initiated to flush all data to disk.
Control is returned to the callee when all data is persisted to disk.
<p>
WAL state can be changed only for persistent caches.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool EnableWal(string cacheName)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">cacheName</span></td>
<td><p>Name of the cache.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p>Whether WAL was disabled by this call.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Client_IClientCluster_IsActive_" data-uid="Apache.Ignite.Core.Client.IClientCluster.IsActive*"></a>
<h4 id="Apache_Ignite_Core_Client_IClientCluster_IsActive" data-uid="Apache.Ignite.Core.Client.IClientCluster.IsActive">IsActive()</h4>
<div class="markdown level1 summary"><p>Determines whether this grid is in active state.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool IsActive()</code></pre>
</div>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><p><code>true</code> if the grid is active; otherwise, <code>false</code>.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Client_IClientCluster_IsWalEnabled_" data-uid="Apache.Ignite.Core.Client.IClientCluster.IsWalEnabled*"></a>
<h4 id="Apache_Ignite_Core_Client_IClientCluster_IsWalEnabled_System_String_" data-uid="Apache.Ignite.Core.Client.IClientCluster.IsWalEnabled(System.String)">IsWalEnabled(String)</h4>
<div class="markdown level1 summary"><p>Determines whether write-ahead logging is enabled for specified cache.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">bool IsWalEnabled(string cacheName)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">cacheName</span></td>
<td><p>Name of the cache.</p>
</td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Client_IClientCluster_SetActive_" data-uid="Apache.Ignite.Core.Client.IClientCluster.SetActive*"></a>
<h4 id="Apache_Ignite_Core_Client_IClientCluster_SetActive_System_Boolean_" data-uid="Apache.Ignite.Core.Client.IClientCluster.SetActive(System.Boolean)">SetActive(Boolean)</h4>
<div class="markdown level1 summary"><p>Changes Ignite grid state to active or inactive.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">void SetActive(bool isActive)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Boolean</span></td>
<td><span class="parametername">isActive</span></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
© 2015 - 2019 The Apache Software Foundation
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../styles/docfx.js"></script>
<script type="text/javascript" src="../styles/main.js"></script>
</body>
</html>