blob: c15b5a87d2494cc4417e057ee7e29e338351b6b6 [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<link rel="canonical" href="https://ignite.apache.org/releases/2.9.0/dotnetdoc/api/Apache.Ignite.Core.Configuration.LockConfiguration.html" />
<META NAME="ROBOTS" CONTENT="NOINDEX">
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class LockConfiguration
| Apache Ignite.NET </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class LockConfiguration
| 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.Configuration.LockConfiguration">
<h1 id="Apache_Ignite_Core_Configuration_LockConfiguration" data-uid="Apache.Ignite.Core.Configuration.LockConfiguration" class="text-break">Class LockConfiguration
</h1>
<div class="markdown level0 summary"><p><a class="xref" href="Apache.Ignite.Core.IIgniteLock.html">IIgniteLock</a> configuration.</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">LockConfiguration</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.Configuration.html">Apache.Ignite.Core.Configuration</a></h6>
<h6><strong>Assembly</strong>: Apache.Ignite.Core.dll</h6>
<h5 id="Apache_Ignite_Core_Configuration_LockConfiguration_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class LockConfiguration</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="Apache_Ignite_Core_Configuration_LockConfiguration__ctor_" data-uid="Apache.Ignite.Core.Configuration.LockConfiguration.#ctor*"></a>
<h4 id="Apache_Ignite_Core_Configuration_LockConfiguration__ctor" data-uid="Apache.Ignite.Core.Configuration.LockConfiguration.#ctor">LockConfiguration()</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of <a class="xref" href="Apache.Ignite.Core.Configuration.LockConfiguration.html">LockConfiguration</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 LockConfiguration()</code></pre>
</div>
<a id="Apache_Ignite_Core_Configuration_LockConfiguration__ctor_" data-uid="Apache.Ignite.Core.Configuration.LockConfiguration.#ctor*"></a>
<h4 id="Apache_Ignite_Core_Configuration_LockConfiguration__ctor_Apache_Ignite_Core_Configuration_LockConfiguration_" data-uid="Apache.Ignite.Core.Configuration.LockConfiguration.#ctor(Apache.Ignite.Core.Configuration.LockConfiguration)">LockConfiguration(LockConfiguration)</h4>
<div class="markdown level1 summary"><p>Initializes a new instance of <a class="xref" href="Apache.Ignite.Core.Configuration.LockConfiguration.html">LockConfiguration</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 LockConfiguration(LockConfiguration other)</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.Configuration.LockConfiguration.html">LockConfiguration</a></td>
<td><span class="parametername">other</span></td>
<td><p>Other configuration to copy.</p>
</td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<a id="Apache_Ignite_Core_Configuration_LockConfiguration_IsFailoverSafe_" data-uid="Apache.Ignite.Core.Configuration.LockConfiguration.IsFailoverSafe*"></a>
<h4 id="Apache_Ignite_Core_Configuration_LockConfiguration_IsFailoverSafe" data-uid="Apache.Ignite.Core.Configuration.LockConfiguration.IsFailoverSafe">IsFailoverSafe</h4>
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether the lock should be failover-safe: when true,
if any node leaves topology, all locks already acquired by that node are silently released
and become available for other nodes to acquire. When false, all threads on other nodes
waiting to acquire the lock are interrupted.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsFailoverSafe { 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_Configuration_LockConfiguration_IsFair_" data-uid="Apache.Ignite.Core.Configuration.LockConfiguration.IsFair*"></a>
<h4 id="Apache_Ignite_Core_Configuration_LockConfiguration_IsFair" data-uid="Apache.Ignite.Core.Configuration.LockConfiguration.IsFair">IsFair</h4>
<div class="markdown level1 summary"><p>Gets or sets a value indicating whether the lock should be in fair mode.
<p>
When true, under contention, locks favor granting access to the longest-waiting thread. Otherwise this
lock does not guarantee any particular access order.
<p>
Fair locks accessed by many threads may display lower overall throughput than those using the default
setting, but have smaller variances in times to obtain locks and guarantee lack of starvation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool IsFair { 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_Configuration_LockConfiguration_Name_" data-uid="Apache.Ignite.Core.Configuration.LockConfiguration.Name*"></a>
<h4 id="Apache_Ignite_Core_Configuration_LockConfiguration_Name" data-uid="Apache.Ignite.Core.Configuration.LockConfiguration.Name">Name</h4>
<div class="markdown level1 summary"><p>Gets or sets the cluster-wide lock name.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public string Name { 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>
</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>