Google Git
Sign in
apache / lucenenet-site / 17c7bc1988cb32e7f8409919fc025c5fcaca3695 / . / docs / 4.8.0-beta00013 / api / core / Lucene.Net.Store.Lock.html
blob: d23b08179347d3272932c1772db6019a803a989f [file] [log] [blame]
<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class Lock
| Apache Lucene.NET 4.8.0-beta00013 Documentation </title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class Lock
| Apache Lucene.NET 4.8.0-beta00013 Documentation ">
<meta name="generator" content="docfx 2.56.2.0">
<link rel="shortcut icon" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/favicon.ico">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.css">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.css">
<link rel="stylesheet" href="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.css">
<meta property="docfx:navrel" content="toc.html">
<meta property="docfx:tocrel" content="core/toc.html">
<meta property="docfx:rel" content="https://lucenenet.apache.org/docs/4.8.0-beta00009/">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<span id="forkongithub"><a href="https://github.com/apache/lucenenet" target="_blank">Fork me on GitHub</a></span>
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar 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="/">
<img id="logo" class="svg" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/logo/lucene-net-color.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">
<ul class="level0 breadcrumb">
<li>
<a href="https://lucenenet.apache.org/docs/4.8.0-beta00009/">API</a>
<span id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</span>
</li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list"></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</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="Lucene.Net.Store.Lock">
<h1 id="Lucene_Net_Store_Lock" data-uid="Lucene.Net.Store.Lock" class="text-break">Class Lock
</h1>
<div class="markdown level0 summary"><p>An interprocess mutex lock.
<p>Typical use might look like:</p>
<pre><code> var result = Lock.With.NewAnonymous&lt;string>(
@lock: directory.MakeLock(&quot;my.lock&quot;),
lockWaitTimeout: Lock.LOCK_OBTAIN_WAIT_FOREVER,
doBody: () =>
{
//... code to execute while locked ...
return &quot;the result&quot;;
}).Run();</code></pre>
</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">Lock</span></div>
</div>
<div classs="implements">
<h5>Implements</h5>
<div><span class="xref">System.IDisposable</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<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.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Lucene.Net.Store.html">Lucene.Net.Store</a></h6>
<h6><strong>Assembly</strong>: Lucene.Net.dll</h6>
<h5 id="Lucene_Net_Store_Lock_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract class Lock : IDisposable</code></pre>
</div>
<h3 id="fields">Fields
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_Lock_LOCK_OBTAIN_WAIT_FOREVER.md&amp;value=---%0Auid%3A%20Lucene.Net.Store.Lock.LOCK_OBTAIN_WAIT_FOREVER%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net/Store/Lock.cs/#L52">View Source</a>
</span>
<h4 id="Lucene_Net_Store_Lock_LOCK_OBTAIN_WAIT_FOREVER" data-uid="Lucene.Net.Store.Lock.LOCK_OBTAIN_WAIT_FOREVER">LOCK_OBTAIN_WAIT_FOREVER</h4>
<div class="markdown level1 summary"><p>Pass this value to <a class="xref" href="Lucene.Net.Store.Lock.html#Lucene_Net_Store_Lock_Obtain_System_Int64_">Obtain(Int64)</a> to try
forever to obtain the lock.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public const long LOCK_OBTAIN_WAIT_FOREVER = -1L</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.Int64</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_Lock_LOCK_POLL_INTERVAL.md&amp;value=---%0Auid%3A%20Lucene.Net.Store.Lock.LOCK_POLL_INTERVAL%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net/Store/Lock.cs/#L46">View Source</a>
</span>
<h4 id="Lucene_Net_Store_Lock_LOCK_POLL_INTERVAL" data-uid="Lucene.Net.Store.Lock.LOCK_POLL_INTERVAL">LOCK_POLL_INTERVAL</h4>
<div class="markdown level1 summary"><p>How long <a class="xref" href="Lucene.Net.Store.Lock.html#Lucene_Net_Store_Lock_Obtain_System_Int64_">Obtain(Int64)</a> waits, in milliseconds,
in between attempts to acquire the lock.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static long LOCK_POLL_INTERVAL</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.Int64</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="properties">Properties
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_Lock_FailureReason.md&amp;value=---%0Auid%3A%20Lucene.Net.Store.Lock.FailureReason%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net/Store/Lock.cs/#L97">View Source</a>
</span>
<a id="Lucene_Net_Store_Lock_FailureReason_" data-uid="Lucene.Net.Store.Lock.FailureReason*"></a>
<h4 id="Lucene_Net_Store_Lock_FailureReason" data-uid="Lucene.Net.Store.Lock.FailureReason">FailureReason</h4>
<div class="markdown level1 summary"><p>If a lock obtain called, this failureReason may be set
with the &quot;root cause&quot; <span class="xref">System.Exception</span> as to why the lock was
not obtained.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected Exception FailureReason { 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.Exception</span></td>
<td></td>
</tr>
</tbody>
</table>
<h3 id="methods">Methods
</h3>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_Lock_Dispose.md&amp;value=---%0Auid%3A%20Lucene.Net.Store.Lock.Dispose%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net/Store/Lock.cs/#L158">View Source</a>
</span>
<a id="Lucene_Net_Store_Lock_Dispose_" data-uid="Lucene.Net.Store.Lock.Dispose*"></a>
<h4 id="Lucene_Net_Store_Lock_Dispose" data-uid="Lucene.Net.Store.Lock.Dispose">Dispose()</h4>
<div class="markdown level1 summary"><p>Releases exclusive access. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public void Dispose()</code></pre>
</div>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_Lock_Dispose_System_Boolean_.md&amp;value=---%0Auid%3A%20Lucene.Net.Store.Lock.Dispose(System.Boolean)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net/Store/Lock.cs/#L166">View Source</a>
</span>
<a id="Lucene_Net_Store_Lock_Dispose_" data-uid="Lucene.Net.Store.Lock.Dispose*"></a>
<h4 id="Lucene_Net_Store_Lock_Dispose_System_Boolean_" data-uid="Lucene.Net.Store.Lock.Dispose(System.Boolean)">Dispose(Boolean)</h4>
<div class="markdown level1 summary"><p>Releases exclusive access. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected abstract void Dispose(bool disposing)</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.Boolean</span></td>
<td><span class="parametername">disposing</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_Lock_IsLocked.md&amp;value=---%0Auid%3A%20Lucene.Net.Store.Lock.IsLocked%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net/Store/Lock.cs/#L173">View Source</a>
</span>
<a id="Lucene_Net_Store_Lock_IsLocked_" data-uid="Lucene.Net.Store.Lock.IsLocked*"></a>
<h4 id="Lucene_Net_Store_Lock_IsLocked" data-uid="Lucene.Net.Store.Lock.IsLocked">IsLocked()</h4>
<div class="markdown level1 summary"><p>Returns <code>true</code> if the resource is currently locked. Note that one must
still call <a class="xref" href="Lucene.Net.Store.Lock.html#Lucene_Net_Store_Lock_Obtain">Obtain()</a> before using the resource.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract bool IsLocked()</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>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_Lock_NewAnonymous__1_Lucene_Net_Store_Lock_System_Int32_System_Func___0__.md&amp;value=---%0Auid%3A%20Lucene.Net.Store.Lock.NewAnonymous%60%601(Lucene.Net.Store.Lock%2CSystem.Int32%2CSystem.Func%7B%60%600%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net/Store/Lock.cs/#L80">View Source</a>
</span>
<a id="Lucene_Net_Store_Lock_NewAnonymous_" data-uid="Lucene.Net.Store.Lock.NewAnonymous*"></a>
<h4 id="Lucene_Net_Store_Lock_NewAnonymous__1_Lucene_Net_Store_Lock_System_Int32_System_Func___0__" data-uid="Lucene.Net.Store.Lock.NewAnonymous``1(Lucene.Net.Store.Lock,System.Int32,System.Func{``0})">NewAnonymous&lt;T&gt;(Lock, Int32, Func&lt;T&gt;)</h4>
<div class="markdown level1 summary"><p>Creates a new instance with the ability to specify the <a class="xref" href="Lucene.Net.Store.Lock.With-1.html#Lucene_Net_Store_Lock_With_1_DoBody">DoBody()</a> method
through the <code data-dev-comment-type="paramref" class="paramref">doBody</code> argument
<p>
Simple example:</p>
<pre><code> var result = Lock.With.NewAnonymous&lt;string>(
@lock: directory.MakeLock(&quot;my.lock&quot;),
lockWaitTimeout: Lock.LOCK_OBTAIN_WAIT_FOREVER,
doBody: () =>
{
//... code to execute while locked ...
return &quot;the result&quot;;
}).Run();</code></pre>
<p><p>
The result of the operation is the value that is returned from <code data-dev-comment-type="paramref" class="paramref">doBody</code>
(i.e. () =&gt; { return &quot;the result&quot;; }). The type of <typeparam name="T"></typeparam> determines the
return type of the operation.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Lock.With&lt;T&gt; NewAnonymous&lt;T&gt;(Lock lock, int lockWaitTimeout, Func&lt;T&gt; doBody)</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="Lucene.Net.Store.Lock.html">Lock</a></td>
<td><span class="parametername">lock</span></td>
<td><p>the <a class="xref" href="Lucene.Net.Store.Lock.html">Lock</a> instance to use </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">lockWaitTimeout</span></td>
<td><p>length of time to wait in
milliseconds or
<a class="xref" href="Lucene.Net.Store.Lock.html#Lucene_Net_Store_Lock_LOCK_OBTAIN_WAIT_FOREVER">LOCK_OBTAIN_WAIT_FOREVER</a> to retry forever </p>
</td>
</tr>
<tr>
<td><span class="xref">System.Func</span>&lt;T&gt;</td>
<td><span class="parametername">doBody</span></td>
<td><p>a delegate method that </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="Lucene.Net.Store.Lock.With-1.html">Lock.With</a>&lt;T&gt;</td>
<td><p>The value that is returned from the <code data-dev-comment-type="paramref" class="paramref">doBody</code> delegate method (i.e. () =&gt; { return theObject; })</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">T</span></td>
<td></td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_Lock_Obtain.md&amp;value=---%0Auid%3A%20Lucene.Net.Store.Lock.Obtain%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net/Store/Lock.cs/#L90">View Source</a>
</span>
<a id="Lucene_Net_Store_Lock_Obtain_" data-uid="Lucene.Net.Store.Lock.Obtain*"></a>
<h4 id="Lucene_Net_Store_Lock_Obtain" data-uid="Lucene.Net.Store.Lock.Obtain">Obtain()</h4>
<div class="markdown level1 summary"><p>Attempts to obtain exclusive access and immediately return
upon success or failure. Use <a class="xref" href="Lucene.Net.Store.Lock.html#Lucene_Net_Store_Lock_Dispose">Dispose()</a> to
release the lock. </p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public abstract bool Obtain()</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 iff exclusive access is obtained </p>
</td>
</tr>
</tbody>
</table>
<span class="small pull-right mobile-hide">
<span class="divider">|</span>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_Lock_Obtain_System_Int64_.md&amp;value=---%0Auid%3A%20Lucene.Net.Store.Lock.Obtain(System.Int64)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
</span>
<span class="small pull-right mobile-hide">
<a href="https://github.com/NightOwl888/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net/Store/Lock.cs/#L113">View Source</a>
</span>
<a id="Lucene_Net_Store_Lock_Obtain_" data-uid="Lucene.Net.Store.Lock.Obtain*"></a>
<h4 id="Lucene_Net_Store_Lock_Obtain_System_Int64_" data-uid="Lucene.Net.Store.Lock.Obtain(System.Int64)">Obtain(Int64)</h4>
<div class="markdown level1 summary"><p>Attempts to obtain an exclusive lock within amount of
time given. Polls once per <a class="xref" href="Lucene.Net.Store.Lock.html#Lucene_Net_Store_Lock_LOCK_POLL_INTERVAL">LOCK_POLL_INTERVAL</a>
(currently 1000) milliseconds until <code data-dev-comment-type="paramref" class="paramref">lockWaitTimeout</code> is
passed.</p>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public bool Obtain(long lockWaitTimeout)</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.Int64</span></td>
<td><span class="parametername">lockWaitTimeout</span></td>
<td><p>length of time to wait in
milliseconds or
<a class="xref" href="Lucene.Net.Store.Lock.html#Lucene_Net_Store_Lock_LOCK_OBTAIN_WAIT_FOREVER">LOCK_OBTAIN_WAIT_FOREVER</a> to retry forever </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><code>true</code> if lock was obtained </p>
</td>
</tr>
</tbody>
</table>
<h5 class="exceptions">Exceptions</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Condition</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Lucene.Net.Store.LockObtainFailedException.html">LockObtainFailedException</a></td>
<td><p>if lock wait times out </p>
</td>
</tr>
<tr>
<td><span class="xref">System.ArgumentException</span></td>
<td><p>if <code data-dev-comment-type="paramref" class="paramref">lockWaitTimeout</code> is
out of bounds </p>
</td>
</tr>
<tr>
<td><span class="xref">System.IO.IOException</span></td>
<td><p>if <a class="xref" href="Lucene.Net.Store.Lock.html#Lucene_Net_Store_Lock_Obtain">Obtain()</a> throws <span class="xref">System.IO.IOException</span> </p>
</td>
</tr>
</tbody>
</table>
<h3 id="implements">Implements</h3>
<div>
<span class="xref">System.IDisposable</span>
</div>
<h3 id="seealso">See Also</h3>
<div class="seealso">
<div><a class="xref" href="Lucene.Net.Store.Directory.html#Lucene_Net_Store_Directory_MakeLock_System_String_">MakeLock</a>(<span class="xref">System.String</span>)</div>
</div>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<div class="contribution">
<ul class="nav">
<li>
<a href="https://github.com/apache/lucenenet/new/docs/4.8.0-beta00013/websites/apidocs/apiSpec/new?filename=Lucene_Net_Store_Lock.md&amp;value=---%0Auid%3A%20Lucene.Net.Store.Lock%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
</li>
<li>
<a href="https://github.com/apache/lucenenet/blob/fix/apidocs-layout/src/Lucene.Net/Store/Lock.cs/#L40" class="contribution-link">View Source</a>
</li>
</ul>
</div>
<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>
Copyright © 2020 The Apache Software Foundation, Licensed under the <a href='http://www.apache.org/licenses/LICENSE-2.0' target='_blank'>Apache License, Version 2.0</a><br> <small>Apache Lucene.Net, Lucene.Net, Apache, the Apache feather logo, and the Apache Lucene.Net project logo are trademarks of The Apache Software Foundation. <br>All other marks mentioned may be trademarks or registered trademarks of their respective owners.</small>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.vendor.js"></script>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/docfx.js"></script>
<script type="text/javascript" src="https://lucenenet.apache.org/docs/4.8.0-beta00009/styles/main.js"></script>
</body>
</html>