/usr/share/GNUstep/Documentation/EOControl/EOMultiReaderLock.html is in libgnustep-dl2-dev 0.12.0-15.1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>EOMultiReaderLock class documentation</title>
</head>
<body>
<font face="serif">
<a href="EOControl.html">Up</a>
<br />
<h1><a name="title$EOMultiReaderLock">EOMultiReaderLock class documentation</a></h1>
<h3>Authors</h3>
<dl>
<dt>Generated by buildd</dt>
<dd>
</dd>
</dl>
<div>
</div>
<h1><a name="001000000000">
Software documentation for the EOMultiReaderLock class
</a></h1>
<h2><a name="class$EOMultiReaderLock">EOMultiReaderLock</a> : NSObject</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>EOControl/EOMultiReaderLock.h</dd>
</dl>
</blockquote>
<div class="desc">
WARNING !!! This class is in the middle of its
initial experimental implementation Do not use it
yet! But if you'd like to help implementing, please feel
free. EOMultiReaderLock is a recursive lock which
allows multiple threads to hold a lock for reading but
only one thread to hold a lock for writing and only when
all reading locks have been relinquished. Once thread
requests for a lock to write further requests for a
read lock are blocked until the write lock has been
granted and relinquished again. But this only holds
true if the thread requesting the reading lock does not
already hold a reading lock in which case it is
granted as it is assumed that this thread needs to
continue to release the previously acquired lock or
locks.
</div>
<hr width="50%" align="left" />
<a href="#_EOMultiReaderLock_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="EOMultiReaderLock.html#method$EOMultiReaderLock-lockForReading">-lockForReading</a></li>
<li><a rel="gsdoc" href="EOMultiReaderLock.html#method$EOMultiReaderLock-lockForWriting">-lockForWriting</a></li>
<li><a rel="gsdoc" href="EOMultiReaderLock.html#method$EOMultiReaderLock-retrieveReaderLocks">-retrieveReaderLocks</a></li>
<li><a rel="gsdoc" href="EOMultiReaderLock.html#method$EOMultiReaderLock-suspendReaderLocks">-suspendReaderLocks</a></li>
<li><a rel="gsdoc" href="EOMultiReaderLock.html#method$EOMultiReaderLock-tryLockForReading">-tryLockForReading</a></li>
<li><a rel="gsdoc" href="EOMultiReaderLock.html#method$EOMultiReaderLock-tryLockForWriting">-tryLockForWriting</a></li>
<li><a rel="gsdoc" href="EOMultiReaderLock.html#method$EOMultiReaderLock-unlockForReading">-unlockForReading</a></li>
<li><a rel="gsdoc" href="EOMultiReaderLock.html#method$EOMultiReaderLock-unlockForWriting">-unlockForWriting</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$EOMultiReaderLock-lockForReading">lockForReading </a></h3>
- (void) <b>lockForReading</b>;<br />
<div class="desc">
</p>
<p>
Blocks until a lock for reading is obtained.
</p>
<p>
</p>
<p>
If the thread already holds this lock for reading or
writing the method returns immediatly. All
successful locks must be paired with
corresponding unlocks.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$EOMultiReaderLock-lockForWriting">lockForWriting </a></h3>
- (void) <b>lockForWriting</b>;<br />
<div class="desc">
</p>
<p>
Blocks until a lock for writing is obtained.
</p>
<p>
</p>
<p>
If the thread already holds this lock for reading or
writing the method returns immediatly. All
successful locks must be paired with
corresponding unlocks.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$EOMultiReaderLock-retrieveReaderLocks">retrieveReaderLocks </a></h3>
- (void) <b>retrieveReaderLocks</b>;<br />
<div class="desc">
</p>
<p>
Reenables the current registred locks.
</p>
<p>
</p>
<p>
This method blocks as <strong>long</strong> as a
writer lock is held by another thread.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$EOMultiReaderLock-suspendReaderLocks">suspendReaderLocks </a></h3>
- (void) <b>suspendReaderLocks</b>;<br />
<div class="desc">
</p>
<p>
Disables the currently registered reader locks.
</p>
<p>
</p>
<p>
Subsequent calls may increment the count for
it's thread but the lock is not reactivated.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$EOMultiReaderLock-tryLockForReading">tryLockForReading </a></h3>
- (BOOL) <b>tryLockForReading</b>;<br />
<div class="desc">
</p>
<p>
Tries to obtain a lock for reading. Returns
<code>NO</code> upon failure.
</p>
<p>
</p>
<p>
If the thread already holds this lock for reading or
writing the method returns true. All successful
locks must be paired with corresponding unlocks.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$EOMultiReaderLock-tryLockForWriting">tryLockForWriting </a></h3>
- (BOOL) <b>tryLockForWriting</b>;<br />
<div class="desc">
</p>
<p>
Tries to obtain a lock for writing. Returns
<code>NO</code> upon failure.
</p>
<p>
</p>
<p>
If the thread already holds this lock for reading or
writing the method returns true. All successful
locks must be paired with corresponding unlocks.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$EOMultiReaderLock-unlockForReading">unlockForReading </a></h3>
- (void) <b>unlockForReading</b>;<br />
<div class="desc">
</p>
<p>
Relinquishes obtained a previously obtained
lock for reading.
</p>
<p>
</p>
<p>
If the thread already holds this lock for reading or
writing the method returns immediatly. All
successful locks must be paired with
corresponding unlocks.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$EOMultiReaderLock-unlockForWriting">unlockForWriting </a></h3>
- (void) <b>unlockForWriting</b>;<br />
<div class="desc">
</p>
<p>
Relinquishes obtained a previously obtained
lock for writing.
</p>
<p>
</p>
<p>
If the thread already holds this lock for reading or
writing the method returns immediatly. All
successful locks must be paired with
corresponding unlocks.
</p>
<p>
</div>
<hr width="25%" align="left" />
</div>
<a name="_EOMultiReaderLock_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for EOMultiReaderLock Class</h2>
<h3><a name="ivariable$EOMultiReaderLock*_mutex">_mutex</a></h3>
@protected NSConditionLock* <b>_mutex</b>;<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$EOMultiReaderLock*_readerFinishedCondition">_readerFinishedCondition</a></h3>
@protected int <b>_readerFinishedCondition</b>;<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$EOMultiReaderLock*_readerThreads">_readerThreads</a></h3>
@protected NSMapTable* <b>_readerThreads</b>;<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$EOMultiReaderLock*_writerFinishedCondition">_writerFinishedCondition</a></h3>
@protected int <b>_writerFinishedCondition</b>;<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$EOMultiReaderLock*_writerLockCount">_writerLockCount</a></h3>
@protected unsigned int <b>_writerLockCount</b>;<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$EOMultiReaderLock*_writerLockThread">_writerLockThread</a></h3>
@protected volatile NSThread* <b>_writerLockThread</b>;<br />
<div class="desc">
<em>Warning</em> the underscore at the start of the
name of this instance variable indicates that, even
though it is not technically <em>private</em>, it is
intended for internal use within the package, and
you should not use the variable in other code.
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<br />
<a href="EOControl.html">Up</a>
</font>
</body>
</html>
|