| <!DOCTYPE html>
|
| <!--[if IE]><![endif]-->
|
| <html>
|
|
|
| <head>
|
| <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="../">
|
|
|
| </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="properties">Properties
|
| </h3>
|
| <a id="Apache_Ignite_Core_Client_IIgniteClient_LocalEndPoint_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.LocalEndPoint*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IIgniteClient_LocalEndPoint" data-uid="Apache.Ignite.Core.Client.IIgniteClient.LocalEndPoint">LocalEndPoint</h4>
|
| <div class="markdown level1 summary"><p>Gets the current local EndPoint.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">EndPoint LocalEndPoint { 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.Net.EndPoint</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IIgniteClient_RemoteEndPoint_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.RemoteEndPoint*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IIgniteClient_RemoteEndPoint" data-uid="Apache.Ignite.Core.Client.IIgniteClient.RemoteEndPoint">RemoteEndPoint</h4>
|
| <div class="markdown level1 summary"><p>Gets the current remote EndPoint.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">EndPoint RemoteEndPoint { 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.Net.EndPoint</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <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<TK, TV>(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<TK, TV> CreateCache<TK, TV>(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><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_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<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">ICacheClient<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.Client.Cache.ICacheClient-2.html">ICacheClient</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_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<TK, TV>(String)</a> or |
| <a class="xref" href="Apache.Ignite.Core.Client.IIgniteClient.html#Apache_Ignite_Core_Client_IIgniteClient_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_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<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 <a class="xref" href="Apache.Ignite.Core.Client.Cache.ICacheClient-2.html">ICacheClient<TK, TV></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<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">ICacheClient<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.Client.Cache.ICacheClient-2.html">ICacheClient</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_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<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_Client_IIgniteClient_GetCluster_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetCluster*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IIgniteClient_GetCluster" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetCluster">GetCluster()</h4>
|
| <div class="markdown level1 summary"><p>Gets Ignite cluster.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">IClientCluster 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.Client.IClientCluster.html">IClientCluster</a></td>
|
| <td><p>Instance of <a class="xref" href="Apache.Ignite.Core.Client.IClientCluster.html">IClientCluster</a> interface.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IIgniteClient_GetCompute_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetCompute*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IIgniteClient_GetCompute" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetCompute">GetCompute()</h4>
|
| <div class="markdown level1 summary"><p>Gets the compute API.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">IComputeClient 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.Client.Compute.IComputeClient.html">IComputeClient</a></td>
|
| <td></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_GetConnections_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetConnections*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IIgniteClient_GetConnections" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetConnections">GetConnections()</h4>
|
| <div class="markdown level1 summary"><p>Gets all active connections. Ignite Thin Client maintains connections to multiple server nodes when |
| <a class="xref" href="Apache.Ignite.Core.Client.IgniteClientConfiguration.html#Apache_Ignite_Core_Client_IgniteClientConfiguration_EnablePartitionAwareness">EnablePartitionAwareness</a> is true.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">IEnumerable<IClientConnection> GetConnections()</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.IEnumerable</span><<a class="xref" href="Apache.Ignite.Core.Client.IClientConnection.html">IClientConnection</a>></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IIgniteClient_GetDataStreamer_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetDataStreamer*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IIgniteClient_GetDataStreamer__2_System_String_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetDataStreamer``2(System.String)">GetDataStreamer<TK, TV>(String)</h4>
|
| <div class="markdown level1 summary"><p>Gets a new instance of the data streamer associated with the given cache name. |
| <p> |
| Data streamer loads data efficiently into cache. |
| See <a class="xref" href="Apache.Ignite.Core.Client.Datastream.IDataStreamerClient-2.html">IDataStreamerClient<TK, TV></a> for more information.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">IDataStreamerClient<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.</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.Datastream.IDataStreamerClient-2.html">IDataStreamerClient</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_Client_IIgniteClient_GetDataStreamer_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetDataStreamer*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IIgniteClient_GetDataStreamer__2_System_String_Apache_Ignite_Core_Client_Datastream_DataStreamerClientOptions_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetDataStreamer``2(System.String,Apache.Ignite.Core.Client.Datastream.DataStreamerClientOptions)">GetDataStreamer<TK, TV>(String, DataStreamerClientOptions)</h4>
|
| <div class="markdown level1 summary"><p>Gets a new instance of the data streamer associated with the given cache name. |
| <p> |
| Data streamer loads data efficiently into cache. |
| See <a class="xref" href="Apache.Ignite.Core.Client.Datastream.IDataStreamerClient-2.html">IDataStreamerClient<TK, TV></a> for more information.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">IDataStreamerClient<TK, TV> GetDataStreamer<TK, TV>(string cacheName, DataStreamerClientOptions options)</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.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><a class="xref" href="Apache.Ignite.Core.Client.Datastream.DataStreamerClientOptions.html">DataStreamerClientOptions</a></td>
|
| <td><span class="parametername">options</span></td>
|
| <td><p>Data streamer options.</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.Datastream.IDataStreamerClient-2.html">IDataStreamerClient</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_Client_IIgniteClient_GetDataStreamer_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetDataStreamer*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IIgniteClient_GetDataStreamer__2_System_String_Apache_Ignite_Core_Client_Datastream_DataStreamerClientOptions___0___1__" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetDataStreamer``2(System.String,Apache.Ignite.Core.Client.Datastream.DataStreamerClientOptions{``0,``1})">GetDataStreamer<TK, TV>(String, DataStreamerClientOptions<TK, TV>)</h4>
|
| <div class="markdown level1 summary"><p>Gets a new instance of the data streamer associated with the given cache name. |
| <p> |
| Data streamer loads data efficiently into cache. |
| See <a class="xref" href="Apache.Ignite.Core.Client.Datastream.IDataStreamerClient-2.html">IDataStreamerClient<TK, TV></a> for more information.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">IDataStreamerClient<TK, TV> GetDataStreamer<TK, TV>(string cacheName, DataStreamerClientOptions<TK, TV> options)</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.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><a class="xref" href="Apache.Ignite.Core.Client.Datastream.DataStreamerClientOptions-2.html">DataStreamerClientOptions</a><TK, TV></td>
|
| <td><span class="parametername">options</span></td>
|
| <td><p>Data streamer options.</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.Datastream.IDataStreamerClient-2.html">IDataStreamerClient</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_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<TK, TV>(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<TK, TV> GetOrCreateCache<TK, TV>(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><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_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<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">ICacheClient<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.Client.Cache.ICacheClient-2.html">ICacheClient</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_Client_IIgniteClient_GetServices_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetServices*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IIgniteClient_GetServices" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetServices">GetServices()</h4>
|
| <div class="markdown level1 summary"><p>Gets the services API.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">IServicesClient 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.Client.Services.IServicesClient.html">IServicesClient</a></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IIgniteClient_GetTransactions_" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetTransactions*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IIgniteClient_GetTransactions" data-uid="Apache.Ignite.Core.Client.IIgniteClient.GetTransactions">GetTransactions()</h4>
|
| <div class="markdown level1 summary"><p>Gets Ignite transactions facade <a class="xref" href="Apache.Ignite.Core.Client.Transactions.ITransactionsClient.html">ITransactionsClient</a>. |
| <p> Transactions are bound to the thread started the transaction. After that, each cache operation within this thread |
| will belong to the corresponding transaction until the transaction is committed, rolled back or closed. |
| <p> Should not be used with async calls.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">ITransactionsClient 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.Client.Transactions.ITransactionsClient.html">ITransactionsClient</a></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| </article>
|
| </div>
|
|
|
| <div class="hidden-sm col-md-2" role="complementary">
|
| <div class="sideaffix">
|
| <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
|
| <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
|
| </nav>
|
| </div>
|
| </div>
|
| </div>
|
| </div>
|
|
|
| <footer>
|
| <div class="grad-bottom"></div>
|
| <div class="footer">
|
| <div class="container">
|
| <span class="pull-right">
|
| <a href="#top">Back to top</a>
|
| </span>
|
| © 2015 - 2019 The Apache Software Foundation
|
|
|
| </div>
|
| </div>
|
| </footer>
|
| </div>
|
|
|
| <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
|
| <script type="text/javascript" src="../styles/docfx.js"></script>
|
| <script type="text/javascript" src="../styles/main.js"></script>
|
| </body>
|
| </html>
|
