| <!DOCTYPE html>
|
| <!--[if IE]><![endif]-->
|
| <html>
|
|
|
| <head>
|
| <meta charset="utf-8">
|
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
| <title>Interface IIgniteLock
|
| | Apache Ignite.NET </title>
|
| <meta name="viewport" content="width=device-width">
|
| <meta name="title" content="Interface IIgniteLock
|
| | Apache Ignite.NET ">
|
| <meta name="generator" content="docfx 2.58.4.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" data-offset="120">
|
| <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">Search Results for <span></span></div>
|
| <div class="sr-items">
|
| <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
|
| </div>
|
| <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></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.IIgniteLock">
|
|
|
|
|
| <h1 id="Apache_Ignite_Core_IIgniteLock" data-uid="Apache.Ignite.Core.IIgniteLock" class="text-break">Interface IIgniteLock
|
| </h1>
|
| <div class="markdown level0 summary"><p>Distributed reentrant monitor (lock). |
| <p> |
| The functionality is similar to the standard <see cref="!:Monitor"></see> class, but works across all cluster nodes. |
| <p> |
| This API corresponds to <code>IgniteLock</code> in Java.</p> |
| </div>
|
| <div class="markdown level0 conceptual"></div>
|
| <h6><strong>Namespace</strong>: <a class="xref" href="Apache.Ignite.Core.html">Apache.Ignite.Core</a></h6>
|
| <h6><strong>Assembly</strong>: Apache.Ignite.Core.dll</h6>
|
| <h5 id="Apache_Ignite_Core_IIgniteLock_syntax">Syntax</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">public interface IIgniteLock</code></pre>
|
| </div>
|
| <h3 id="properties">Properties
|
| </h3>
|
| <a id="Apache_Ignite_Core_IIgniteLock_Configuration_" data-uid="Apache.Ignite.Core.IIgniteLock.Configuration*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgniteLock_Configuration" data-uid="Apache.Ignite.Core.IIgniteLock.Configuration">Configuration</h4>
|
| <div class="markdown level1 summary"><p>Gets the lock configuration.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">LockConfiguration Configuration { get; }</code></pre>
|
| </div>
|
| <h5 class="propertyValue">Property Value</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Type</th>
|
| <th>Description</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><a class="xref" href="Apache.Ignite.Core.Configuration.LockConfiguration.html">LockConfiguration</a></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h3 id="methods">Methods
|
| </h3>
|
| <a id="Apache_Ignite_Core_IIgniteLock_Enter_" data-uid="Apache.Ignite.Core.IIgniteLock.Enter*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgniteLock_Enter" data-uid="Apache.Ignite.Core.IIgniteLock.Enter">Enter()</h4>
|
| <div class="markdown level1 summary"><p>Acquires the distributed reentrant lock.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">void Enter()</code></pre>
|
| </div>
|
| <a id="Apache_Ignite_Core_IIgniteLock_Exit_" data-uid="Apache.Ignite.Core.IIgniteLock.Exit*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgniteLock_Exit" data-uid="Apache.Ignite.Core.IIgniteLock.Exit">Exit()</h4>
|
| <div class="markdown level1 summary"><p>Releases the lock.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">void Exit()</code></pre>
|
| </div>
|
| <a id="Apache_Ignite_Core_IIgniteLock_IsBroken_" data-uid="Apache.Ignite.Core.IIgniteLock.IsBroken*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgniteLock_IsBroken" data-uid="Apache.Ignite.Core.IIgniteLock.IsBroken">IsBroken()</h4>
|
| <div class="markdown level1 summary"><p>Returns a value indicating whether any node that owned the lock failed before releasing the lock.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">bool IsBroken()</code></pre>
|
| </div>
|
| <h5 class="returns">Returns</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Type</th>
|
| <th>Description</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><span class="xref">System.Boolean</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgniteLock_IsEntered_" data-uid="Apache.Ignite.Core.IIgniteLock.IsEntered*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgniteLock_IsEntered" data-uid="Apache.Ignite.Core.IIgniteLock.IsEntered">IsEntered()</h4>
|
| <div class="markdown level1 summary"><p>Determines whether the current thread holds the lock.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">bool IsEntered()</code></pre>
|
| </div>
|
| <h5 class="returns">Returns</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Type</th>
|
| <th>Description</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><span class="xref">System.Boolean</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgniteLock_IsRemoved_" data-uid="Apache.Ignite.Core.IIgniteLock.IsRemoved*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgniteLock_IsRemoved" data-uid="Apache.Ignite.Core.IIgniteLock.IsRemoved">IsRemoved()</h4>
|
| <div class="markdown level1 summary"><p>Gets a value indicating whether the lock has been removed from the cluster.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">bool IsRemoved()</code></pre>
|
| </div>
|
| <h5 class="returns">Returns</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Type</th>
|
| <th>Description</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><span class="xref">System.Boolean</span></td>
|
| <td></td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgniteLock_Remove_" data-uid="Apache.Ignite.Core.IIgniteLock.Remove*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgniteLock_Remove" data-uid="Apache.Ignite.Core.IIgniteLock.Remove">Remove()</h4>
|
| <div class="markdown level1 summary"><p>Removes the lock from the cluster.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">void Remove()</code></pre>
|
| </div>
|
| <a id="Apache_Ignite_Core_IIgniteLock_TryEnter_" data-uid="Apache.Ignite.Core.IIgniteLock.TryEnter*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgniteLock_TryEnter" data-uid="Apache.Ignite.Core.IIgniteLock.TryEnter">TryEnter()</h4>
|
| <div class="markdown level1 summary"><p>Acquires the lock only if it is free at the time of invocation.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">bool TryEnter()</code></pre>
|
| </div>
|
| <h5 class="returns">Returns</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Type</th>
|
| <th>Description</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><span class="xref">System.Boolean</span></td>
|
| <td><p>True if the lock was acquired; false otherwise.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <a id="Apache_Ignite_Core_IIgniteLock_TryEnter_" data-uid="Apache.Ignite.Core.IIgniteLock.TryEnter*"></a>
|
| <h4 id="Apache_Ignite_Core_IIgniteLock_TryEnter_TimeSpan_" data-uid="Apache.Ignite.Core.IIgniteLock.TryEnter(TimeSpan)">TryEnter(TimeSpan)</h4>
|
| <div class="markdown level1 summary"><p>Acquires the lock if it is not held by another thread within the given waiting time.</p> |
| </div>
|
| <div class="markdown level1 conceptual"></div>
|
| <h5 class="decalaration">Declaration</h5>
|
| <div class="codewrapper">
|
| <pre><code class="lang-csharp hljs">bool TryEnter(TimeSpan timeout)</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">TimeSpan</span></td>
|
| <td><span class="parametername">timeout</span></td>
|
| <td><p>Time to wait for the lock.</p> |
| </td>
|
| </tr>
|
| </tbody>
|
| </table>
|
| <h5 class="returns">Returns</h5>
|
| <table class="table table-bordered table-striped table-condensed">
|
| <thead>
|
| <tr>
|
| <th>Type</th>
|
| <th>Description</th>
|
| </tr>
|
| </thead>
|
| <tbody>
|
| <tr>
|
| <td><span class="xref">System.Boolean</span></td>
|
| <td><p>True if the lock was acquired; false otherwise.</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">
|
| <h5>In This Article</h5>
|
| <div></div>
|
| </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>
|
