docs/3.0.3/class_lucene_1_1_net_1_1_store_1_1_simple_f_s_lock_factory.html - lucenenet-site - Git at Google

 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
 <html xmlns="http://www.w3.org/1999/xhtml">
 <head>
 <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
 <meta http-equiv="X-UA-Compatible" content="IE=9"/>
 <meta name="generator" content="Doxygen 1.8.3"/>
 <title>Lucene.Net: Lucene.Net.Store.SimpleFSLockFactory Class Reference</title>
 <link href="tabs.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="jquery.js"></script>
 <script type="text/javascript" src="dynsections.js"></script>
 <link href="search/search.css" rel="stylesheet" type="text/css"/>
 <script type="text/javascript" src="search/search.js"></script>
 <script type="text/javascript">
   $(document).ready(function() { searchBox.OnSelectItem(0); });
 </script>
 <link href="doxygen.css" rel="stylesheet" type="text/css" />
 </head>
 <body>
 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
 <div id="titlearea">
 <table cellspacing="0" cellpadding="0">
  <tbody>
  <tr style="height: 56px;">
   <td id="projectlogo"><img alt="Logo" src="lucene-net-icon-128x128.png"/></td>
   <td style="padding-left: 0.5em;">
    <div id="projectname">Lucene.Net
    &#160;<span id="projectnumber">3.0.3</span>
    </div>
    <div id="projectbrief">Lucene.Net is a .NET port of the Java Lucene Indexing Library</div>
   </td>
  </tr>
  </tbody>
 </table>
 </div>
 <!-- end header part -->
 <!-- Generated by Doxygen 1.8.3 -->
 <script type="text/javascript">
 var searchBox = new SearchBox("searchBox", "search",false,'Search');
 </script>
   <div id="navrow1" class="tabs">
     <ul class="tablist">
       <li><a href="Index.html"><span>Main&#160;Page</span></a></li>
       <li><a href="namespaces.html"><span>Packages</span></a></li>
       <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
       <li><a href="files.html"><span>Files</span></a></li>
       <li>
         <div id="MSearchBox" class="MSearchBoxInactive">
         <span class="left">
           <img id="MSearchSelect" src="search/mag_sel.png"
                onmouseover="return searchBox.OnSearchSelectShow()"
                onmouseout="return searchBox.OnSearchSelectHide()"
                alt=""/>
           <input type="text" id="MSearchField" value="Search" accesskey="S"
                onfocus="searchBox.OnSearchFieldFocus(true)"
                onblur="searchBox.OnSearchFieldFocus(false)"
                onkeyup="searchBox.OnSearchFieldChange(event)"/>
           </span><span class="right">
             <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
           </span>
         </div>
       </li>
     </ul>
   </div>
   <div id="navrow2" class="tabs2">
     <ul class="tablist">
       <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
       <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
       <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
       <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
     </ul>
   </div>
 <!-- window showing the filter options -->
 <div id="MSearchSelectWindow"
      onmouseover="return searchBox.OnSearchSelectShow()"
      onmouseout="return searchBox.OnSearchSelectHide()"
      onkeydown="return searchBox.OnSearchSelectKey(event)">
 <a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark">&#160;</span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark">&#160;</span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark">&#160;</span>Properties</a></div>

 <!-- iframe showing the search results (closed by default) -->
 <div id="MSearchResultsWindow">
 <iframe src="javascript:void(0)" frameborder="0"
         name="MSearchResults" id="MSearchResults">
 </iframe>
 </div>

 <div id="nav-path" class="navpath">
   <ul>
 <li class="navelem"><a class="el" href="namespace_lucene.html">Lucene</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net.html">Net</a></li><li class="navelem"><a class="el" href="namespace_lucene_1_1_net_1_1_store.html">Store</a></li><li class="navelem"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_simple_f_s_lock_factory.html">SimpleFSLockFactory</a></li>  </ul>
 </div>
 </div><!-- top -->
 <div class="header">
   <div class="summary">
 <a href="#pub-methods">Public Member Functions</a> &#124;
 <a href="class_lucene_1_1_net_1_1_store_1_1_simple_f_s_lock_factory-members.html">List of all members</a>  </div>
   <div class="headertitle">
 <div class="title">Lucene.Net.Store.SimpleFSLockFactory Class Reference</div>  </div>
 </div><!--header-->
 <div class="contents">

 <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html" title="Base class for Locking implementation. Directory uses instances of this class to implement locking...">LockFactory</a> using System.IO.FileInfo.Create() .
  <a href="class_lucene_1_1_net_1_1_store_1_1_simple_f_s_lock_factory.html#details">More...</a></p>

 <p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_lock_factory.html">Lucene.Net.Store.FSLockFactory</a>.</p>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 Public Member Functions</h2></td></tr>
 <tr class="memitem:a9f1d65589c98fb06eb65602b426a09cc"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_simple_f_s_lock_factory.html#a9f1d65589c98fb06eb65602b426a09cc">SimpleFSLockFactory</a> ()</td></tr>
 <tr class="memdesc:a9f1d65589c98fb06eb65602b426a09cc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Create a <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_simple_f_s_lock_factory.html" title="Implements LockFactory using System.IO.FileInfo.Create() .">SimpleFSLockFactory</a> instance, with null (unset) lock directory. When you pass this factory to a <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html" title=" Base class for Directory implementations that store index files in the file system. There are currently three core subclasses:">FSDirectory</a> subclass, the lock directory is automatically set to the directory itsself. Be sure to create one instance for each directory your create!  <a href="#a9f1d65589c98fb06eb65602b426a09cc"></a><br/></td></tr>
 <tr class="separator:a9f1d65589c98fb06eb65602b426a09cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:abf4f1178bce1f8d054808a0cd6166c28"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_simple_f_s_lock_factory.html#abf4f1178bce1f8d054808a0cd6166c28">SimpleFSLockFactory</a> (System.IO.DirectoryInfo lockDir)</td></tr>
 <tr class="memdesc:abf4f1178bce1f8d054808a0cd6166c28"><td class="mdescLeft">&#160;</td><td class="mdescRight">Instantiate using the provided directory (as a File instance). <a href="#abf4f1178bce1f8d054808a0cd6166c28"></a><br/></td></tr>
 <tr class="separator:abf4f1178bce1f8d054808a0cd6166c28"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a51ba6f7dbe488569e3864b457f30f21c"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_simple_f_s_lock_factory.html#a51ba6f7dbe488569e3864b457f30f21c">SimpleFSLockFactory</a> (System.String lockDirName)</td></tr>
 <tr class="memdesc:a51ba6f7dbe488569e3864b457f30f21c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Instantiate using the provided directory name (String). <a href="#a51ba6f7dbe488569e3864b457f30f21c"></a><br/></td></tr>
 <tr class="separator:a51ba6f7dbe488569e3864b457f30f21c"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a5a5cc49b167756360b8d2aaf2dffd499"><td class="memItemLeft" align="right" valign="top">override <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html">Lock</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_simple_f_s_lock_factory.html#a5a5cc49b167756360b8d2aaf2dffd499">MakeLock</a> (System.String lockName)</td></tr>
 <tr class="memdesc:a5a5cc49b167756360b8d2aaf2dffd499"><td class="mdescLeft">&#160;</td><td class="mdescRight">Return a new <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html" title="An interprocess mutex lock. Typical use might look like:">Lock</a> instance identified by lockName. <a href="#a5a5cc49b167756360b8d2aaf2dffd499"></a><br/></td></tr>
 <tr class="separator:a5a5cc49b167756360b8d2aaf2dffd499"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a6d67d70ff8dd902df264d858bf2d8959"><td class="memItemLeft" align="right" valign="top">override void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_simple_f_s_lock_factory.html#a6d67d70ff8dd902df264d858bf2d8959">ClearLock</a> (System.String lockName)</td></tr>
 <tr class="memdesc:a6d67d70ff8dd902df264d858bf2d8959"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attempt to clear (forcefully unlock and remove) the specified lock. Only call this at a time when you are certain this lock is no longer in use.  <a href="#a6d67d70ff8dd902df264d858bf2d8959"></a><br/></td></tr>
 <tr class="separator:a6d67d70ff8dd902df264d858bf2d8959"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
 Additional Inherited Members</h2></td></tr>
 <tr class="inherit_header properties_class_lucene_1_1_net_1_1_store_1_1_f_s_lock_factory"><td colspan="2" onclick="javascript:toggleInherit('properties_class_lucene_1_1_net_1_1_store_1_1_f_s_lock_factory')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_lock_factory.html">Lucene.Net.Store.FSLockFactory</a></td></tr>
 <tr class="memitem:a04dd1c0055028cd88ddee4cfcf2a9732 inherit properties_class_lucene_1_1_net_1_1_store_1_1_f_s_lock_factory"><td class="memItemLeft" align="right" valign="top">virtual DirectoryInfo&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_lock_factory.html#a04dd1c0055028cd88ddee4cfcf2a9732">LockDir</a><code> [get, set]</code></td></tr>
 <tr class="memdesc:a04dd1c0055028cd88ddee4cfcf2a9732 inherit properties_class_lucene_1_1_net_1_1_store_1_1_f_s_lock_factory"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the lock directory.  <a href="#a04dd1c0055028cd88ddee4cfcf2a9732"></a><br/></td></tr>
 <tr class="separator:a04dd1c0055028cd88ddee4cfcf2a9732 inherit properties_class_lucene_1_1_net_1_1_store_1_1_f_s_lock_factory"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
 <div class="textblock"><p>Implements <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html" title="Base class for Locking implementation. Directory uses instances of this class to implement locking...">LockFactory</a> using System.IO.FileInfo.Create() .</p>
 <p><b>NOTE:</b> the <a href="http://java.sun.com/j2se/1.4.2/docs/api/java/io/File.html#createNewFile()" target="_top">javadocs for <code>File.createNewFile</code></a> contain a vague yet spooky warning about not using the API for file locking. This warning was added due to <a href="http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=4676183" target="_top">this bug</a>, and in fact the only known problem with using this API for locking is that the <a class="el" href="namespace_lucene.html">Lucene</a> write lock may not be released when the JVM exits abnormally.</p>
 <p>When this happens, a <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_obtain_failed_exception.html" title="This exception is thrown when the write.lock could not be acquired. This happens when a writer tries ...">LockObtainFailedException</a> is hit when trying to create a writer, in which case you need to explicitly clear the lock file first. You can either manually remove the file, or use the <a class="el" href="class_lucene_1_1_net_1_1_index_1_1_index_writer.html#acee14d6d2f1a94a7e67e0cdc58ff373d" title="Forcibly unlocks the index in the named directory. Caution: this should only be used by failure recov...">Lucene.Net.Index.IndexWriter.Unlock(Directory)</a> API. But, first be certain that no writer is in fact writing to the index otherwise you can easily corrupt your index.</p>
 <p>If you suspect that this or any other <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html" title="Base class for Locking implementation. Directory uses instances of this class to implement locking...">LockFactory</a> is not working properly in your environment, you can easily test it by using <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_verifying_lock_factory.html" title="A LockFactory that wraps another LockFactory and verifies that each lock obtain/release is &quot;correct&quot; ...">VerifyingLockFactory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_verify_server.html" title="Simple standalone server that must be running when you use VerifyingLockFactory. This server simply v...">LockVerifyServer</a> and <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_stress_test.html" title="Simple standalone tool that forever acquires &amp; releases a lock using a specific LockFactory. Run without any args to see usage.">LockStressTest</a>.</p>
 <dl class="section see"><dt>See Also</dt><dd><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html" title="Base class for Locking implementation. Directory uses instances of this class to implement locking...">LockFactory</a></dd></dl>

 <p>Definition at line <a class="el" href="_simple_f_s_lock_factory_8cs_source.html#l00053">53</a> of file <a class="el" href="_simple_f_s_lock_factory_8cs_source.html">SimpleFSLockFactory.cs</a>.</p>
 </div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
 <a class="anchor" id="a9f1d65589c98fb06eb65602b426a09cc"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">Lucene.Net.Store.SimpleFSLockFactory.SimpleFSLockFactory </td>
           <td>(</td>
           <td class="paramname"></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Create a <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_simple_f_s_lock_factory.html" title="Implements LockFactory using System.IO.FileInfo.Create() .">SimpleFSLockFactory</a> instance, with null (unset) lock directory. When you pass this factory to a <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_directory.html" title=" Base class for Directory implementations that store index files in the file system. There are currently three core subclasses:">FSDirectory</a> subclass, the lock directory is automatically set to the directory itsself. Be sure to create one instance for each directory your create! </p>

 <p>Definition at line <a class="el" href="_simple_f_s_lock_factory_8cs_source.html#l00062">62</a> of file <a class="el" href="_simple_f_s_lock_factory_8cs_source.html">SimpleFSLockFactory.cs</a>.</p>

 </div>
 </div>
 <a class="anchor" id="abf4f1178bce1f8d054808a0cd6166c28"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">Lucene.Net.Store.SimpleFSLockFactory.SimpleFSLockFactory </td>
           <td>(</td>
           <td class="paramtype">System.IO.DirectoryInfo&#160;</td>
           <td class="paramname"><em>lockDir</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Instantiate using the provided directory (as a File instance).</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">lockDir</td><td>where lock files should be created. </td></tr>
   </table>
   </dd>
 </dl>

 <p>Definition at line <a class="el" href="_simple_f_s_lock_factory_8cs_source.html#l00069">69</a> of file <a class="el" href="_simple_f_s_lock_factory_8cs_source.html">SimpleFSLockFactory.cs</a>.</p>

 </div>
 </div>
 <a class="anchor" id="a51ba6f7dbe488569e3864b457f30f21c"></a>
 <div class="memitem">
 <div class="memproto">
       <table class="memname">
         <tr>
           <td class="memname">Lucene.Net.Store.SimpleFSLockFactory.SimpleFSLockFactory </td>
           <td>(</td>
           <td class="paramtype">System.String&#160;</td>
           <td class="paramname"><em>lockDirName</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
 </div><div class="memdoc">

 <p>Instantiate using the provided directory name (String).</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">lockDirName</td><td>where lock files should be created. </td></tr>
   </table>
   </dd>
 </dl>

 <p>Definition at line <a class="el" href="_simple_f_s_lock_factory_8cs_source.html#l00077">77</a> of file <a class="el" href="_simple_f_s_lock_factory_8cs_source.html">SimpleFSLockFactory.cs</a>.</p>

 </div>
 </div>
 <h2 class="groupheader">Member Function Documentation</h2>
 <a class="anchor" id="a6d67d70ff8dd902df264d858bf2d8959"></a>
 <div class="memitem">
 <div class="memproto">
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
           <td class="memname">override void Lucene.Net.Store.SimpleFSLockFactory.ClearLock </td>
           <td>(</td>
           <td class="paramtype">System.String&#160;</td>
           <td class="paramname"><em>lockName</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
   </td>
   <td class="mlabels-right">
 <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">

 <p>Attempt to clear (forcefully unlock and remove) the specified lock. Only call this at a time when you are certain this lock is no longer in use. </p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">lockName</td><td>name of the lock to be cleared. </td></tr>
   </table>
   </dd>
 </dl>

 <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html#acd79abc39e5390a676f924f260a39bb4">Lucene.Net.Store.LockFactory</a>.</p>

 <p>Definition at line <a class="el" href="_simple_f_s_lock_factory_8cs_source.html#l00091">91</a> of file <a class="el" href="_simple_f_s_lock_factory_8cs_source.html">SimpleFSLockFactory.cs</a>.</p>

 </div>
 </div>
 <a class="anchor" id="a5a5cc49b167756360b8d2aaf2dffd499"></a>
 <div class="memitem">
 <div class="memproto">
 <table class="mlabels">
   <tr>
   <td class="mlabels-left">
       <table class="memname">
         <tr>
           <td class="memname">override <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html">Lock</a> Lucene.Net.Store.SimpleFSLockFactory.MakeLock </td>
           <td>(</td>
           <td class="paramtype">System.String&#160;</td>
           <td class="paramname"><em>lockName</em></td><td>)</td>
           <td></td>
         </tr>
       </table>
   </td>
   <td class="mlabels-right">
 <span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
   </tr>
 </table>
 </div><div class="memdoc">

 <p>Return a new <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html" title="An interprocess mutex lock. Typical use might look like:">Lock</a> instance identified by lockName.</p>
 <dl class="params"><dt>Parameters</dt><dd>
   <table class="params">
     <tr><td class="paramname">lockName</td><td>name of the lock to be created. </td></tr>
   </table>
   </dd>
 </dl>

 <p>Implements <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html#adee4912a3607a72e1870b10293e1ae2a">Lucene.Net.Store.LockFactory</a>.</p>

 <p>Definition at line <a class="el" href="_simple_f_s_lock_factory_8cs_source.html#l00082">82</a> of file <a class="el" href="_simple_f_s_lock_factory_8cs_source.html">SimpleFSLockFactory.cs</a>.</p>

 </div>
 </div>
 <hr/>The documentation for this class was generated from the following file:<ul>
 <li>core/Store/<a class="el" href="_simple_f_s_lock_factory_8cs_source.html">SimpleFSLockFactory.cs</a></li>
 </ul>
 </div><!-- contents -->
 <!-- start footer part -->
 <hr class="footer"/><address class="footer"><small>
 Generated on Thu Jan 3 2013 02:12:59 for Lucene.Net by &#160;<a href="http://www.doxygen.org/index.html">
 <img class="footer" src="doxygen.png" alt="doxygen"/>
 </a> 1.8.3
 </small></address>
 </body>
 </html>