blob: b3f28af2aa3b984f602e25075f511176f94bc3ac [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<link rel="canonical" href="https://ignite.apache.org/releases/2.4.0/dotnetdoc/api/Apache.Ignite.Core.Client.IIgniteClient.html" />
<META NAME="ROBOTS" CONTENT="NOINDEX">
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Interface IIgniteClient
| Apache Ignite.NET </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Interface IIgniteClient
| 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.IIgniteClient">
<h1 id="Apache_Ignite_Core_Client_IIgniteClient" data-uid="Apache.Ignite.Core.Client.IIgniteClient" class="text-break">Interface IIgniteClient
</h1>
<div class="markdown level0 summary"><p>Main entry point for Ignite Thin Client APIs.
You can obtain an instance of <a class="xref" href="Apache.Ignite.Core.Client.IIgniteClient.html">IIgniteClient</a> through one of the
<a class="xref" href="Apache.Ignite.Core.Ignition.html#Apache_Ignite_Core_Ignition_StartClient">StartClient()</a> overloads.
<p>
Instances of this class and all nested APIs are thread safe.</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.Client.html">Apache.Ignite.Core.Client</a></h6>
<h6><strong>Assembly</strong>: Apache.Ignite.Core.dll</h6>
<h5 id="Apache_Ignite_Core_Client_IIgniteClient_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public interface IIgniteClient : IDisposable</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<a id="Apache_Ignite_Core_Client_IIgniteClient_CreateCache_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.CreateCache*"></a>
<h4 id="Apache_Ignite_Core_Client_IIgniteClient_CreateCache__2_Apache_Ignite_Core_Client_Cache_CacheClientConfiguration_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.CreateCache``2(Apache.Ignite.Core.Client.Cache.CacheClientConfiguration)">CreateCache&lt;TK, TV&gt;(CacheClientConfiguration)</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">ICacheClient&lt;TK, TV&gt; CreateCache&lt;TK, TV&gt;(CacheClientConfiguration 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.Client.Cache.CacheClientConfiguration.html">CacheClientConfiguration</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.Client.Cache.ICacheClient-2.html">ICacheClient</a>&lt;TK, TV&gt;</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_Client_IIgniteClient_CreateCache_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.CreateCache*"></a>
<h4 id="Apache_Ignite_Core_Client_IIgniteClient_CreateCache__2_System_String_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.CreateCache``2(System.String)">CreateCache&lt;TK, TV&gt;(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">ICacheClient&lt;TK, TV&gt; CreateCache&lt;TK, TV&gt;(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.Client.Cache.ICacheClient-2.html">ICacheClient</a>&lt;TK, TV&gt;</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_Client_IIgniteClient_DestroyCache_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.DestroyCache*"></a>
<h4 id="Apache_Ignite_Core_Client_IIgniteClient_DestroyCache_System_String_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.DestroyCache(System.String)">DestroyCache(String)</h4>
<div class="markdown level1 summary"><p>Destroys dynamically created (with <a class="xref" href="Apache.Ignite.Core.Client.IIgniteClient.html#Apache_Ignite_Core_Client_IIgniteClient_CreateCache__2_System_String_">CreateCache&lt;TK, TV&gt;(String)</a> or
<a class="xref" href="Apache.Ignite.Core.Client.IIgniteClient.html#Apache_Ignite_Core_Client_IIgniteClient_GetOrCreateCache__2_System_String_">GetOrCreateCache&lt;TK, TV&gt;(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_Client_IIgniteClient_GetBinary_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetBinary*"></a>
<h4 id="Apache_Ignite_Core_Client_IIgniteClient_GetBinary" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetBinary">GetBinary()</h4>
<div class="markdown level1 summary"><p>Gets Ignite binary services.</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_Client_IIgniteClient_GetCache_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetCache*"></a>
<h4 id="Apache_Ignite_Core_Client_IIgniteClient_GetCache__2_System_String_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetCache``2(System.String)">GetCache&lt;TK, TV&gt;(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 <a class="xref" href="Apache.Ignite.Core.Client.Cache.ICacheClient-2.html">ICacheClient&lt;TK, TV&gt;</a> 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.Client.IIgniteClient.html#Apache_Ignite_Core_Client_IIgniteClient_GetCache__2_System_String_">GetCache&lt;TK, TV&gt;(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">ICacheClient&lt;TK, TV&gt; GetCache&lt;TK, TV&gt;(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.Client.Cache.ICacheClient-2.html">ICacheClient</a>&lt;TK, TV&gt;</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_Client_IIgniteClient_GetCacheNames_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetCacheNames*"></a>
<h4 id="Apache_Ignite_Core_Client_IIgniteClient_GetCacheNames" data-uid="Apache.Ignite.Core.Client.IIgniteClient.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&lt;string&gt; 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>&lt;<span class="xref">System.String</span>&gt;</td>
<td><p>Collection of names of currently available caches.</p>
</td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Client_IIgniteClient_GetConfiguration_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetConfiguration*"></a>
<h4 id="Apache_Ignite_Core_Client_IIgniteClient_GetConfiguration" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetConfiguration">GetConfiguration()</h4>
<div class="markdown level1 summary"><p>Gets the configuration.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">IgniteClientConfiguration 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.Client.IgniteClientConfiguration.html">IgniteClientConfiguration</a></td>
<td></td>
</tr>
</tbody>
</table>
<a id="Apache_Ignite_Core_Client_IIgniteClient_GetOrCreateCache_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetOrCreateCache*"></a>
<h4 id="Apache_Ignite_Core_Client_IIgniteClient_GetOrCreateCache__2_Apache_Ignite_Core_Client_Cache_CacheClientConfiguration_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetOrCreateCache``2(Apache.Ignite.Core.Client.Cache.CacheClientConfiguration)">GetOrCreateCache&lt;TK, TV&gt;(CacheClientConfiguration)</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">ICacheClient&lt;TK, TV&gt; GetOrCreateCache&lt;TK, TV&gt;(CacheClientConfiguration 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.Client.Cache.CacheClientConfiguration.html">CacheClientConfiguration</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.Client.Cache.ICacheClient-2.html">ICacheClient</a>&lt;TK, TV&gt;</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_Client_IIgniteClient_GetOrCreateCache_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetOrCreateCache*"></a>
<h4 id="Apache_Ignite_Core_Client_IIgniteClient_GetOrCreateCache__2_System_String_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetOrCreateCache``2(System.String)">GetOrCreateCache&lt;TK, TV&gt;(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">ICacheClient&lt;TK, TV&gt; GetOrCreateCache&lt;TK, TV&gt;(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.Client.Cache.ICacheClient-2.html">ICacheClient</a>&lt;TK, TV&gt;</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>
</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>