-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathUtils--LockFile.html
200 lines (158 loc) · 6.1 KB
/
Utils--LockFile.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Utils::LockFile - Lock files. : OpenKore source code documentation</title>
<link rel="stylesheet" type="text/css" href="openkore.css">
<link rel="stylesheet" type="text/css" href="highlight.css">
<!-- Fix broken PNG transparency for IE/Win5-6+ -->
<!--[if gte IE 5.5000]>
<script type="text/javascript" src="pngfix.js"></script>
<![endif]-->
</head>
<body>
<div id="title">OpenKore source code documentation</div>
<div id="navigation">
<ul>
<li><a href="http://www.openkore.com/">Main website</a></li>
<li><a href="index.html">Table of contents</a></li>
<li><b>Utils::LockFile</b></li>
</ul>
</div>
<div id="main">
<h1>Utils::LockFile - Lock files.</h1>
This class provides an easy interface for lock files. A lock file is
like a mutex or critical section, but it can be used between different
processes. It's used to synchronize processes with each other.
<p>
Lock files should not be used for file I/O: they should not be read
from or written to. On Unix it will work, but on Windows it will fail.
<p><table class="functionIndex">
<tr><th colspan="3">Functions in this module</th></tr><tr onclick="location.href='#Utils::LockFile->new';">
<td class="return-type"></td>
<td class="func"><a href="#Utils::LockFile->new">Utils::LockFile->new</a></td>
<td class="decl">(<span class="type">String</span> file)</td>
</tr><tr onclick="location.href='#$Utils_LockFile->lock';">
<td class="return-type">void</td>
<td class="func"><a href="#$Utils_LockFile->lock">$Utils_LockFile->lock</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$Utils_LockFile->locked';">
<td class="return-type">boolean</td>
<td class="func"><a href="#$Utils_LockFile->locked">$Utils_LockFile->locked</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$Utils_LockFile->tryLock';">
<td class="return-type">boolean</td>
<td class="func"><a href="#$Utils_LockFile->tryLock">$Utils_LockFile->tryLock</a></td>
<td class="decl">()</td>
</tr><tr onclick="location.href='#$Utils_LockFile->unlock';">
<td class="return-type">void</td>
<td class="func"><a href="#$Utils_LockFile->unlock">$Utils_LockFile->unlock</a></td>
<td class="decl">()</td>
</tr>
</table>
<p><hr class="details_sep">
<h2>Details</h2>
<div class="details">
<p>
<div class="function"><a name="$Utils_LockFile->lock"></a>
<h3>$Utils_LockFile->lock</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>$Utils_LockFile->lock</strong>()
</dt>
<dd>
<dl class="params_and_returns">
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">!$self->locked()</dd>
</dl><p>
<div class="desc">Lock this file. If it's already locked, wait until the file is unlocked.
The lock is automatically released if this Utils::LockFile instance is
destroyed.
<p>
Throws IOException if the lockfile cannot be opened or if
locking fails.
<p>
Throws Utils::LockFile::AlreadyLocked if the precondition is not satisfied.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$Utils_LockFile->locked"></a>
<h3>$Utils_LockFile->locked</h3>
<dl>
<dt class="decl">
<span class="return-type"> boolean</span> <strong>$Utils_LockFile->locked</strong>()
</dt>
<dd>
<div class="desc">Check whether the file is locked.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$Utils_LockFile->tryLock"></a>
<h3>$Utils_LockFile->tryLock</h3>
<dl>
<dt class="decl">
<span class="return-type"> boolean</span> <strong>$Utils_LockFile->tryLock</strong>()
</dt>
<dd>
<dl class="params_and_returns">
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">!$self->locked()</dd>
</dl><p>
<div class="desc">Attempt to lock this file. If it's already locked, returns 0. If it's
not already locked, then our lock has succeeded, and 1 is returned.
The lock is automatically released if this Utils::LockFile instance is
destroyed.
<p>
Throws IOException if the lockfile cannot be opened or if
locking fails.
<p>
Throws Utils::LockFile::AlreadyLocked if the precondition is not satisfied.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="$Utils_LockFile->unlock"></a>
<h3>$Utils_LockFile->unlock</h3>
<dl>
<dt class="decl">
<span class="return-type"> void</span> <strong>$Utils_LockFile->unlock</strong>()
</dt>
<dd>
<dl class="params_and_returns">
<dt class="requires"><strong>Requires:</strong></dt>
<dd class="requires">$self->locked()</dd>
</dl><p>
<div class="desc">Unlock this file.
<p>
Throws Utils::LockFile::NotLocked if the precondition is not satisfied.</div>
</dd>
</dl>
</div>
<p><hr class="function_sep"><p>
<div class="function"><a name="Utils::LockFile->new"></a>
<h3>Utils::LockFile->new</h3>
<dl>
<dt class="decl">
<span class="return-type"> </span><strong>Utils::LockFile->new</strong>(<span class="type">String</span> file)
</dt>
<dd>
<div class="desc">Create a new Utils::LockFile object, using the specified file as lock.
The default state is unlocked.</div>
</dd>
</dl>
</div>
</div>
<p><hr><p>
<div id="footer">
<ul>
<li><a href="http://validator.w3.org/check?uri=referer" title="Valid HTML 4.01!"><img src="http://www.w3.org/Icons/valid-html401" alt="Valid HTML 4.01!" height="31" width="88"></a></li>
<li><a href="http://www.mozilla.com/" title="Get Firefox - Take Back the Web"><img width="104" height="32" src="http://www.mozilla.org/products/firefox/buttons/getfirefox_small.png" alt="Get Firefox - Take Back the Web"></a></li>
<li><a href="http://www.mozilla.com/" title="If you were looking at this page in any browser but Microsoft Internet Explorer, it would look and run better and faster"><img width="45" height="45" src="http://linuxart.com/img/noIE-small.png" alt="If you were looking at this page in any browser but Microsoft Internet Explorer, it would look and run better and faster"></a></li>
</ul>
Last modified: Fri Nov 16 10:05:11 2012
</div>
</div>
</body>
</html>