blob: 5abbcc23a395db10d43688e31fad2a2a557a65eb [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.LockFactory 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_lock_factory.html">LockFactory</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#properties">Properties</a> &#124;
<a href="class_lucene_1_1_net_1_1_store_1_1_lock_factory-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Lucene.Net.Store.LockFactory Class Reference<span class="mlabels"><span class="mlabel">abstract</span></span></div> </div>
</div><!--header-->
<div class="contents">
<p>Base class for Locking implementation. <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html" title="A Directory is a flat list of files. Files may be written once, when they are created. Once a file is created it may only be opened for read, or deleted. Random access is permitted both when reading and writing.">Directory</a> uses instances of this class to implement locking.
<a href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html#details">More...</a></p>
<p>Inherited by <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_f_s_lock_factory.html">Lucene.Net.Store.FSLockFactory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_no_lock_factory.html">Lucene.Net.Store.NoLockFactory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_single_instance_lock_factory.html">Lucene.Net.Store.SingleInstanceLockFactory</a>, and <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_verifying_lock_factory.html">Lucene.Net.Store.VerifyingLockFactory</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:adee4912a3607a72e1870b10293e1ae2a"><td class="memItemLeft" align="right" valign="top">abstract <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_lock_factory.html#adee4912a3607a72e1870b10293e1ae2a">MakeLock</a> (System.String lockName)</td></tr>
<tr class="memdesc:adee4912a3607a72e1870b10293e1ae2a"><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="#adee4912a3607a72e1870b10293e1ae2a"></a><br/></td></tr>
<tr class="separator:adee4912a3607a72e1870b10293e1ae2a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:acd79abc39e5390a676f924f260a39bb4"><td class="memItemLeft" align="right" valign="top">abstract void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html#acd79abc39e5390a676f924f260a39bb4">ClearLock</a> (System.String lockName)</td></tr>
<tr class="memdesc:acd79abc39e5390a676f924f260a39bb4"><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="#acd79abc39e5390a676f924f260a39bb4"></a><br/></td></tr>
<tr class="separator:acd79abc39e5390a676f924f260a39bb4"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a6aac2302bee58d7776271f099e52a325"><td class="memItemLeft" align="right" valign="top">virtual string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock_factory.html#a6aac2302bee58d7776271f099e52a325">LockPrefix</a><code> [get, set]</code></td></tr>
<tr class="memdesc:a6aac2302bee58d7776271f099e52a325"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets or sets the prefix in use for all locks created in this <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>. This is normally called once, when a <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html" title="A Directory is a flat list of files. Files may be written once, when they are created. Once a file is created it may only be opened for read, or deleted. Random access is permitted both when reading and writing.">Directory</a> gets this <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> instance. However, you can also call this (after this instance is assigned to a <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html" title="A Directory is a flat list of files. Files may be written once, when they are created. Once a file is created it may only be opened for read, or deleted. Random access is permitted both when reading and writing.">Directory</a>) to override the prefix in use. This is helpful if you're running <a class="el" href="namespace_lucene.html">Lucene</a> on machines that have different mount points for the same shared directory. <a href="#a6aac2302bee58d7776271f099e52a325"></a><br/></td></tr>
<tr class="separator:a6aac2302bee58d7776271f099e52a325"><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>Base class for Locking implementation. <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html" title="A Directory is a flat list of files. Files may be written once, when they are created. Once a file is created it may only be opened for read, or deleted. Random access is permitted both when reading and writing.">Directory</a> uses instances of this class to implement locking.</p>
<p>Note that there are some useful tools to verify that your <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 working correctly: <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_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>, <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> .</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_verify_server.html" title="Simple standalone server that must be running when you use VerifyingLockFactory. This server simply v...">LockVerifyServer</a></dd></dl>
<dl class="section see"><dt>See Also</dt><dd><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></dd></dl>
<dl class="section see"><dt>See Also</dt><dd><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></dd></dl>
<p>Definition at line <a class="el" href="_lock_factory_8cs_source.html#l00039">39</a> of file <a class="el" href="_lock_factory_8cs_source.html">LockFactory.cs</a>.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="acd79abc39e5390a676f924f260a39bb4"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract void Lucene.Net.Store.LockFactory.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">pure 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>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_verifying_lock_factory.html#a8b0c8792f8e19b727426c5a8a8c1d780">Lucene.Net.Store.VerifyingLockFactory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_native_f_s_lock_factory.html#ae49738eae7189d2418d6087b2ebc091e">Lucene.Net.Store.NativeFSLockFactory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_simple_f_s_lock_factory.html#a6d67d70ff8dd902df264d858bf2d8959">Lucene.Net.Store.SimpleFSLockFactory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_no_lock_factory.html#a74c01796a70a35f7621929aae401306a">Lucene.Net.Store.NoLockFactory</a>, and <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_single_instance_lock_factory.html#aa826a7cc894793521a3302f52412b3df">Lucene.Net.Store.SingleInstanceLockFactory</a>.</p>
</div>
</div>
<a class="anchor" id="adee4912a3607a72e1870b10293e1ae2a"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">abstract <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_lock.html">Lock</a> Lucene.Net.Store.LockFactory.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">pure 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>Implemented in <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_verifying_lock_factory.html#ab678bee0a49ab6490598b0be12b8d1df">Lucene.Net.Store.VerifyingLockFactory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_native_f_s_lock_factory.html#a30a7c94a5c2468f881cbb790afcc1e17">Lucene.Net.Store.NativeFSLockFactory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_simple_f_s_lock_factory.html#a5a5cc49b167756360b8d2aaf2dffd499">Lucene.Net.Store.SimpleFSLockFactory</a>, <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_no_lock_factory.html#a663f7d1969725e53b1f8ff11085880dc">Lucene.Net.Store.NoLockFactory</a>, and <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_single_instance_lock_factory.html#a2bc292c494d001c9a83dd5f5f9c19d91">Lucene.Net.Store.SingleInstanceLockFactory</a>.</p>
</div>
</div>
<h2 class="groupheader">Property Documentation</h2>
<a class="anchor" id="a6aac2302bee58d7776271f099e52a325"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual string Lucene.Net.Store.LockFactory.LockPrefix</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets or sets the prefix in use for all locks created in this <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>. This is normally called once, when a <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html" title="A Directory is a flat list of files. Files may be written once, when they are created. Once a file is created it may only be opened for read, or deleted. Random access is permitted both when reading and writing.">Directory</a> gets this <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> instance. However, you can also call this (after this instance is assigned to a <a class="el" href="class_lucene_1_1_net_1_1_store_1_1_directory.html" title="A Directory is a flat list of files. Files may be written once, when they are created. Once a file is created it may only be opened for read, or deleted. Random access is permitted both when reading and writing.">Directory</a>) to override the prefix in use. This is helpful if you're running <a class="el" href="namespace_lucene.html">Lucene</a> on machines that have different mount points for the same shared directory. </p>
<p>Definition at line <a class="el" href="_lock_factory_8cs_source.html#l00053">53</a> of file <a class="el" href="_lock_factory_8cs_source.html">LockFactory.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="_lock_factory_8cs_source.html">LockFactory.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>