| <!DOCTYPE html>
|
| <!--[if IE]><![endif]-->
|
| <html>
|
|
|
| <head> |
| <link rel="canonical" href="https://ignite.apache.org/releases/2.5.0/dotnetdoc/api/Apache.Ignite.Core.IIgnite.html" /> |
| <META NAME="ROBOTS" CONTENT="NOINDEX"> |
|
|
| <meta charset="utf-8">
|
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
| <title>Interface IIgnite
|
| | Apache Ignite.NET </title>
|
| <meta name="viewport" content="width=device-width">
|
| <meta name="title" content="Interface IIgnite
|
| | 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.IIgnite">
|
|
|
|
|
| <h1 id="Apache_Ignite_Core_IIgnite" data-uid="Apache.Ignite.Core.IIgnite" class="text-break">Interface IIgnite
|
| </h1>
|
| <div class="markdown level0 summary"><p>Main entry point for all Ignite APIs. |
| You can obtain an instance of <a class="xref" href="Apache.Ignite.Core.IIgnite.html">IIgnite</a> through <a class="xref" href="Apache.Ignite.Core.Ignition.html#Apache_Ignite_Core_Ignition_GetIgnite">GetIgnite()</a>, |
| or for named grids you can use <a class="xref" href="Apache.Ignite.Core.Ignition.html#Apache_Ignite_Core_Ignition_GetIgnite_System_String_">GetIgnite(String)</a>. Note that you |
| can have multiple instances of <a class="xref" href="Apache.Ignite.Core.IIgnite.html">IIgnite</a> running in the same process by giving |
| each instance a different name. |
| <p> |
| All members are thread-safe and may be used concurrently from multiple threads.</p> |
| </div>
|
| <div class="markdown level0 conceptual"></div>
|
| <div class="inheritedMembers">
|
| <h5>Inherited Members</h5>
|
| <div>
|
| <span class="xref">System.IDisposable.Dispose()</span>
|
| </div>
|
| </div>
|
| <h6><strong>Namespace</strong>: <a class="xref" href="Apache.Ignite.Core.html">Apache.Ignite.Core</a></h6>
|
| <h6><strong>Assembly</strong>: Apache.Ignite.Core.dll</h6>
|
| <h5 id="Apache_Ignite_Core_IIgnite_syntax">Syntax</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public interface IIgnite : IDisposable</code></pre>
|
| </div>
|
| <h3 id="properties">Properties
|
| </h3>
|
| <a id="Apache_Ignite_Core_IIgnite_Logger_" data-uid="Apache.Ignite.Core.IIgnite.Logger*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_Logger" data-uid="Apache.Ignite.Core.IIgnite.Logger">Logger</h4>
|
| <div class="markdown level1 summary"><p>Gets the logger. |
| <p> |
| See <a class="xref" href="Apache.Ignite.Core.IgniteConfiguration.html#Apache_Ignite_Core_IgniteConfiguration_Logger">Logger</a> for customization.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">ILogger Logger { get; }</code></pre>
|
| </div>
|
| <h5 class="propertyValue">Property Value</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Type</th>
|
| <th>Description</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><a class="xref" href="Apache.Ignite.Core.Log.ILogger.html">ILogger</a></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_Name_" data-uid="Apache.Ignite.Core.IIgnite.Name*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_Name" data-uid="Apache.Ignite.Core.IIgnite.Name">Name</h4>
|
| <div class="markdown level1 summary"><p>Gets the name of the grid this Ignite instance (and correspondingly its local node) belongs to. |
| Note that single process can have multiple Ignite instances all belonging to different grids. Grid |
| name allows to indicate to what grid this particular Ignite instance (i.e. Ignite runtime and its |
| local node) belongs to. |
| <p> |
| If default Ignite instance is used, then <code>null</code> is returned. Refer to <a class="xref" href="Apache.Ignite.Core.Ignition.html">Ignition</a> documentation |
| for information on how to start named grids.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">string Name { get; }</code></pre>
|
| </div>
|
| <h5 class="propertyValue">Property Value</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.String</span></td>
|
| <td><p>Name of the grid, or <code>null</code> for default grid.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h3 id="methods">Methods
|
| </h3>
|
| <a id="Apache_Ignite_Core_IIgnite_AddCacheConfiguration_" data-uid="Apache.Ignite.Core.IIgnite.AddCacheConfiguration*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_AddCacheConfiguration_Apache_Ignite_Core_Cache_Configuration_CacheConfiguration_" data-uid="Apache.Ignite.Core.IIgnite.AddCacheConfiguration(Apache.Ignite.Core.Cache.Configuration.CacheConfiguration)">AddCacheConfiguration(CacheConfiguration)</h4>
|
| <div class="markdown level1 summary"><p>Adds cache configuration template. Name should contain *. |
| Template settins are applied to a cache created with <a class="xref" href="Apache.Ignite.Core.IIgnite.html#Apache_Ignite_Core_IIgnite_CreateCache__2_System_String_">CreateCache<TK, TV>(String)</a> if specified |
| name matches the template name.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">void AddCacheConfiguration(CacheConfiguration configuration)</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><a class="xref" href="Apache.Ignite.Core.Cache.Configuration.CacheConfiguration.html">CacheConfiguration</a></td>
|
| <td><span class="parametername">configuration</span></td>
|
| <td><p>Configuration.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_CreateCache_" data-uid="Apache.Ignite.Core.IIgnite.CreateCache*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_CreateCache__2_Apache_Ignite_Core_Cache_Configuration_CacheConfiguration_" data-uid="Apache.Ignite.Core.IIgnite.CreateCache``2(Apache.Ignite.Core.Cache.Configuration.CacheConfiguration)">CreateCache<TK, TV>(CacheConfiguration)</h4>
|
| <div class="markdown level1 summary"><p>Dynamically starts new cache using provided configuration.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">ICache<TK, TV> CreateCache<TK, TV>(CacheConfiguration configuration)</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><a class="xref" href="Apache.Ignite.Core.Cache.Configuration.CacheConfiguration.html">CacheConfiguration</a></td>
|
| <td><span class="parametername">configuration</span></td>
|
| <td><p>Cache configuration.</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><a class="xref" href="Apache.Ignite.Core.Cache.ICache-2.html">ICache</a><TK, TV></td>
|
| <td><p>Existing or newly created cache.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h5 class="typeParameters">Type Parameters</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Name</th>
|
| <th>Description</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><span class="parametername">TK</span></td>
|
| <td><p>Cache key type.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><span class="parametername">TV</span></td>
|
| <td><p>Cache value type.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_CreateCache_" data-uid="Apache.Ignite.Core.IIgnite.CreateCache*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_CreateCache__2_Apache_Ignite_Core_Cache_Configuration_CacheConfiguration_Apache_Ignite_Core_Cache_Configuration_NearCacheConfiguration_" data-uid="Apache.Ignite.Core.IIgnite.CreateCache``2(Apache.Ignite.Core.Cache.Configuration.CacheConfiguration,Apache.Ignite.Core.Cache.Configuration.NearCacheConfiguration)">CreateCache<TK, TV>(CacheConfiguration, NearCacheConfiguration)</h4>
|
| <div class="markdown level1 summary"><p>Dynamically starts new cache using provided configuration.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">ICache<TK, TV> CreateCache<TK, TV>(CacheConfiguration configuration, NearCacheConfiguration nearConfiguration)</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><a class="xref" href="Apache.Ignite.Core.Cache.Configuration.CacheConfiguration.html">CacheConfiguration</a></td>
|
| <td><span class="parametername">configuration</span></td>
|
| <td><p>Cache configuration.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><a class="xref" href="Apache.Ignite.Core.Cache.Configuration.NearCacheConfiguration.html">NearCacheConfiguration</a></td>
|
| <td><span class="parametername">nearConfiguration</span></td>
|
| <td><p>Near cache configuration for client.</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><a class="xref" href="Apache.Ignite.Core.Cache.ICache-2.html">ICache</a><TK, TV></td>
|
| <td><p>Existing or newly created cache.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h5 class="typeParameters">Type Parameters</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Name</th>
|
| <th>Description</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><span class="parametername">TK</span></td>
|
| <td><p>Cache key type.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><span class="parametername">TV</span></td>
|
| <td><p>Cache value type.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_CreateCache_" data-uid="Apache.Ignite.Core.IIgnite.CreateCache*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_CreateCache__2_System_String_" data-uid="Apache.Ignite.Core.IIgnite.CreateCache``2(System.String)">CreateCache<TK, TV>(String)</h4>
|
| <div class="markdown level1 summary"><p>Dynamically starts new cache using template configuration.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">ICache<TK, TV> CreateCache<TK, TV>(string name)</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">name</span></td>
|
| <td><p>Cache name.</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><a class="xref" href="Apache.Ignite.Core.Cache.ICache-2.html">ICache</a><TK, TV></td>
|
| <td><p>Existing or newly created cache.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h5 class="typeParameters">Type Parameters</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Name</th>
|
| <th>Description</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><span class="parametername">TK</span></td>
|
| <td><p>Cache key type.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><span class="parametername">TV</span></td>
|
| <td><p>Cache value type.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_CreateNearCache_" data-uid="Apache.Ignite.Core.IIgnite.CreateNearCache*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_CreateNearCache__2_System_String_Apache_Ignite_Core_Cache_Configuration_NearCacheConfiguration_" data-uid="Apache.Ignite.Core.IIgnite.CreateNearCache``2(System.String,Apache.Ignite.Core.Cache.Configuration.NearCacheConfiguration)">CreateNearCache<TK, TV>(String, NearCacheConfiguration)</h4>
|
| <div class="markdown level1 summary"><p>Starts a near cache on local client node if cache with specified was previously started. |
| This method does not work on server nodes.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">ICache<TK, TV> CreateNearCache<TK, TV>(string name, NearCacheConfiguration configuration)</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">name</span></td>
|
| <td><p>The name.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><a class="xref" href="Apache.Ignite.Core.Cache.Configuration.NearCacheConfiguration.html">NearCacheConfiguration</a></td>
|
| <td><span class="parametername">configuration</span></td>
|
| <td><p>The configuration.</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><a class="xref" href="Apache.Ignite.Core.Cache.ICache-2.html">ICache</a><TK, TV></td>
|
| <td><p>Near cache instance.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h5 class="typeParameters">Type Parameters</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Name</th>
|
| <th>Description</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><span class="parametername">TK</span></td>
|
| <td><p>Cache key type.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><span class="parametername">TV</span></td>
|
| <td><p>Cache value type.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_DestroyCache_" data-uid="Apache.Ignite.Core.IIgnite.DestroyCache*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_DestroyCache_System_String_" data-uid="Apache.Ignite.Core.IIgnite.DestroyCache(System.String)">DestroyCache(String)</h4>
|
| <div class="markdown level1 summary"><p>Destroys dynamically created (with <a class="xref" href="Apache.Ignite.Core.IIgnite.html#Apache_Ignite_Core_IIgnite_CreateCache__2_System_String_">CreateCache<TK, TV>(String)</a> or |
| <a class="xref" href="Apache.Ignite.Core.IIgnite.html#Apache_Ignite_Core_IIgnite_GetOrCreateCache__2_System_String_">GetOrCreateCache<TK, TV>(String)</a>) cache.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">void DestroyCache(string name)</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">name</span></td>
|
| <td><p>The name of the cache to stop.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetAffinity_" data-uid="Apache.Ignite.Core.IIgnite.GetAffinity*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetAffinity_System_String_" data-uid="Apache.Ignite.Core.IIgnite.GetAffinity(System.String)">GetAffinity(String)</h4>
|
| <div class="markdown level1 summary"><p>Gets affinity service to provide information about data partitioning and distribution.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">ICacheAffinity GetAffinity(string name)</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">name</span></td>
|
| <td><p>Cache name.</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><a class="xref" href="Apache.Ignite.Core.Cache.ICacheAffinity.html">ICacheAffinity</a></td>
|
| <td><p>Cache data affinity service.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetAtomicLong_" data-uid="Apache.Ignite.Core.IIgnite.GetAtomicLong*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetAtomicLong_System_String_System_Int64_System_Boolean_" data-uid="Apache.Ignite.Core.IIgnite.GetAtomicLong(System.String,System.Int64,System.Boolean)">GetAtomicLong(String, Int64, Boolean)</h4>
|
| <div class="markdown level1 summary"><p>Gets an atomic long with specified name from cache. |
| Creates new atomic long in cache if it does not exist and <code>create</code> is true.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">IAtomicLong GetAtomicLong(string name, long initialValue, bool create)</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">name</span></td>
|
| <td><p>Name of the atomic long.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><span class="xref">System.Int64</span></td>
|
| <td><span class="parametername">initialValue</span></td>
|
| <td><p>Initial value for the atomic long. Ignored if <code>create</code> is false.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><span class="xref">System.Boolean</span></td>
|
| <td><span class="parametername">create</span></td>
|
| <td><p>Flag indicating whether atomic long should be created if it does not exist.</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><a class="xref" href="Apache.Ignite.Core.DataStructures.IAtomicLong.html">IAtomicLong</a></td>
|
| <td><p>Atomic long instance with specified name, |
| or null if it does not exist and <code>create</code> flag is not set.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h5 class="exceptions">Exceptions</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Type</th>
|
| <th>Condition</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><a class="xref" href="Apache.Ignite.Core.Common.IgniteException.html">IgniteException</a></td>
|
| <td><p>If atomic long could not be fetched or created.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetAtomicReference_" data-uid="Apache.Ignite.Core.IIgnite.GetAtomicReference*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetAtomicReference__1_System_String___0_System_Boolean_" data-uid="Apache.Ignite.Core.IIgnite.GetAtomicReference``1(System.String,``0,System.Boolean)">GetAtomicReference<T>(String, T, Boolean)</h4>
|
| <div class="markdown level1 summary"><p>Gets an atomic reference with specified name from cache. |
| Creates new atomic reference in cache if it does not exist and <code data-dev-comment-type="paramref" class="paramref">create</code> is true.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">IAtomicReference<T> GetAtomicReference<T>(string name, T initialValue, bool create)</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">name</span></td>
|
| <td><p>Name of the atomic reference.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><span class="xref">T</span></td>
|
| <td><span class="parametername">initialValue</span></td>
|
| <td><p>Initial value for the atomic reference. Ignored if <code data-dev-comment-type="paramref" class="paramref">create</code> is false.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><span class="xref">System.Boolean</span></td>
|
| <td><span class="parametername">create</span></td>
|
| <td><p>Flag indicating whether atomic reference should be created if it does not exist.</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><a class="xref" href="Apache.Ignite.Core.DataStructures.IAtomicReference-1.html">IAtomicReference</a><T></td>
|
| <td><p>Atomic reference instance with specified name, |
| or null if it does not exist and <code data-dev-comment-type="paramref" class="paramref">create</code> flag is not set.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h5 class="typeParameters">Type Parameters</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Name</th>
|
| <th>Description</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><span class="parametername">T</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h5 class="exceptions">Exceptions</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Type</th>
|
| <th>Condition</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><a class="xref" href="Apache.Ignite.Core.Common.IgniteException.html">IgniteException</a></td>
|
| <td><p>If atomic reference could not be fetched or created.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetAtomicSequence_" data-uid="Apache.Ignite.Core.IIgnite.GetAtomicSequence*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetAtomicSequence_System_String_System_Int64_System_Boolean_" data-uid="Apache.Ignite.Core.IIgnite.GetAtomicSequence(System.String,System.Int64,System.Boolean)">GetAtomicSequence(String, Int64, Boolean)</h4>
|
| <div class="markdown level1 summary"><p>Gets an atomic sequence with specified name from cache. |
| Creates new atomic sequence in cache if it does not exist and <code data-dev-comment-type="paramref" class="paramref">create</code> is true.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">IAtomicSequence GetAtomicSequence(string name, long initialValue, bool create)</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">name</span></td>
|
| <td><p>Name of the atomic sequence.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><span class="xref">System.Int64</span></td>
|
| <td><span class="parametername">initialValue</span></td>
|
| <td><p>Initial value for the atomic sequence. Ignored if <code data-dev-comment-type="paramref" class="paramref">create</code> is false.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><span class="xref">System.Boolean</span></td>
|
| <td><span class="parametername">create</span></td>
|
| <td><p>Flag indicating whether atomic sequence should be created if it does not exist.</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><a class="xref" href="Apache.Ignite.Core.DataStructures.IAtomicSequence.html">IAtomicSequence</a></td>
|
| <td><p>Atomic sequence instance with specified name, |
| or null if it does not exist and <code data-dev-comment-type="paramref" class="paramref">create</code> flag is not set.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h5 class="exceptions">Exceptions</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Type</th>
|
| <th>Condition</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><a class="xref" href="Apache.Ignite.Core.Common.IgniteException.html">IgniteException</a></td>
|
| <td><p>If atomic sequence could not be fetched or created.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetBinary_" data-uid="Apache.Ignite.Core.IIgnite.GetBinary*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetBinary" data-uid="Apache.Ignite.Core.IIgnite.GetBinary">GetBinary()</h4>
|
| <div class="markdown level1 summary"><p>Gets an instance of <a class="xref" href="Apache.Ignite.Core.Binary.IBinary.html">IBinary</a> interface.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">IBinary GetBinary()</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><a class="xref" href="Apache.Ignite.Core.Binary.IBinary.html">IBinary</a></td>
|
| <td><p>Instance of <a class="xref" href="Apache.Ignite.Core.Binary.IBinary.html">IBinary</a> interface</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetCache_" data-uid="Apache.Ignite.Core.IIgnite.GetCache*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetCache__2_System_String_" data-uid="Apache.Ignite.Core.IIgnite.GetCache``2(System.String)">GetCache<TK, TV>(String)</h4>
|
| <div class="markdown level1 summary"><p>Gets the cache instance for the given name to work with keys and values of specified types. |
| <p> |
| You can get instances of ICache of the same name, but with different key/value types. |
| These will use the same named cache, but only allow working with entries of specified types. |
| Attempt to retrieve an entry of incompatible type will result in <span class="xref">System.InvalidCastException</span>. |
| Use <a class="xref" href="Apache.Ignite.Core.IIgnite.html#Apache_Ignite_Core_IIgnite_GetCache__2_System_String_">GetCache<TK, TV>(String)</a> in order to work with entries of arbitrary types.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">ICache<TK, TV> GetCache<TK, TV>(string name)</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">name</span></td>
|
| <td><p>Cache name.</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><a class="xref" href="Apache.Ignite.Core.Cache.ICache-2.html">ICache</a><TK, TV></td>
|
| <td><p>Cache instance for given name.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h5 class="typeParameters">Type Parameters</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Name</th>
|
| <th>Description</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><span class="parametername">TK</span></td>
|
| <td><p>Cache key type.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><span class="parametername">TV</span></td>
|
| <td><p>Cache value type.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetCacheNames_" data-uid="Apache.Ignite.Core.IIgnite.GetCacheNames*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetCacheNames" data-uid="Apache.Ignite.Core.IIgnite.GetCacheNames">GetCacheNames()</h4>
|
| <div class="markdown level1 summary"><p>Gets the collection of names of currently available caches, or empty collection if there are no caches.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">ICollection<string> GetCacheNames()</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.Collections.Generic.ICollection</span><<span class="xref">System.String</span>></td>
|
| <td><p>Collection of names of currently available caches.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetCluster_" data-uid="Apache.Ignite.Core.IIgnite.GetCluster*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetCluster" data-uid="Apache.Ignite.Core.IIgnite.GetCluster">GetCluster()</h4>
|
| <div class="markdown level1 summary"><p>Gets an instance of <a class="xref" href="Apache.Ignite.Core.Cluster.ICluster.html">ICluster</a> interface.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">ICluster GetCluster()</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><a class="xref" href="Apache.Ignite.Core.Cluster.ICluster.html">ICluster</a></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetCompute_" data-uid="Apache.Ignite.Core.IIgnite.GetCompute*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetCompute" data-uid="Apache.Ignite.Core.IIgnite.GetCompute">GetCompute()</h4>
|
| <div class="markdown level1 summary"><p>Gets compute functionality over this grid projection. All operations |
| on the returned ICompute instance will only include nodes from |
| this projection.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">ICompute GetCompute()</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><a class="xref" href="Apache.Ignite.Core.Compute.ICompute.html">ICompute</a></td>
|
| <td><p>Compute instance over this grid projection.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetConfiguration_" data-uid="Apache.Ignite.Core.IIgnite.GetConfiguration*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetConfiguration" data-uid="Apache.Ignite.Core.IIgnite.GetConfiguration">GetConfiguration()</h4>
|
| <div class="markdown level1 summary"><p>Gets the configuration of this Ignite instance.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">IgniteConfiguration GetConfiguration()</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><a class="xref" href="Apache.Ignite.Core.IgniteConfiguration.html">IgniteConfiguration</a></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetDataRegionMetrics_" data-uid="Apache.Ignite.Core.IIgnite.GetDataRegionMetrics*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetDataRegionMetrics" data-uid="Apache.Ignite.Core.IIgnite.GetDataRegionMetrics">GetDataRegionMetrics()</h4>
|
| <div class="markdown level1 summary"><p>Gets a collection of memory metrics, one for each |
| <a class="xref" href="Apache.Ignite.Core.Configuration.DataStorageConfiguration.html#Apache_Ignite_Core_Configuration_DataStorageConfiguration_DataRegionConfigurations">DataRegionConfigurations</a>. |
| <p> |
| Metrics should be enabled with <a class="xref" href="Apache.Ignite.Core.Configuration.DataStorageConfiguration.html#Apache_Ignite_Core_Configuration_DataStorageConfiguration_MetricsEnabled">MetricsEnabled</a>.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">ICollection<IDataRegionMetrics> GetDataRegionMetrics()</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.Collections.Generic.ICollection</span><<a class="xref" href="Apache.Ignite.Core.IDataRegionMetrics.html">IDataRegionMetrics</a>></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetDataRegionMetrics_" data-uid="Apache.Ignite.Core.IIgnite.GetDataRegionMetrics*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetDataRegionMetrics_System_String_" data-uid="Apache.Ignite.Core.IIgnite.GetDataRegionMetrics(System.String)">GetDataRegionMetrics(String)</h4>
|
| <div class="markdown level1 summary"><p>Gets the memory metrics for the specified data region. |
| <p> |
| To get metrics for the default memory region, |
| use <a class="xref" href="Apache.Ignite.Core.Configuration.DataStorageConfiguration.html#Apache_Ignite_Core_Configuration_DataStorageConfiguration_DefaultDataRegionName">DefaultDataRegionName</a>.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">IDataRegionMetrics GetDataRegionMetrics(string dataRegionName)</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">dataRegionName</span></td>
|
| <td><p>Name of the data region.</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><a class="xref" href="Apache.Ignite.Core.IDataRegionMetrics.html">IDataRegionMetrics</a></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetDataStorageMetrics_" data-uid="Apache.Ignite.Core.IIgnite.GetDataStorageMetrics*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetDataStorageMetrics" data-uid="Apache.Ignite.Core.IIgnite.GetDataStorageMetrics">GetDataStorageMetrics()</h4>
|
| <div class="markdown level1 summary"><p>Gets the persistent store metrics. |
| <p> |
| To enable metrics set <a class="xref" href="Apache.Ignite.Core.Configuration.DataStorageConfiguration.html#Apache_Ignite_Core_Configuration_DataStorageConfiguration_MetricsEnabled">MetricsEnabled</a> property |
| in <a class="xref" href="Apache.Ignite.Core.IgniteConfiguration.html#Apache_Ignite_Core_IgniteConfiguration_DataStorageConfiguration">DataStorageConfiguration</a>.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">IDataStorageMetrics GetDataStorageMetrics()</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><a class="xref" href="Apache.Ignite.Core.IDataStorageMetrics.html">IDataStorageMetrics</a></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetDataStreamer_" data-uid="Apache.Ignite.Core.IIgnite.GetDataStreamer*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetDataStreamer__2_System_String_" data-uid="Apache.Ignite.Core.IIgnite.GetDataStreamer``2(System.String)">GetDataStreamer<TK, TV>(String)</h4>
|
| <div class="markdown level1 summary"><p>Gets a new instance of data streamer associated with given cache name. Data streamer |
| is responsible for loading external data into Ignite. For more information |
| refer to <a class="xref" href="Apache.Ignite.Core.Datastream.IDataStreamer-2.html">IDataStreamer<TK, TV></a> documentation.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">IDataStreamer<TK, TV> GetDataStreamer<TK, TV>(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>Cache name (<code>null</code> for default 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><a class="xref" href="Apache.Ignite.Core.Datastream.IDataStreamer-2.html">IDataStreamer</a><TK, TV></td>
|
| <td><p>Data streamer.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h5 class="typeParameters">Type Parameters</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Name</th>
|
| <th>Description</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><span class="parametername">TK</span></td>
|
| <td></td>
|
| </tr>
|
| <tr>
|
| <td><span class="parametername">TV</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetEvents_" data-uid="Apache.Ignite.Core.IIgnite.GetEvents*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetEvents" data-uid="Apache.Ignite.Core.IIgnite.GetEvents">GetEvents()</h4>
|
| <div class="markdown level1 summary"><p>Gets events facade over all cluster nodes.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">IEvents GetEvents()</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><a class="xref" href="Apache.Ignite.Core.Events.IEvents.html">IEvents</a></td>
|
| <td><p>Events facade over all cluster nodes.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetMemoryMetrics_" data-uid="Apache.Ignite.Core.IIgnite.GetMemoryMetrics*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetMemoryMetrics" data-uid="Apache.Ignite.Core.IIgnite.GetMemoryMetrics">GetMemoryMetrics()</h4>
|
| <div class="markdown level1 summary"><p>Gets a collection of memory metrics, one for each <a class="xref" href="Apache.Ignite.Core.Cache.Configuration.MemoryConfiguration.html#Apache_Ignite_Core_Cache_Configuration_MemoryConfiguration_MemoryPolicies">MemoryPolicies</a>. |
| <p> |
| Memory metrics should be enabled with <a class="xref" href="Apache.Ignite.Core.Cache.Configuration.MemoryPolicyConfiguration.html#Apache_Ignite_Core_Cache_Configuration_MemoryPolicyConfiguration_MetricsEnabled">MetricsEnabled</a>. |
| <p> |
| Obsolete, use <a class="xref" href="Apache.Ignite.Core.IIgnite.html#Apache_Ignite_Core_IIgnite_GetDataRegionMetrics">GetDataRegionMetrics()</a>.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">[Obsolete("Use GetDataRegionMetrics.")] |
| ICollection<IMemoryMetrics> GetMemoryMetrics()</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.Collections.Generic.ICollection</span><<a class="xref" href="Apache.Ignite.Core.Cache.IMemoryMetrics.html">IMemoryMetrics</a>></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetMemoryMetrics_" data-uid="Apache.Ignite.Core.IIgnite.GetMemoryMetrics*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetMemoryMetrics_System_String_" data-uid="Apache.Ignite.Core.IIgnite.GetMemoryMetrics(System.String)">GetMemoryMetrics(String)</h4>
|
| <div class="markdown level1 summary"><p>Gets the memory metrics for the specified memory policy. |
| <p> |
| To get metrics for the default memory region, |
| use <a class="xref" href="Apache.Ignite.Core.Cache.Configuration.MemoryConfiguration.html#Apache_Ignite_Core_Cache_Configuration_MemoryConfiguration_DefaultMemoryPolicyName">DefaultMemoryPolicyName</a>. |
| <p> |
| Obsolete, use <a class="xref" href="Apache.Ignite.Core.IIgnite.html#Apache_Ignite_Core_IIgnite_GetDataRegionMetrics_System_String_">GetDataRegionMetrics(String)</a>.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">[Obsolete("Use GetDataRegionMetrics.")] |
| IMemoryMetrics GetMemoryMetrics(string memoryPolicyName)</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">memoryPolicyName</span></td>
|
| <td><p>Name of the memory policy.</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><a class="xref" href="Apache.Ignite.Core.Cache.IMemoryMetrics.html">IMemoryMetrics</a></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetMessaging_" data-uid="Apache.Ignite.Core.IIgnite.GetMessaging*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetMessaging" data-uid="Apache.Ignite.Core.IIgnite.GetMessaging">GetMessaging()</h4>
|
| <div class="markdown level1 summary"><p>Gets messaging facade over all cluster nodes.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">IMessaging GetMessaging()</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><a class="xref" href="Apache.Ignite.Core.Messaging.IMessaging.html">IMessaging</a></td>
|
| <td><p>Messaging instance over all cluster nodes.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetOrCreateCache_" data-uid="Apache.Ignite.Core.IIgnite.GetOrCreateCache*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetOrCreateCache__2_Apache_Ignite_Core_Cache_Configuration_CacheConfiguration_" data-uid="Apache.Ignite.Core.IIgnite.GetOrCreateCache``2(Apache.Ignite.Core.Cache.Configuration.CacheConfiguration)">GetOrCreateCache<TK, TV>(CacheConfiguration)</h4>
|
| <div class="markdown level1 summary"><p>Gets existing cache with the given name or creates new one using provided configuration.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">ICache<TK, TV> GetOrCreateCache<TK, TV>(CacheConfiguration configuration)</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><a class="xref" href="Apache.Ignite.Core.Cache.Configuration.CacheConfiguration.html">CacheConfiguration</a></td>
|
| <td><span class="parametername">configuration</span></td>
|
| <td><p>Cache configuration.</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><a class="xref" href="Apache.Ignite.Core.Cache.ICache-2.html">ICache</a><TK, TV></td>
|
| <td><p>Existing or newly created cache.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h5 class="typeParameters">Type Parameters</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Name</th>
|
| <th>Description</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><span class="parametername">TK</span></td>
|
| <td><p>Cache key type.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><span class="parametername">TV</span></td>
|
| <td><p>Cache value type.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetOrCreateCache_" data-uid="Apache.Ignite.Core.IIgnite.GetOrCreateCache*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetOrCreateCache__2_Apache_Ignite_Core_Cache_Configuration_CacheConfiguration_Apache_Ignite_Core_Cache_Configuration_NearCacheConfiguration_" data-uid="Apache.Ignite.Core.IIgnite.GetOrCreateCache``2(Apache.Ignite.Core.Cache.Configuration.CacheConfiguration,Apache.Ignite.Core.Cache.Configuration.NearCacheConfiguration)">GetOrCreateCache<TK, TV>(CacheConfiguration, NearCacheConfiguration)</h4>
|
| <div class="markdown level1 summary"><p>Gets existing cache with the given name or creates new one using provided configuration.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">ICache<TK, TV> GetOrCreateCache<TK, TV>(CacheConfiguration configuration, NearCacheConfiguration nearConfiguration)</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><a class="xref" href="Apache.Ignite.Core.Cache.Configuration.CacheConfiguration.html">CacheConfiguration</a></td>
|
| <td><span class="parametername">configuration</span></td>
|
| <td><p>Cache configuration.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><a class="xref" href="Apache.Ignite.Core.Cache.Configuration.NearCacheConfiguration.html">NearCacheConfiguration</a></td>
|
| <td><span class="parametername">nearConfiguration</span></td>
|
| <td><p>Near cache configuration for client.</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><a class="xref" href="Apache.Ignite.Core.Cache.ICache-2.html">ICache</a><TK, TV></td>
|
| <td><p>Existing or newly created cache.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h5 class="typeParameters">Type Parameters</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Name</th>
|
| <th>Description</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><span class="parametername">TK</span></td>
|
| <td><p>Cache key type.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><span class="parametername">TV</span></td>
|
| <td><p>Cache value type.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetOrCreateCache_" data-uid="Apache.Ignite.Core.IIgnite.GetOrCreateCache*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetOrCreateCache__2_System_String_" data-uid="Apache.Ignite.Core.IIgnite.GetOrCreateCache``2(System.String)">GetOrCreateCache<TK, TV>(String)</h4>
|
| <div class="markdown level1 summary"><p>Gets existing cache with the given name or creates new one using template configuration.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">ICache<TK, TV> GetOrCreateCache<TK, TV>(string name)</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">name</span></td>
|
| <td><p>Cache name.</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><a class="xref" href="Apache.Ignite.Core.Cache.ICache-2.html">ICache</a><TK, TV></td>
|
| <td><p>Existing or newly created cache.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h5 class="typeParameters">Type Parameters</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Name</th>
|
| <th>Description</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><span class="parametername">TK</span></td>
|
| <td><p>Cache key type.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><span class="parametername">TV</span></td>
|
| <td><p>Cache value type.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetOrCreateNearCache_" data-uid="Apache.Ignite.Core.IIgnite.GetOrCreateNearCache*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetOrCreateNearCache__2_System_String_Apache_Ignite_Core_Cache_Configuration_NearCacheConfiguration_" data-uid="Apache.Ignite.Core.IIgnite.GetOrCreateNearCache``2(System.String,Apache.Ignite.Core.Cache.Configuration.NearCacheConfiguration)">GetOrCreateNearCache<TK, TV>(String, NearCacheConfiguration)</h4>
|
| <div class="markdown level1 summary"><p>Gets existing near cache with the given name or creates a new one.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">ICache<TK, TV> GetOrCreateNearCache<TK, TV>(string name, NearCacheConfiguration configuration)</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">name</span></td>
|
| <td><p>The name.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><a class="xref" href="Apache.Ignite.Core.Cache.Configuration.NearCacheConfiguration.html">NearCacheConfiguration</a></td>
|
| <td><span class="parametername">configuration</span></td>
|
| <td><p>The configuration.</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><a class="xref" href="Apache.Ignite.Core.Cache.ICache-2.html">ICache</a><TK, TV></td>
|
| <td><p>Near cache instance.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h5 class="typeParameters">Type Parameters</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Name</th>
|
| <th>Description</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><span class="parametername">TK</span></td>
|
| <td><p>Cache key type.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><span class="parametername">TV</span></td>
|
| <td><p>Cache value type.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetPersistentStoreMetrics_" data-uid="Apache.Ignite.Core.IIgnite.GetPersistentStoreMetrics*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetPersistentStoreMetrics" data-uid="Apache.Ignite.Core.IIgnite.GetPersistentStoreMetrics">GetPersistentStoreMetrics()</h4>
|
| <div class="markdown level1 summary"><p>Gets the persistent store metrics. |
| <p> |
| To enable metrics set <a class="xref" href="Apache.Ignite.Core.PersistentStore.PersistentStoreConfiguration.html#Apache_Ignite_Core_PersistentStore_PersistentStoreConfiguration_MetricsEnabled">MetricsEnabled</a> property |
| in <a class="xref" href="Apache.Ignite.Core.IgniteConfiguration.html#Apache_Ignite_Core_IgniteConfiguration_PersistentStoreConfiguration">PersistentStoreConfiguration</a>.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">[Obsolete("Use GetDataStorageMetrics.")] |
| IPersistentStoreMetrics GetPersistentStoreMetrics()</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><a class="xref" href="Apache.Ignite.Core.PersistentStore.IPersistentStoreMetrics.html">IPersistentStoreMetrics</a></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetPlugin_" data-uid="Apache.Ignite.Core.IIgnite.GetPlugin*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetPlugin__1_System_String_" data-uid="Apache.Ignite.Core.IIgnite.GetPlugin``1(System.String)">GetPlugin<T>(String)</h4>
|
| <div class="markdown level1 summary"><p>Gets the plugin by name.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">T GetPlugin<T>(string name)where T : class</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">name</span></td>
|
| <td><p>Plugin name.</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">T</span></td>
|
| <td><p>Plugin instance.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h5 class="typeParameters">Type Parameters</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Name</th>
|
| <th>Description</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><span class="parametername">T</span></td>
|
| <td><p>Plugin type</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h5 class="exceptions">Exceptions</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Type</th>
|
| <th>Condition</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><a class="xref" href="Apache.Ignite.Core.Plugin.PluginNotFoundException.html">PluginNotFoundException</a></td>
|
| <td><p>When plugin with specified name has not been found.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetServices_" data-uid="Apache.Ignite.Core.IIgnite.GetServices*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetServices" data-uid="Apache.Ignite.Core.IIgnite.GetServices">GetServices()</h4>
|
| <div class="markdown level1 summary"><p>Gets services facade over all cluster nodes.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">IServices GetServices()</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><a class="xref" href="Apache.Ignite.Core.Services.IServices.html">IServices</a></td>
|
| <td><p>Services facade over all cluster nodes.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_GetTransactions_" data-uid="Apache.Ignite.Core.IIgnite.GetTransactions*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_GetTransactions" data-uid="Apache.Ignite.Core.IIgnite.GetTransactions">GetTransactions()</h4>
|
| <div class="markdown level1 summary"><p>Gets Ignite transactions facade.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">ITransactions GetTransactions()</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><a class="xref" href="Apache.Ignite.Core.Transactions.ITransactions.html">ITransactions</a></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_IsActive_" data-uid="Apache.Ignite.Core.IIgnite.IsActive*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_IsActive" data-uid="Apache.Ignite.Core.IIgnite.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">[Obsolete("Use GetCluster().IsActive instead.")] |
| 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_IIgnite_ResetLostPartitions_" data-uid="Apache.Ignite.Core.IIgnite.ResetLostPartitions*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_ResetLostPartitions_System_Collections_Generic_IEnumerable_System_String__" data-uid="Apache.Ignite.Core.IIgnite.ResetLostPartitions(System.Collections.Generic.IEnumerable{System.String})">ResetLostPartitions(IEnumerable<String>)</h4>
|
| <div class="markdown level1 summary"><p>Clears partitions' lost state and moves caches to a normal mode.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">void ResetLostPartitions(IEnumerable<string> cacheNames)</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.Collections.Generic.IEnumerable</span><<span class="xref">System.String</span>></td>
|
| <td><span class="parametername">cacheNames</span></td>
|
| <td><p>Names of caches to reset partitions for.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_ResetLostPartitions_" data-uid="Apache.Ignite.Core.IIgnite.ResetLostPartitions*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_ResetLostPartitions_System_String___" data-uid="Apache.Ignite.Core.IIgnite.ResetLostPartitions(System.String[])">ResetLostPartitions(String[])</h4>
|
| <div class="markdown level1 summary"><p>Clears partitions' lost state and moves caches to a normal mode.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">void ResetLostPartitions(params string[] cacheNames)</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">cacheNames</span></td>
|
| <td><p>Names of caches to reset partitions for.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgnite_SetActive_" data-uid="Apache.Ignite.Core.IIgnite.SetActive*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgnite_SetActive_System_Boolean_" data-uid="Apache.Ignite.Core.IIgnite.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">[Obsolete("Use GetCluster().SetActive instead.")] |
| 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>
|
| <h3 id="events">Events
|
| </h3>
|
| <h4 id="Apache_Ignite_Core_IIgnite_ClientDisconnected" data-uid="Apache.Ignite.Core.IIgnite.ClientDisconnected">ClientDisconnected</h4>
|
| <div class="markdown level1 summary"><p>Occurs when client node disconnects from the cluster. This event can only occur when this instance |
| runs in client mode (<a class="xref" href="Apache.Ignite.Core.IgniteConfiguration.html#Apache_Ignite_Core_IgniteConfiguration_ClientMode">ClientMode</a>).</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">event EventHandler ClientDisconnected</code></pre>
|
| </div>
|
| <h5 class="eventType">Event Type</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.EventHandler</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h4 id="Apache_Ignite_Core_IIgnite_ClientReconnected" data-uid="Apache.Ignite.Core.IIgnite.ClientReconnected">ClientReconnected</h4>
|
| <div class="markdown level1 summary"><p>Occurs when client node reconnects to the cluster. This event can only occur when this instance |
| runs in client mode (<a class="xref" href="Apache.Ignite.Core.IgniteConfiguration.html#Apache_Ignite_Core_IgniteConfiguration_ClientMode">ClientMode</a>).</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">event EventHandler<ClientReconnectEventArgs> ClientReconnected</code></pre>
|
| </div>
|
| <h5 class="eventType">Event Type</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.EventHandler</span><<a class="xref" href="Apache.Ignite.Core.Lifecycle.ClientReconnectEventArgs.html">ClientReconnectEventArgs</a>></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h4 id="Apache_Ignite_Core_IIgnite_Stopped" data-uid="Apache.Ignite.Core.IIgnite.Stopped">Stopped</h4>
|
| <div class="markdown level1 summary"><p>Occurs when node has stopped. Node can't be used at this point. |
| See also: <a class="xref" href="Apache.Ignite.Core.Lifecycle.LifecycleEventType.html#Apache_Ignite_Core_Lifecycle_LifecycleEventType_AfterNodeStop">AfterNodeStop</a>.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">event EventHandler Stopped</code></pre>
|
| </div>
|
| <h5 class="eventType">Event Type</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.EventHandler</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h4 id="Apache_Ignite_Core_IIgnite_Stopping" data-uid="Apache.Ignite.Core.IIgnite.Stopping">Stopping</h4>
|
| <div class="markdown level1 summary"><p>Occurs when node begins to stop. Node is fully functional at this point. |
| See also: <a class="xref" href="Apache.Ignite.Core.Lifecycle.LifecycleEventType.html#Apache_Ignite_Core_Lifecycle_LifecycleEventType_BeforeNodeStop">BeforeNodeStop</a>.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">event EventHandler Stopping</code></pre>
|
| </div>
|
| <h5 class="eventType">Event Type</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.EventHandler</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 - 2018 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>
|
