| <!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: core/Store/Lock.cs Source File</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 |
|  <span id="projectnumber">3.0.3</span> |
| </div> |
| <div id="projectbrief">Lucene.Net is a port of the Lucene search engine library, written in C# and targeted at .NET runtime users.</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 Page</span></a></li> |
| <li><a href="../../annotated.html"><span>Classes</span></a></li> |
| <li class="current"><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="../../files.html"><span>File List</span></a></li> |
| <li><a href="../../globals.html"><span>File 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"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Typedefs</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(7)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(8)"><span class="SelectionMark"> </span>Properties</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(9)"><span class="SelectionMark"> </span>Pages</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="../../dir_1efe588324fc547683bba4a3f1bac847.html">core</a></li><li class="navelem"><a class="el" href="../../dir_0fd6a22b48ba7ca96d8c1554e5fff3e1.html">Store</a></li> </ul> |
| </div> |
| </div><!-- top --> |
| <div class="header"> |
| <div class="headertitle"> |
| <div class="title">Lock.cs</div> </div> |
| </div><!--header--> |
| <div class="contents"> |
| <a href="../../d4/d97/_lock_8cs.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* </span></div> |
| <div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * Licensed to the Apache Software Foundation (ASF) under one or more</span></div> |
| <div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * contributor license agreements. See the NOTICE file distributed with</span></div> |
| <div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * this work for additional information regarding copyright ownership.</span></div> |
| <div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * The ASF licenses this file to You under the Apache License, Version 2.0</span></div> |
| <div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * (the "License"); you may not use this file except in compliance with</span></div> |
| <div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * the License. You may obtain a copy of the License at</span></div> |
| <div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * </span></div> |
| <div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span></div> |
| <div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * </span></div> |
| <div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span></div> |
| <div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span></div> |
| <div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div> |
| <div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * See the License for the specific language governing permissions and</span></div> |
| <div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * limitations under the License.</span></div> |
| <div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> */</span></div> |
| <div class="line"><a name="l00017"></a><span class="lineno"> 17</span> </div> |
| <div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="keyword">using</span> System;</div> |
| <div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="keyword">using</span> Lucene.Net.Support;</div> |
| <div class="line"><a name="l00020"></a><span class="lineno"> 20</span> </div> |
| <div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="keyword">namespace </span>Lucene.Net.Store</div> |
| <div class="line"><a name="l00022"></a><span class="lineno"> 22</span> {</div> |
| <div class="line"><a name="l00023"></a><span class="lineno"> 23</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"> /// <summary>An interprocess mutex lock.</span></div> |
| <div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment"> /// <p/>Typical use might look like:<code></span></div> |
| <div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"> /// new Lock.With(directory.makeLock("my.lock")) {</span></div> |
| <div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"> /// public Object doBody() {</span></div> |
| <div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment"> /// <i>... code to execute while locked ...</i></span></div> |
| <div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment"> /// }</span></div> |
| <div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"> /// }.run();</span></div> |
| <div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"> /// </code></span></div> |
| <div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"> /// <seealso cref="Directory.MakeLock(String)" /></span></div> |
| <div class="line"><a name="l00034"></a><span class="lineno"><a class="code" href="../../de/dd8/class_lucene_1_1_net_1_1_store_1_1_lock.html"> 34</a></span> <span class="comment"></span> <span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keyword">class </span><a class="code" href="../../de/dd8/class_lucene_1_1_net_1_1_store_1_1_lock.html" title="An interprocess mutex lock. Typical use might look like:">Lock</a></div> |
| <div class="line"><a name="l00035"></a><span class="lineno"> 35</span>  {</div> |
| <div class="line"><a name="l00036"></a><span class="lineno"> 36</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"> /// <summary>How long <see cref="Obtain(long)" /> waits, in milliseconds,</span></div> |
| <div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> /// in between attempts to acquire the lock. </span></div> |
| <div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00040"></a><span class="lineno"><a class="code" href="../../de/dd8/class_lucene_1_1_net_1_1_store_1_1_lock.html#a3e4d434af902a339175f3b8fc284d0d6"> 40</a></span> <span class="comment"></span> <span class="keyword">public</span> <span class="keyword">static</span> <span class="keywordtype">long</span> LOCK_POLL_INTERVAL = 1000;</div> |
| <div class="line"><a name="l00041"></a><span class="lineno"> 41</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment"> /// <summary>Pass this value to <see cref="Obtain(long)" /> to try</span></div> |
| <div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"> /// forever to obtain the lock. </span></div> |
| <div class="line"><a name="l00044"></a><span class="lineno"> 44</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00045"></a><span class="lineno"><a class="code" href="../../de/dd8/class_lucene_1_1_net_1_1_store_1_1_lock.html#ad2debe29cb2bcf3302089d5348b4b1bb"> 45</a></span> <span class="comment"></span> <span class="keyword">public</span> <span class="keyword">const</span> <span class="keywordtype">long</span> LOCK_OBTAIN_WAIT_FOREVER = - 1;</div> |
| <div class="line"><a name="l00046"></a><span class="lineno"> 46</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"> /// <summary>Attempts to obtain exclusive access and immediately return</span></div> |
| <div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"> /// upon success or failure.</span></div> |
| <div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> /// <returns> true iff exclusive access is obtained</span></div> |
| <div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> /// </returns></span></div> |
| <div class="line"><a name="l00052"></a><span class="lineno"> 52</span> <span class="comment"></span> <span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keywordtype">bool</span> Obtain();</div> |
| <div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"> /// <summary> If a lock obtain called, this failureReason may be set</span></div> |
| <div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> /// with the "root cause" Exception as to why the lock was</span></div> |
| <div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> /// not obtained.</span></div> |
| <div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"></span> <span class="keyword">protected</span> <span class="keyword">internal</span> System.Exception failureReason;</div> |
| <div class="line"><a name="l00059"></a><span class="lineno"> 59</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> /// <summary>Attempts to obtain an exclusive lock within amount of</span></div> |
| <div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> /// time given. Polls once per <see cref="LOCK_POLL_INTERVAL" /></span></div> |
| <div class="line"><a name="l00062"></a><span class="lineno"> 62</span> <span class="comment"> /// (currently 1000) milliseconds until lockWaitTimeout is</span></div> |
| <div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"> /// passed.</span></div> |
| <div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> /// <param name="lockWaitTimeout">length of time to wait in</span></div> |
| <div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> /// milliseconds or <see cref="LOCK_OBTAIN_WAIT_FOREVER" /></span></div> |
| <div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> /// to retry forever</span></div> |
| <div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> /// </param></span></div> |
| <div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> /// <returns> true if lock was obtained</span></div> |
| <div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> /// </returns></span></div> |
| <div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> /// <throws> LockObtainFailedException if lock wait times out </throws></span></div> |
| <div class="line"><a name="l00072"></a><span class="lineno"> 72</span> <span class="comment"> /// <throws> IllegalArgumentException if lockWaitTimeout is </throws></span></div> |
| <div class="line"><a name="l00073"></a><span class="lineno"> 73</span> <span class="comment"> /// <summary> out of bounds</span></div> |
| <div class="line"><a name="l00074"></a><span class="lineno"> 74</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00075"></a><span class="lineno"> 75</span> <span class="comment"> /// <throws> IOException if obtain() throws IOException </throws></span></div> |
| <div class="line"><a name="l00076"></a><span class="lineno"><a class="code" href="../../de/dd8/class_lucene_1_1_net_1_1_store_1_1_lock.html#a133e487543668f0b1fd3286558a7ce87"> 76</a></span> <span class="comment"></span> <span class="keyword">public</span> <span class="keyword">virtual</span> <span class="keywordtype">bool</span> Obtain(<span class="keywordtype">long</span> lockWaitTimeout)</div> |
| <div class="line"><a name="l00077"></a><span class="lineno"> 77</span>  {</div> |
| <div class="line"><a name="l00078"></a><span class="lineno"> 78</span>  failureReason = null;</div> |
| <div class="line"><a name="l00079"></a><span class="lineno"> 79</span>  <span class="keywordtype">bool</span> locked = Obtain();</div> |
| <div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordflow">if</span> (lockWaitTimeout < 0 && lockWaitTimeout != LOCK_OBTAIN_WAIT_FOREVER)</div> |
| <div class="line"><a name="l00081"></a><span class="lineno"> 81</span>  <span class="keywordflow">throw</span> <span class="keyword">new</span> System.ArgumentException(<span class="stringliteral">"lockWaitTimeout should be LOCK_OBTAIN_WAIT_FOREVER or a non-negative number (got "</span> + lockWaitTimeout + <span class="stringliteral">")"</span>);</div> |
| <div class="line"><a name="l00082"></a><span class="lineno"> 82</span>  </div> |
| <div class="line"><a name="l00083"></a><span class="lineno"> 83</span>  <span class="keywordtype">long</span> maxSleepCount = lockWaitTimeout / LOCK_POLL_INTERVAL;</div> |
| <div class="line"><a name="l00084"></a><span class="lineno"> 84</span>  <span class="keywordtype">long</span> sleepCount = 0;</div> |
| <div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordflow">while</span> (!locked)</div> |
| <div class="line"><a name="l00086"></a><span class="lineno"> 86</span>  {</div> |
| <div class="line"><a name="l00087"></a><span class="lineno"> 87</span>  <span class="keywordflow">if</span> (lockWaitTimeout != LOCK_OBTAIN_WAIT_FOREVER && sleepCount++ >= maxSleepCount)</div> |
| <div class="line"><a name="l00088"></a><span class="lineno"> 88</span>  {</div> |
| <div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  System.String reason = <span class="stringliteral">"Lock obtain timed out: "</span> + this.ToString();</div> |
| <div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordflow">if</span> (failureReason != null)</div> |
| <div class="line"><a name="l00091"></a><span class="lineno"> 91</span>  {</div> |
| <div class="line"><a name="l00092"></a><span class="lineno"> 92</span>  reason += (<span class="stringliteral">": "</span> + failureReason);</div> |
| <div class="line"><a name="l00093"></a><span class="lineno"> 93</span>  }</div> |
| <div class="line"><a name="l00094"></a><span class="lineno"> 94</span>  var e = failureReason != null</div> |
| <div class="line"><a name="l00095"></a><span class="lineno"> 95</span>  ? <span class="keyword">new</span> <a class="code" href="../../dd/d39/_directory_reader_8cs.html#a681d344289754da86d367afaac7bd3d7">LockObtainFailedException</a>(reason, failureReason)</div> |
| <div class="line"><a name="l00096"></a><span class="lineno"> 96</span>  : <span class="keyword">new</span> <a class="code" href="../../dd/d39/_directory_reader_8cs.html#a681d344289754da86d367afaac7bd3d7">LockObtainFailedException</a>(reason);</div> |
| <div class="line"><a name="l00097"></a><span class="lineno"> 97</span>  <span class="keywordflow">throw</span> e;</div> |
| <div class="line"><a name="l00098"></a><span class="lineno"> 98</span>  }</div> |
| <div class="line"><a name="l00099"></a><span class="lineno"> 99</span>  <span class="keywordflow">try</span></div> |
| <div class="line"><a name="l00100"></a><span class="lineno"> 100</span>  {</div> |
| <div class="line"><a name="l00101"></a><span class="lineno"> 101</span>  System.Threading.Thread.Sleep(TimeSpan.FromMilliseconds(LOCK_POLL_INTERVAL));</div> |
| <div class="line"><a name="l00102"></a><span class="lineno"> 102</span>  }</div> |
| <div class="line"><a name="l00103"></a><span class="lineno"> 103</span>  <span class="keywordflow">catch</span> (System.Threading.ThreadInterruptedException)</div> |
| <div class="line"><a name="l00104"></a><span class="lineno"> 104</span>  {</div> |
| <div class="line"><a name="l00105"></a><span class="lineno"> 105</span>  <span class="keywordflow">throw</span>;</div> |
| <div class="line"><a name="l00106"></a><span class="lineno"> 106</span>  }</div> |
| <div class="line"><a name="l00107"></a><span class="lineno"> 107</span>  locked = Obtain();</div> |
| <div class="line"><a name="l00108"></a><span class="lineno"> 108</span>  }</div> |
| <div class="line"><a name="l00109"></a><span class="lineno"> 109</span>  <span class="keywordflow">return</span> locked;</div> |
| <div class="line"><a name="l00110"></a><span class="lineno"> 110</span>  }</div> |
| <div class="line"><a name="l00111"></a><span class="lineno"> 111</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00112"></a><span class="lineno"> 112</span> <span class="comment"> /// <summary>Releases exclusive access. </summary></span></div> |
| <div class="line"><a name="l00113"></a><span class="lineno"> 113</span> <span class="comment"></span> <span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keywordtype">void</span> Release();</div> |
| <div class="line"><a name="l00114"></a><span class="lineno"> 114</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00115"></a><span class="lineno"> 115</span> <span class="comment"> /// <summary>Returns true if the resource is currently locked. Note that one must</span></div> |
| <div class="line"><a name="l00116"></a><span class="lineno"> 116</span> <span class="comment"> /// still call <see cref="Obtain()" /> before using the resource. </span></div> |
| <div class="line"><a name="l00117"></a><span class="lineno"> 117</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00118"></a><span class="lineno"> 118</span> <span class="comment"></span> <span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keywordtype">bool</span> IsLocked();</div> |
| <div class="line"><a name="l00119"></a><span class="lineno"> 119</span>  </div> |
| <div class="line"><a name="l00120"></a><span class="lineno"> 120</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00121"></a><span class="lineno"> 121</span> <span class="comment"> /// <summary>Utility class for executing code with exclusive access. </summary></span></div> |
| <div class="line"><a name="l00122"></a><span class="lineno"><a class="code" href="../../d2/d68/class_lucene_1_1_net_1_1_store_1_1_lock_1_1_with.html"> 122</a></span> <span class="comment"></span> <span class="keyword">public</span> <span class="keyword">abstract</span> <span class="keyword">class </span><a class="code" href="../../d2/d68/class_lucene_1_1_net_1_1_store_1_1_lock_1_1_with.html" title="Utility class for executing code with exclusive access. ">With</a></div> |
| <div class="line"><a name="l00123"></a><span class="lineno"> 123</span>  {</div> |
| <div class="line"><a name="l00124"></a><span class="lineno"> 124</span>  <span class="keyword">private</span> <a class="code" href="../../de/dd8/class_lucene_1_1_net_1_1_store_1_1_lock.html" title="An interprocess mutex lock. Typical use might look like:">Lock</a> lock_Renamed;</div> |
| <div class="line"><a name="l00125"></a><span class="lineno"> 125</span>  <span class="keyword">private</span> <span class="keywordtype">long</span> lockWaitTimeout;</div> |
| <div class="line"><a name="l00126"></a><span class="lineno"> 126</span>  </div> |
| <div class="line"><a name="l00127"></a><span class="lineno"> 127</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00128"></a><span class="lineno"> 128</span> <span class="comment"> /// <summary>Constructs an executor that will grab the named lock. </summary></span></div> |
| <div class="line"><a name="l00129"></a><span class="lineno"><a class="code" href="../../d2/d68/class_lucene_1_1_net_1_1_store_1_1_lock_1_1_with.html#ad233e6856f6b16bc606dd4fe1a025aef"> 129</a></span> <span class="comment"></span> <span class="keyword">protected</span> <a class="code" href="../../d2/d68/class_lucene_1_1_net_1_1_store_1_1_lock_1_1_with.html" title="Utility class for executing code with exclusive access. ">With</a>(<a class="code" href="../../de/dd8/class_lucene_1_1_net_1_1_store_1_1_lock.html" title="An interprocess mutex lock. Typical use might look like:">Lock</a> lock_Renamed, <span class="keywordtype">long</span> lockWaitTimeout)</div> |
| <div class="line"><a name="l00130"></a><span class="lineno"> 130</span>  {</div> |
| <div class="line"><a name="l00131"></a><span class="lineno"> 131</span>  this.lock_Renamed = lock_Renamed;</div> |
| <div class="line"><a name="l00132"></a><span class="lineno"> 132</span>  this.lockWaitTimeout = lockWaitTimeout;</div> |
| <div class="line"><a name="l00133"></a><span class="lineno"> 133</span>  }</div> |
| <div class="line"><a name="l00134"></a><span class="lineno"> 134</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00135"></a><span class="lineno"> 135</span> <span class="comment"> /// <summary>Code to execute with exclusive access. </summary></span></div> |
| <div class="line"><a name="l00136"></a><span class="lineno"> 136</span> <span class="comment"></span> <span class="keyword">protected</span> <span class="keyword">internal</span> <span class="keyword">abstract</span> System.Object DoBody();</div> |
| <div class="line"><a name="l00137"></a><span class="lineno"> 137</span>  <span class="comment"></span></div> |
| <div class="line"><a name="l00138"></a><span class="lineno"> 138</span> <span class="comment"> /// <summary>Calls <see cref="DoBody" /> while <i>lock</i> is obtained. Blocks if lock</span></div> |
| <div class="line"><a name="l00139"></a><span class="lineno"> 139</span> <span class="comment"> /// cannot be obtained immediately. Retries to obtain lock once per second</span></div> |
| <div class="line"><a name="l00140"></a><span class="lineno"> 140</span> <span class="comment"> /// until it is obtained, or until it has tried ten times. Lock is released when</span></div> |
| <div class="line"><a name="l00141"></a><span class="lineno"> 141</span> <span class="comment"> /// <see cref="DoBody" /> exits.</span></div> |
| <div class="line"><a name="l00142"></a><span class="lineno"> 142</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00143"></a><span class="lineno"> 143</span> <span class="comment"> /// <throws> LockObtainFailedException if lock could not </throws></span></div> |
| <div class="line"><a name="l00144"></a><span class="lineno"> 144</span> <span class="comment"> /// <summary> be obtained</span></div> |
| <div class="line"><a name="l00145"></a><span class="lineno"> 145</span> <span class="comment"> /// </summary></span></div> |
| <div class="line"><a name="l00146"></a><span class="lineno"> 146</span> <span class="comment"> /// <throws> IOException if <see cref="Lock.Obtain(long)" /> throws IOException </throws></span></div> |
| <div class="line"><a name="l00147"></a><span class="lineno"><a class="code" href="../../d2/d68/class_lucene_1_1_net_1_1_store_1_1_lock_1_1_with.html#a00ddae2f3c4cff2c6cc7eb5fb0bbe770"> 147</a></span> <span class="comment"></span> <span class="keyword">public</span> <span class="keyword">virtual</span> System.Object run()</div> |
| <div class="line"><a name="l00148"></a><span class="lineno"> 148</span>  {</div> |
| <div class="line"><a name="l00149"></a><span class="lineno"> 149</span>  <span class="keywordtype">bool</span> locked = <span class="keyword">false</span>;</div> |
| <div class="line"><a name="l00150"></a><span class="lineno"> 150</span>  <span class="keywordflow">try</span></div> |
| <div class="line"><a name="l00151"></a><span class="lineno"> 151</span>  {</div> |
| <div class="line"><a name="l00152"></a><span class="lineno"> 152</span>  locked = lock_Renamed.Obtain(lockWaitTimeout);</div> |
| <div class="line"><a name="l00153"></a><span class="lineno"> 153</span>  <span class="keywordflow">return</span> DoBody();</div> |
| <div class="line"><a name="l00154"></a><span class="lineno"> 154</span>  }</div> |
| <div class="line"><a name="l00155"></a><span class="lineno"> 155</span>  <span class="keywordflow">finally</span></div> |
| <div class="line"><a name="l00156"></a><span class="lineno"> 156</span>  {</div> |
| <div class="line"><a name="l00157"></a><span class="lineno"> 157</span>  <span class="keywordflow">if</span> (locked)</div> |
| <div class="line"><a name="l00158"></a><span class="lineno"> 158</span>  lock_Renamed.Release();</div> |
| <div class="line"><a name="l00159"></a><span class="lineno"> 159</span>  }</div> |
| <div class="line"><a name="l00160"></a><span class="lineno"> 160</span>  }</div> |
| <div class="line"><a name="l00161"></a><span class="lineno"> 161</span>  }</div> |
| <div class="line"><a name="l00162"></a><span class="lineno"> 162</span>  }</div> |
| <div class="line"><a name="l00163"></a><span class="lineno"> 163</span> }</div> |
| </div><!-- fragment --></div><!-- contents --> |
| <!-- start footer part --> |
| <hr class="footer"/><address class="footer"><small> |
| Generated on Thu Jan 3 2013 02:34:13 for Lucene.Net by  <a href="http://www.doxygen.org/index.html"> |
| <img class="footer" src="../../doxygen.png" alt="doxygen"/> |
| </a> 1.8.3 |
| </small></address> |
| </body> |
| </html> |
