| <!DOCTYPE html> |
| <!--[if IE]><![endif]--> |
| <html> |
| |
| <head> |
| <meta charset="utf-8"> |
| <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1"> |
| <title>Class NativeFSLockFactory |
| | Apache Lucene.NET 4.8.0-beta00013 Documentation </title> |
| <meta name="viewport" content="width=device-width"> |
| <meta name="title" content="Class NativeFSLockFactory |
| | 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.NativeFSLockFactory"> |
| |
| |
| <h1 id="Lucene_Net_Store_NativeFSLockFactory" data-uid="Lucene.Net.Store.NativeFSLockFactory" class="text-break">Class NativeFSLockFactory |
| </h1> |
| <div class="markdown level0 summary"><p>Implements <a class="xref" href="Lucene.Net.Store.LockFactory.html">LockFactory</a> using native OS file |
| locks. For NFS based access to an index, it's |
| recommended that you try <a class="xref" href="Lucene.Net.Store.SimpleFSLockFactory.html">SimpleFSLockFactory</a> |
| first and work around the one limitation that a lock file |
| could be left when the runtime exits abnormally.</p> |
| |
| <p>The primary benefit of <a class="xref" href="Lucene.Net.Store.NativeFSLockFactory.html">NativeFSLockFactory</a> is |
| that locks (not the lock file itsself) will be properly |
| removed (by the OS) if the runtime has an abnormal exit.</p> |
| |
| <p>Note that, unlike <a class="xref" href="Lucene.Net.Store.SimpleFSLockFactory.html">SimpleFSLockFactory</a>, the existence of |
| leftover lock files in the filesystem is fine because the OS |
| will free the locks held against these files even though the |
| files still remain. Lucene will never actively remove the lock |
| files, so although you see them, the index may not be locked.</p> |
| |
| <p>Special care needs to be taken if you change the locking |
| implementation: First be certain that no writer is in fact |
| writing to the index otherwise you can easily corrupt |
| your index. Be sure to do the <a class="xref" href="Lucene.Net.Store.LockFactory.html">LockFactory</a> change on all Lucene |
| instances and clean up all leftover lock files before starting |
| the new configuration for the first time. Different implementations |
| can not work together!</p> |
| |
| <p>If you suspect that this or any other <a class="xref" href="Lucene.Net.Store.LockFactory.html">LockFactory</a> is |
| not working properly in your environment, you can easily |
| test it by using <a class="xref" href="Lucene.Net.Store.VerifyingLockFactory.html">VerifyingLockFactory</a>, |
| <a class="xref" href="Lucene.Net.Store.LockVerifyServer.html">LockVerifyServer</a> and <a class="xref" href="Lucene.Net.Store.LockStressTest.html">LockStressTest</a>.</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"><a class="xref" href="Lucene.Net.Store.LockFactory.html">LockFactory</a></div> |
| <div class="level2"><a class="xref" href="Lucene.Net.Store.FSLockFactory.html">FSLockFactory</a></div> |
| <div class="level3"><span class="xref">NativeFSLockFactory</span></div> |
| </div> |
| <div class="inheritedMembers"> |
| <h5>Inherited Members</h5> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.FSLockFactory.html#Lucene_Net_Store_FSLockFactory_m_lockDir">FSLockFactory.m_lockDir</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.FSLockFactory.html#Lucene_Net_Store_FSLockFactory_SetLockDir_System_IO_DirectoryInfo_">FSLockFactory.SetLockDir(DirectoryInfo)</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.FSLockFactory.html#Lucene_Net_Store_FSLockFactory_LockDir">FSLockFactory.LockDir</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.FSLockFactory.html#Lucene_Net_Store_FSLockFactory_ToString">FSLockFactory.ToString()</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.LockFactory.html#Lucene_Net_Store_LockFactory_m_lockPrefix">LockFactory.m_lockPrefix</a> |
| </div> |
| <div> |
| <a class="xref" href="Lucene.Net.Store.LockFactory.html#Lucene_Net_Store_LockFactory_LockPrefix">LockFactory.LockPrefix</a> |
| </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.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> |
| <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_NativeFSLockFactory_syntax">Syntax</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public class NativeFSLockFactory : FSLockFactory</code></pre> |
| </div> |
| <h3 id="constructors">Constructors |
| </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_NativeFSLockFactory__ctor.md&value=---%0Auid%3A%20Lucene.Net.Store.NativeFSLockFactory.%23ctor%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/NativeFSLockFactory.cs/#L151">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_NativeFSLockFactory__ctor_" data-uid="Lucene.Net.Store.NativeFSLockFactory.#ctor*"></a> |
| <h4 id="Lucene_Net_Store_NativeFSLockFactory__ctor" data-uid="Lucene.Net.Store.NativeFSLockFactory.#ctor">NativeFSLockFactory()</h4> |
| <div class="markdown level1 summary"><p>Create a <a class="xref" href="Lucene.Net.Store.NativeFSLockFactory.html">NativeFSLockFactory</a> instance, with <code>null</code> (unset) |
| lock directory. When you pass this factory to a <a class="xref" href="Lucene.Net.Store.FSDirectory.html">FSDirectory</a> |
| subclass, the lock directory is automatically set to the |
| directory itself. Be sure to create one instance for each directory |
| your create!</p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public NativeFSLockFactory()</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_NativeFSLockFactory__ctor_System_IO_DirectoryInfo_.md&value=---%0Auid%3A%20Lucene.Net.Store.NativeFSLockFactory.%23ctor(System.IO.DirectoryInfo)%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/NativeFSLockFactory.cs/#L171">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_NativeFSLockFactory__ctor_" data-uid="Lucene.Net.Store.NativeFSLockFactory.#ctor*"></a> |
| <h4 id="Lucene_Net_Store_NativeFSLockFactory__ctor_System_IO_DirectoryInfo_" data-uid="Lucene.Net.Store.NativeFSLockFactory.#ctor(System.IO.DirectoryInfo)">NativeFSLockFactory(DirectoryInfo)</h4> |
| <div class="markdown level1 summary"><p>Create a <a class="xref" href="Lucene.Net.Store.NativeFSLockFactory.html">NativeFSLockFactory</a> instance, storing lock |
| files into the specified <code data-dev-comment-type="paramref" class="paramref">lockDir</code></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public NativeFSLockFactory(DirectoryInfo lockDir)</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.IO.DirectoryInfo</span></td> |
| <td><span class="parametername">lockDir</span></td> |
| <td><p>where lock files are created. </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_NativeFSLockFactory__ctor_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Store.NativeFSLockFactory.%23ctor(System.String)%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/NativeFSLockFactory.cs/#L161">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_NativeFSLockFactory__ctor_" data-uid="Lucene.Net.Store.NativeFSLockFactory.#ctor*"></a> |
| <h4 id="Lucene_Net_Store_NativeFSLockFactory__ctor_System_String_" data-uid="Lucene.Net.Store.NativeFSLockFactory.#ctor(System.String)">NativeFSLockFactory(String)</h4> |
| <div class="markdown level1 summary"><p>Create a <a class="xref" href="Lucene.Net.Store.NativeFSLockFactory.html">NativeFSLockFactory</a> instance, storing lock |
| files into the specified <code data-dev-comment-type="paramref" class="paramref">lockDirName</code></p> |
| </div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public NativeFSLockFactory(string lockDirName)</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">lockDirName</span></td> |
| <td><p>where lock files are created. </p> |
| </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_NativeFSLockFactory_ClearLock_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Store.NativeFSLockFactory.ClearLock(System.String)%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/NativeFSLockFactory.cs/#L219">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_NativeFSLockFactory_ClearLock_" data-uid="Lucene.Net.Store.NativeFSLockFactory.ClearLock*"></a> |
| <h4 id="Lucene_Net_Store_NativeFSLockFactory_ClearLock_System_String_" data-uid="Lucene.Net.Store.NativeFSLockFactory.ClearLock(System.String)">ClearLock(String)</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override void ClearLock(string lockName)</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">lockName</span></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Store.LockFactory.html#Lucene_Net_Store_LockFactory_ClearLock_System_String_">LockFactory.ClearLock(String)</a></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_NativeFSLockFactory_MakeLock_System_String_.md&value=---%0Auid%3A%20Lucene.Net.Store.NativeFSLockFactory.MakeLock(System.String)%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/NativeFSLockFactory.cs/#L194">View Source</a> |
| </span> |
| <a id="Lucene_Net_Store_NativeFSLockFactory_MakeLock_" data-uid="Lucene.Net.Store.NativeFSLockFactory.MakeLock*"></a> |
| <h4 id="Lucene_Net_Store_NativeFSLockFactory_MakeLock_System_String_" data-uid="Lucene.Net.Store.NativeFSLockFactory.MakeLock(System.String)">MakeLock(String)</h4> |
| <div class="markdown level1 summary"></div> |
| <div class="markdown level1 conceptual"></div> |
| <h5 class="decalaration">Declaration</h5> |
| <div class="codewrapper"> |
| <pre><code class="lang-csharp hljs">public override Lock MakeLock(string lockName)</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">lockName</span></td> |
| <td></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.html">Lock</a></td> |
| <td></td> |
| </tr> |
| </tbody> |
| </table> |
| <h5 class="overrides">Overrides</h5> |
| <div><a class="xref" href="Lucene.Net.Store.LockFactory.html#Lucene_Net_Store_LockFactory_MakeLock_System_String_">LockFactory.MakeLock(String)</a></div> |
| <h3 id="seealso">See Also</h3> |
| <div class="seealso"> |
| <div><a class="xref" href="Lucene.Net.Store.LockFactory.html">LockFactory</a></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_NativeFSLockFactory.md&value=---%0Auid%3A%20Lucene.Net.Store.NativeFSLockFactory%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/NativeFSLockFactory.cs/#L59" 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> |
