| <!DOCTYPE html>
|
| <!--[if IE]><![endif]-->
|
| <html>
|
|
|
| <head>
|
| <meta charset="utf-8">
|
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
| <title>Class IgniteClientConfiguration
|
| | Apache Ignite.NET </title>
|
| <meta name="viewport" content="width=device-width">
|
| <meta name="title" content="Class IgniteClientConfiguration
|
| | 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.IgniteClientConfiguration">
|
|
|
|
|
| <h1 id="Apache_Ignite_Core_Client_IgniteClientConfiguration" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration" class="text-break">Class IgniteClientConfiguration
|
| </h1>
|
| <div class="markdown level0 summary"><p>Ignite thin client configuration. |
| <p> |
| Ignite thin client connects to a specific Ignite node with a socket and does not start JVM in process. |
| This configuration should correspond to <a class="xref" href="Apache.Ignite.Core.IgniteConfiguration.html#Apache_Ignite_Core_IgniteConfiguration_ClientConnectorConfiguration">ClientConnectorConfiguration</a> |
| on a target node.</p> |
| </div>
|
| <div class="markdown level0 conceptual"></div>
|
| <div class="inheritance">
|
| <h5>Inheritance</h5>
|
| <div class="level0"><span class="xref">System.Object</span></div>
|
| <div class="level1"><span class="xref">IgniteClientConfiguration</span></div>
|
| </div>
|
| <div class="inheritedMembers">
|
| <h5>Inherited Members</h5>
|
| <div>
|
| <span class="xref">System.Object.ToString()</span>
|
| </div>
|
| <div>
|
| <span class="xref">System.Object.Equals(System.Object)</span>
|
| </div>
|
| <div>
|
| <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
|
| </div>
|
| <div>
|
| <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
|
| </div>
|
| <div>
|
| <span class="xref">System.Object.GetHashCode()</span>
|
| </div>
|
| <div>
|
| <span class="xref">System.Object.GetType()</span>
|
| </div>
|
| <div>
|
| <span class="xref">System.Object.MemberwiseClone()</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_IgniteClientConfiguration_syntax">Syntax</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public class IgniteClientConfiguration</code></pre>
|
| </div>
|
| <h3 id="constructors">Constructors
|
| </h3>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration__ctor_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.#ctor*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration__ctor" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.#ctor">IgniteClientConfiguration()</h4>
|
| <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Apache.Ignite.Core.Client.IgniteClientConfiguration.html">IgniteClientConfiguration</a> class.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public IgniteClientConfiguration()</code></pre>
|
| </div>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration__ctor_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.#ctor*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration__ctor_Apache_Ignite_Core_Client_IgniteClientConfiguration_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.#ctor(Apache.Ignite.Core.Client.IgniteClientConfiguration)">IgniteClientConfiguration(IgniteClientConfiguration)</h4>
|
| <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Apache.Ignite.Core.Client.IgniteClientConfiguration.html">IgniteClientConfiguration</a> class.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public IgniteClientConfiguration(IgniteClientConfiguration cfg)</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.IgniteClientConfiguration.html">IgniteClientConfiguration</a></td>
|
| <td><span class="parametername">cfg</span></td>
|
| <td><p>The configuration to copy.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration__ctor_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.#ctor*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration__ctor_System_String_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.#ctor(System.String)">IgniteClientConfiguration(String)</h4>
|
| <div class="markdown level1 summary"><p>Initializes a new instance of the <a class="xref" href="Apache.Ignite.Core.Client.IgniteClientConfiguration.html">IgniteClientConfiguration</a> class.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public IgniteClientConfiguration(string host)</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">host</span></td>
|
| <td><p>The host to connect to.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h3 id="fields">Fields
|
| </h3>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_DefaultEnablePartitionAwareness" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.DefaultEnablePartitionAwareness">DefaultEnablePartitionAwareness</h4>
|
| <div class="markdown level1 summary"><p>Default value of <a class="xref" href="Apache.Ignite.Core.Client.IgniteClientConfiguration.html#Apache_Ignite_Core_Client_IgniteClientConfiguration_EnablePartitionAwareness">EnablePartitionAwareness</a> property.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public const bool DefaultEnablePartitionAwareness = true</code></pre>
|
| </div>
|
| <h5 class="fieldValue">Field 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.Boolean</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_DefaultPort" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.DefaultPort">DefaultPort</h4>
|
| <div class="markdown level1 summary"><p>Default port.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public const int DefaultPort = 10800</code></pre>
|
| </div>
|
| <h5 class="fieldValue">Field 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.Int32</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_DefaultSocketBufferSize" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.DefaultSocketBufferSize">DefaultSocketBufferSize</h4>
|
| <div class="markdown level1 summary"><p>Default socket buffer size.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public const int DefaultSocketBufferSize = 0</code></pre>
|
| </div>
|
| <h5 class="fieldValue">Field 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.Int32</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_DefaultSocketTimeout" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.DefaultSocketTimeout">DefaultSocketTimeout</h4>
|
| <div class="markdown level1 summary"><p>Default socket timeout.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public static readonly TimeSpan DefaultSocketTimeout</code></pre>
|
| </div>
|
| <h5 class="fieldValue">Field 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.TimeSpan</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_DefaultTcpNoDelay" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.DefaultTcpNoDelay">DefaultTcpNoDelay</h4>
|
| <div class="markdown level1 summary"><p>Default value of <a class="xref" href="Apache.Ignite.Core.Client.IgniteClientConfiguration.html#Apache_Ignite_Core_Client_IgniteClientConfiguration_TcpNoDelay">TcpNoDelay</a> property.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public const bool DefaultTcpNoDelay = true</code></pre>
|
| </div>
|
| <h5 class="fieldValue">Field 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.Boolean</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h3 id="properties">Properties
|
| </h3>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration_BinaryConfiguration_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.BinaryConfiguration*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_BinaryConfiguration" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.BinaryConfiguration">BinaryConfiguration</h4>
|
| <div class="markdown level1 summary"><p>Gets or sets the binary configuration.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public BinaryConfiguration BinaryConfiguration { get; set; }</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.Binary.BinaryConfiguration.html">BinaryConfiguration</a></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration_EnablePartitionAwareness_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.EnablePartitionAwareness*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_EnablePartitionAwareness" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.EnablePartitionAwareness">EnablePartitionAwareness</h4>
|
| <div class="markdown level1 summary"><p>Gets or sets a value indicating whether partition awareness should be enabled. |
| <p> |
| Default is true: for cache operations, Ignite client attempts to send the request directly to |
| the primary node for the given cache key. |
| To do so, connection is established to every known server node at all times. |
| <p> |
| When false: only one connection is established at a given moment to a random server node.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public bool EnablePartitionAwareness { get; set; }</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.Boolean</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration_Endpoints_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.Endpoints*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_Endpoints" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.Endpoints">Endpoints</h4>
|
| <div class="markdown level1 summary"><p>Gets or sets endpoints to connect to. |
| Examples of supported formats:</p> |
| <ul> |
| <li>192.168.1.25 (default port is used, see <a class="xref" href="Apache.Ignite.Core.Client.IgniteClientConfiguration.html#Apache_Ignite_Core_Client_IgniteClientConfiguration_DefaultPort">DefaultPort</a>).</li> |
| <li>192.168.1.25:780 (custom port)</li> |
| <li>192.168.1.25:780..787 (custom port range)</li> |
| <li>my-host.com (default port is used, see <a class="xref" href="Apache.Ignite.Core.Client.IgniteClientConfiguration.html#Apache_Ignite_Core_Client_IgniteClientConfiguration_DefaultPort">DefaultPort</a>).</li> |
| <li>my-host.com:780 (custom port)</li> |
| <li>my-host.com:780..787 (custom port range) |
| <p> |
| When multiple endpoints are specified, failover and load-balancing mechanism is enabled:</li> |
| <li>Ignite picks random endpoint and connects to it.</li> |
| <li>On disconnect, next endpoint is picked from the list (.</li> |
| </ul> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public ICollection<string> Endpoints { get; set; }</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.Collections.Generic.ICollection</span><<span class="xref">System.String</span>></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration_Host_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.Host*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_Host" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.Host">Host</h4>
|
| <div class="markdown level1 summary"><p>Gets or sets the host. Should not be null.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">[Obsolete("Use Endpoints instead")] |
| public string Host { get; set; }</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></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration_Logger_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.Logger*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_Logger" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.Logger">Logger</h4>
|
| <div class="markdown level1 summary"><p>Gets or sets the logger. |
| Default is <a class="xref" href="Apache.Ignite.Core.Log.ConsoleLogger.html">ConsoleLogger</a>. Set to <code>null</code> to disable logging.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public ILogger Logger { get; set; }</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_Client_IgniteClientConfiguration_Password_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.Password*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_Password" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.Password">Password</h4>
|
| <div class="markdown level1 summary"><p>Password to be used to connect to secured cluster.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public string Password { get; set; }</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></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration_Port_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.Port*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_Port" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.Port">Port</h4>
|
| <div class="markdown level1 summary"><p>Gets or sets the port.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">[Obsolete("Use Endpoints instead")] |
| public int Port { get; set; }</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.Int32</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration_ReconnectDisabled_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.ReconnectDisabled*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_ReconnectDisabled" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.ReconnectDisabled">ReconnectDisabled</h4>
|
| <div class="markdown level1 summary"><p>Gets or sets a value indicating whether automatic reconnect is disabled.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public bool ReconnectDisabled { get; set; }</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.Boolean</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration_SocketReceiveBufferSize_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.SocketReceiveBufferSize*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_SocketReceiveBufferSize" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.SocketReceiveBufferSize">SocketReceiveBufferSize</h4>
|
| <div class="markdown level1 summary"><p>Gets or sets the size of the socket receive buffer. When set to 0, operating system default is used.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public int SocketReceiveBufferSize { get; set; }</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.Int32</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration_SocketSendBufferSize_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.SocketSendBufferSize*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_SocketSendBufferSize" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.SocketSendBufferSize">SocketSendBufferSize</h4>
|
| <div class="markdown level1 summary"><p>Gets or sets the size of the socket send buffer. When set to 0, operating system default is used.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public int SocketSendBufferSize { get; set; }</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.Int32</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration_SocketTimeout_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.SocketTimeout*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_SocketTimeout" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.SocketTimeout">SocketTimeout</h4>
|
| <div class="markdown level1 summary"><p>Gets or sets the socket operation timeout. Zero or negative means infinite timeout.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public TimeSpan SocketTimeout { get; set; }</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.TimeSpan</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration_SslStreamFactory_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.SslStreamFactory*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_SslStreamFactory" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.SslStreamFactory">SslStreamFactory</h4>
|
| <div class="markdown level1 summary"><p>Gets or sets the SSL stream factory. |
| <p> |
| When not null, secure socket connection will be established.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public ISslStreamFactory SslStreamFactory { get; set; }</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.Client.ISslStreamFactory.html">ISslStreamFactory</a></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration_TcpNoDelay_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.TcpNoDelay*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_TcpNoDelay" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.TcpNoDelay">TcpNoDelay</h4>
|
| <div class="markdown level1 summary"><p>Gets or sets the value for <code>TCP_NODELAY</code> socket option. Each |
| socket will be opened using provided value. |
| <p> |
| Setting this option to <code>true</code> disables Nagle's algorithm |
| for socket decreasing latency and delivery time for small messages. |
| <p> |
| For systems that work under heavy network load it is advisable to set this value to <code>false</code>.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public bool TcpNoDelay { get; set; }</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.Boolean</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration_TransactionConfiguration_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.TransactionConfiguration*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_TransactionConfiguration" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.TransactionConfiguration">TransactionConfiguration</h4>
|
| <div class="markdown level1 summary"><p>Gets or sets the transaction configuration. |
| See <a class="xref" href="Apache.Ignite.Core.Client.Transactions.ITransactionsClient.html">ITransactionsClient</a>, <a class="xref" href="Apache.Ignite.Core.Client.IIgniteClient.html#Apache_Ignite_Core_Client_IIgniteClient_GetTransactions">GetTransactions()</a>.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public TransactionClientConfiguration TransactionConfiguration { get; set; }</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.Client.Transactions.TransactionClientConfiguration.html">TransactionClientConfiguration</a></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration_UserName_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.UserName*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_UserName" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.UserName">UserName</h4>
|
| <div class="markdown level1 summary"><p>Username to be used to connect to secured cluster.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public string UserName { get; set; }</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></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h3 id="methods">Methods
|
| </h3>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration_FromXml_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.FromXml*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_FromXml_System_String_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.FromXml(System.String)">FromXml(String)</h4>
|
| <div class="markdown level1 summary"><p>Deserializes IgniteClientConfiguration from the XML string.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public static IgniteClientConfiguration FromXml(string xml)</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">xml</span></td>
|
| <td><p>Xml string.</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.IgniteClientConfiguration.html">IgniteClientConfiguration</a></td>
|
| <td><p>Deserialized instance.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration_FromXml_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.FromXml*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_FromXml_System_Xml_XmlReader_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.FromXml(System.Xml.XmlReader)">FromXml(XmlReader)</h4>
|
| <div class="markdown level1 summary"><p>Deserializes IgniteClientConfiguration from the XML reader.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public static IgniteClientConfiguration FromXml(XmlReader reader)</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.Xml.XmlReader</span></td>
|
| <td><span class="parametername">reader</span></td>
|
| <td><p>The reader.</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.IgniteClientConfiguration.html">IgniteClientConfiguration</a></td>
|
| <td><p>Deserialized instance.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration_ToXml_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.ToXml*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_ToXml" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.ToXml">ToXml()</h4>
|
| <div class="markdown level1 summary"><p>Serializes this instance to an XML string.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public string ToXml()</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.String</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_Client_IgniteClientConfiguration_ToXml_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.ToXml*"></a>
|
| <h4 id="Apache_Ignite_Core_Client_IgniteClientConfiguration_ToXml_System_Xml_XmlWriter_System_String_" data-uid="Apache.Ignite.Core.Client.IgniteClientConfiguration.ToXml(System.Xml.XmlWriter,System.String)">ToXml(XmlWriter, String)</h4>
|
| <div class="markdown level1 summary"><p>Serializes this instance to the specified XML writer.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public void ToXml(XmlWriter writer, string rootElementName)</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.Xml.XmlWriter</span></td>
|
| <td><span class="parametername">writer</span></td>
|
| <td><p>The writer.</p> |
| </td>
|
| </tr>
|
| <tr>
|
| <td><span class="xref">System.String</span></td>
|
| <td><span class="parametername">rootElementName</span></td>
|
| <td><p>Name of the root element.</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 - 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>
|
