Google Git
Sign in
apache / lucenenet-site / b7932cab2a602cd78b928b7dd2376969de9ab8e2 / . / docs / 3.0.3 / class_lucene_1_1_net_1_1_store_1_1_native_f_s_lock.html
blob: 619edb7b65fd9284b83bd5b7064bb4769d3384c4 [file] [log] [blame]
<!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.NativeFSLock 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_native_f_s_lock.html">NativeFSLock</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_native_f_s_lock-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Store.NativeFSLock Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Inherits <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html">Lucene.Net.Store.Lock</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:a368e2b84015ee8bd3e7d016a36341a2a"><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_native_f_s_lock.html#a368e2b84015ee8bd3e7d016a36341a2a">NativeFSLock</a> (System.IO.DirectoryInfo lockDir, System.String lockFileName)</td></tr>
<tr class="separator:a368e2b84015ee8bd3e7d016a36341a2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a87096d169bf683fe0c5f05461dcfca98"><td class="memItemLeft" align="right" valign="top">override bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_native_f_s_lock.html#a87096d169bf683fe0c5f05461dcfca98">Obtain</a> ()</td></tr>
<tr class="memdesc:a87096d169bf683fe0c5f05461dcfca98"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attempts to obtain exclusive access and immediately return upon success or failure. <a href="#a87096d169bf683fe0c5f05461dcfca98"></a><br/></td></tr>
<tr class="separator:a87096d169bf683fe0c5f05461dcfca98"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a88f778b807a2f62048114c05d73622e1"><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_native_f_s_lock.html#a88f778b807a2f62048114c05d73622e1">Release</a> ()</td></tr>
<tr class="memdesc:a88f778b807a2f62048114c05d73622e1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Releases exclusive access. <a href="#a88f778b807a2f62048114c05d73622e1"></a><br/></td></tr>
<tr class="separator:a88f778b807a2f62048114c05d73622e1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ab39e9e62aa78143eaa220d7ee0add8"><td class="memItemLeft" align="right" valign="top">override bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_native_f_s_lock.html#a1ab39e9e62aa78143eaa220d7ee0add8">IsLocked</a> ()</td></tr>
<tr class="memdesc:a1ab39e9e62aa78143eaa220d7ee0add8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns true if the resource is currently locked. Note that one must still call <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_native_f_s_lock.html#a87096d169bf683fe0c5f05461dcfca98" title="Attempts to obtain exclusive access and immediately return upon success or failure. ">Obtain()</a> before using the resource. <a href="#a1ab39e9e62aa78143eaa220d7ee0add8"></a><br/></td></tr>
<tr class="separator:a1ab39e9e62aa78143eaa220d7ee0add8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af869f1a919b48f02657ef2dedf1181fe"><td class="memItemLeft" align="right" valign="top">override System.String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_native_f_s_lock.html#af869f1a919b48f02657ef2dedf1181fe">ToString</a> ()</td></tr>
<tr class="separator:af869f1a919b48f02657ef2dedf1181fe"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_methods_class_lucene_1_1_net_1_1_store_1_1_lock"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_class_lucene_1_1_net_1_1_store_1_1_lock')"><img src="closed.png" alt="-"/>&#160;Public Member Functions inherited from <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html">Lucene.Net.Store.Lock</a></td></tr>
<tr class="memitem:a133e487543668f0b1fd3286558a7ce87 inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_lock"><td class="memItemLeft" align="right" valign="top">virtual bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html#a133e487543668f0b1fd3286558a7ce87">Obtain</a> (long lockWaitTimeout)</td></tr>
<tr class="memdesc:a133e487543668f0b1fd3286558a7ce87 inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_lock"><td class="mdescLeft">&#160;</td><td class="mdescRight">Attempts to obtain an exclusive lock within amount of time given. Polls once per <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html#a3e4d434af902a339175f3b8fc284d0d6" title="How long Obtain(long) waits, in milliseconds, in between attempts to acquire the lock. ">LOCK_POLL_INTERVAL</a> (currently 1000) milliseconds until lockWaitTimeout is passed. <a href="#a133e487543668f0b1fd3286558a7ce87"></a><br/></td></tr>
<tr class="separator:a133e487543668f0b1fd3286558a7ce87 inherit pub_methods_class_lucene_1_1_net_1_1_store_1_1_lock"><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 pub_attribs_class_lucene_1_1_net_1_1_store_1_1_lock"><td colspan="2" onclick="javascript:toggleInherit('pub_attribs_class_lucene_1_1_net_1_1_store_1_1_lock')"><img src="closed.png" alt="-"/>&#160;Public Attributes inherited from <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html">Lucene.Net.Store.Lock</a></td></tr>
<tr class="memitem:ad2debe29cb2bcf3302089d5348b4b1bb inherit pub_attribs_class_lucene_1_1_net_1_1_store_1_1_lock"><td class="memItemLeft" align="right" valign="top">const long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html#ad2debe29cb2bcf3302089d5348b4b1bb">LOCK_OBTAIN_WAIT_FOREVER</a> = - 1</td></tr>
<tr class="memdesc:ad2debe29cb2bcf3302089d5348b4b1bb inherit pub_attribs_class_lucene_1_1_net_1_1_store_1_1_lock"><td class="mdescLeft">&#160;</td><td class="mdescRight">Pass this value to <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html#a133e487543668f0b1fd3286558a7ce87" title="Attempts to obtain an exclusive lock within amount of time given. Polls once per LOCK_POLL_INTERVAL (...">Obtain(long)</a> to try forever to obtain the lock. <a href="#ad2debe29cb2bcf3302089d5348b4b1bb"></a><br/></td></tr>
<tr class="separator:ad2debe29cb2bcf3302089d5348b4b1bb inherit pub_attribs_class_lucene_1_1_net_1_1_store_1_1_lock"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="inherit_header pub_static_attribs_class_lucene_1_1_net_1_1_store_1_1_lock"><td colspan="2" onclick="javascript:toggleInherit('pub_static_attribs_class_lucene_1_1_net_1_1_store_1_1_lock')"><img src="closed.png" alt="-"/>&#160;Static Public Attributes inherited from <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html">Lucene.Net.Store.Lock</a></td></tr>
<tr class="memitem:a3e4d434af902a339175f3b8fc284d0d6 inherit pub_static_attribs_class_lucene_1_1_net_1_1_store_1_1_lock"><td class="memItemLeft" align="right" valign="top">static long&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html#a3e4d434af902a339175f3b8fc284d0d6">LOCK_POLL_INTERVAL</a> = 1000</td></tr>
<tr class="memdesc:a3e4d434af902a339175f3b8fc284d0d6 inherit pub_static_attribs_class_lucene_1_1_net_1_1_store_1_1_lock"><td class="mdescLeft">&#160;</td><td class="mdescRight">How long <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html#a133e487543668f0b1fd3286558a7ce87" title="Attempts to obtain an exclusive lock within amount of time given. Polls once per LOCK_POLL_INTERVAL (...">Obtain(long)</a> waits, in milliseconds, in between attempts to acquire the lock. <a href="#a3e4d434af902a339175f3b8fc284d0d6"></a><br/></td></tr>
<tr class="separator:a3e4d434af902a339175f3b8fc284d0d6 inherit pub_static_attribs_class_lucene_1_1_net_1_1_store_1_1_lock"><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>Definition at line <a class="el" href="_native_f_s_lock_factory_8cs_source.html#l00142">142</a> of file <a class="el" href="_native_f_s_lock_factory_8cs_source.html">NativeFSLockFactory.cs</a>.</p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a368e2b84015ee8bd3e7d016a36341a2a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Lucene.Net.Store.NativeFSLock.NativeFSLock </td>
<td>(</td>
<td class="paramtype">System.IO.DirectoryInfo&#160;</td>
<td class="paramname"><em>lockDir</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">System.String&#160;</td>
<td class="paramname"><em>lockFileName</em>&#160;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_native_f_s_lock_factory_8cs_source.html#l00163">163</a> of file <a class="el" href="_native_f_s_lock_factory_8cs_source.html">NativeFSLockFactory.cs</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a1ab39e9e62aa78143eaa220d7ee0add8"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override bool Lucene.Net.Store.NativeFSLock.IsLocked </td>
<td>(</td>
<td class="paramname"></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>Returns true if the resource is currently locked. Note that one must still call <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_native_f_s_lock.html#a87096d169bf683fe0c5f05461dcfca98" title="Attempts to obtain exclusive access and immediately return upon success or failure. ">Obtain()</a> before using the resource. </p>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html#a2daac6fde839e5b7434217fd65ff4163">Lucene.Net.Store.Lock</a>.</p>
<p>Definition at line <a class="el" href="_native_f_s_lock_factory_8cs_source.html#l00401">401</a> of file <a class="el" href="_native_f_s_lock_factory_8cs_source.html">NativeFSLockFactory.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a87096d169bf683fe0c5f05461dcfca98"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">override bool Lucene.Net.Store.NativeFSLock.Obtain </td>
<td>(</td>
<td class="paramname"></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>Attempts to obtain exclusive access and immediately return upon success or failure. </p>
<dl class="section return"><dt>Returns</dt><dd>true iff exclusive access is obtained </dd></dl>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html#a0b895959e967f632a7b7e87b3b3427d7">Lucene.Net.Store.Lock</a>.</p>
<p>Definition at line <a class="el" href="_native_f_s_lock_factory_8cs_source.html#l00177">177</a> of file <a class="el" href="_native_f_s_lock_factory_8cs_source.html">NativeFSLockFactory.cs</a>.</p>
</div>
</div>
<a class="anchor" id="a88f778b807a2f62048114c05d73622e1"></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.NativeFSLock.Release </td>
<td>(</td>
<td class="paramname"></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>Releases exclusive access. </p>
<p>Implements <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html#a78a4491bfe115f88938284904b6c9c17">Lucene.Net.Store.Lock</a>.</p>
<p>Definition at line <a class="el" href="_native_f_s_lock_factory_8cs_source.html#l00348">348</a> of file <a class="el" href="_native_f_s_lock_factory_8cs_source.html">NativeFSLockFactory.cs</a>.</p>
</div>
</div>
<a class="anchor" id="af869f1a919b48f02657ef2dedf1181fe"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">override System.String Lucene.Net.Store.NativeFSLock.ToString </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition at line <a class="el" href="_native_f_s_lock_factory_8cs_source.html#l00435">435</a> of file <a class="el" href="_native_f_s_lock_factory_8cs_source.html">NativeFSLockFactory.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="_native_f_s_lock_factory_8cs_source.html">NativeFSLockFactory.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>