/usr/share/doc/libapache2-mod-perl2-doc/docs/2.0/api/APR/ThreadRWLock.html is in libapache2-mod-perl2-doc 2.0.8+httpd24-r1449661-6ubuntu2.
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 | <?xml version="1.0" ?>
<!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">
<head>
<title></title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body style="background-color: white">
<ul id="index">
<li><a href="#NAME">NAME</a></li>
<li><a href="#Synopsis">Synopsis</a></li>
<li><a href="#Description">Description</a></li>
<li><a href="#API">API</a></li>
<li><a href="#Unsupported-API">Unsupported API</a>
<ul>
<li><a href="#DESTROY">DESTROY</a></li>
<li><a href="#rdlock">rdlock</a></li>
<li><a href="#tryrdlock">tryrdlock</a></li>
<li><a href="#wrlock">wrlock</a></li>
<li><a href="#trywrlock">trywrlock</a></li>
<li><a href="#new">new</a></li>
<li><a href="#pool_get">pool_get</a></li>
<li><a href="#unlock">unlock</a></li>
</ul>
</li>
<li><a href="#See-Also">See Also</a></li>
<li><a href="#Copyright">Copyright</a></li>
<li><a href="#Authors">Authors</a></li>
</ul>
<h1 id="NAME">NAME</h1>
<p>APR::ThreadRWLock - Perl API for APR thread read/write locks</p>
<h1 id="Synopsis">Synopsis</h1>
<pre><code> use APR::ThreadRWLock ();
my $mutex = APR::ThreadRWLock->new($r->pool);
$mutex->rdlock;
$mutex->wrlock;
$mutex->tryrdlock;
$mutex->trywrlock;
$mutex->unlock;</code></pre>
<h1 id="Description">Description</h1>
<p><code>APR::ThreadRWLock</code> interfaces APR thread read/write locks.</p>
<p>See <i>srclib/apr/locks/unix/thread_rwlock.c</i> in your Apache source tree. At the time of this writing these methods are not supported on all platforms. Thus, check your libraries!</p>
<h1 id="API">API</h1>
<p><code>APR::ThreadRWLock</code> provides the following functions and/or methods:</p>
<h1 id="Unsupported-API">Unsupported API</h1>
<p><code>APR::ThreadRWLock</code> also provides auto-generated Perl interface for a few other methods which aren't tested at the moment and therefore their API is a subject to change. These methods will be finalized later as a need arises. If you want to rely on any of the following methods please contact the <a>the mod_perl development mailing list</a> so we can help each other take the steps necessary to shift the method to an officially supported API.</p>
<h2 id="DESTROY"><code>DESTROY</code></h2>
<p>META: Autogenerated - needs to be reviewed/completed</p>
<p>Destroy the lock and free the associated memory.</p>
<pre><code> $lock->DESTROY();</code></pre>
<dl>
<dt id="obj:-lock-APR::ThreadRWLock-object">obj: <code>$lock</code> ( <code><a>APR::ThreadRWLock object</a></code> )</dt>
<dd>
<p>the lock to destroy.</p>
</dd>
<dt id="ret:-no-return-value">ret: no return value</dt>
<dd>
</dd>
<dt id="since:-subject-to-change">since: subject to change</dt>
<dd>
</dd>
</dl>
<h2 id="rdlock"><code>rdlock</code></h2>
<p>META: Autogenerated - needs to be reviewed/completed</p>
<p>Acquire the read lock for the given lock. The calling thread acquires the read lock if a writer does not hold the lock and there are no writers blocked on the lock. Otherwize it is put to sleep until these conditions are met.</p>
<pre><code> $ret = $lock->rdlock();</code></pre>
<dl>
<dt id="obj:-lock-APR::ThreadRWLock-object1">obj: <code>$lock</code> ( <code><a>APR::ThreadRWLock object</a></code> )</dt>
<dd>
<p>the lock on which to acquire the lock.</p>
</dd>
<dt id="ret:-ret-integer">ret: <code>$ret</code> ( integer )</dt>
<dd>
</dd>
<dt id="since:-subject-to-change1">since: subject to change</dt>
<dd>
</dd>
</dl>
<h2 id="tryrdlock"><code>tryrdlock</code></h2>
<p>META: Autogenerated - needs to be reviewed/completed</p>
<p>Performs the same operation as <code>rdlock</code> with the exception that the function shall fail if the thread would be blocked.</p>
<pre><code> $ret = $lock->tryrdlock();</code></pre>
<dl>
<dt id="obj:-lock-APR::ThreadRWLock-object2">obj: <code>$lock</code> ( <code><a>APR::ThreadRWLock object</a></code> )</dt>
<dd>
<p>the lock on which to acquire the lock.</p>
</dd>
<dt id="ret:-ret-integer1">ret: <code>$ret</code> ( integer )</dt>
<dd>
</dd>
<dt id="since:-subject-to-change2">since: subject to change</dt>
<dd>
</dd>
</dl>
<h2 id="wrlock"><code>wrlock</code></h2>
<p>META: Autogenerated - needs to be reviewed/completed</p>
<p>Acquire the write lock for the given lock. The calling thread acquires the write lock if if no other thread (reader or writer) holds it. Otherwize it is put to sleep until this condition is met.</p>
<pre><code> $ret = $lock->wrlock();</code></pre>
<dl>
<dt id="obj:-lock-APR::ThreadRWLock-object3">obj: <code>$lock</code> ( <code><a>APR::ThreadRWLock object</a></code> )</dt>
<dd>
<p>the lock on which to acquire the lock.</p>
</dd>
<dt id="ret:-ret-integer2">ret: <code>$ret</code> ( integer )</dt>
<dd>
</dd>
<dt id="since:-subject-to-change3">since: subject to change</dt>
<dd>
</dd>
</dl>
<h2 id="trywrlock"><code>trywrlock</code></h2>
<p>META: Autogenerated - needs to be reviewed/completed</p>
<p>Performs the same operation as <code>wrlock</code> with the exception that the function shall fail if the thread would be blocked.</p>
<pre><code> $ret = $lock->trywrlock();</code></pre>
<dl>
<dt id="obj:-lock-APR::ThreadRWLock-object4">obj: <code>$lock</code> ( <code><a>APR::ThreadRWLock object</a></code> )</dt>
<dd>
<p>the lock on which to acquire the lock.</p>
</dd>
<dt id="ret:-ret-integer3">ret: <code>$ret</code> ( integer )</dt>
<dd>
</dd>
<dt id="since:-subject-to-change4">since: subject to change</dt>
<dd>
</dd>
</dl>
<h2 id="new"><code>new</code></h2>
<p>Create a new lock</p>
<pre><code> my $lock = APR::ThreadRWLock->new($p);</code></pre>
<dl>
<dt id="obj:-APR::ThreadRWLock-class-name">obj: <code>APR::ThreadRWLock</code> ( class name )</dt>
<dd>
</dd>
<dt id="arg1:-p-APR::Pool-object">arg1: <code>$p</code> ( <code><a>APR::Pool object</a></code> )</dt>
<dd>
</dd>
<dt id="ret:-lock-APR::ThreadRWLock-object">ret: <code>$lock</code> ( <code><a>APR::ThreadRWLock object</a></code> )</dt>
<dd>
</dd>
<dt id="since:-subject-to-change5">since: subject to change</dt>
<dd>
</dd>
</dl>
<h2 id="pool_get"><code>pool_get</code></h2>
<p>META: Autogenerated - needs to be reviewed/completed</p>
<p>META: should probably be renamed to pool(), like all other pool accessors</p>
<p>Get the pool used by this thread_lock.</p>
<pre><code> $ret = $obj->pool_get();</code></pre>
<dl>
<dt id="obj:-obj-APR::ThreadRWLock-object">obj: <code>$obj</code> ( <code><a>APR::ThreadRWLock object</a></code> )</dt>
<dd>
</dd>
<dt id="ret:-ret-APR::Pool-object">ret: <code>$ret</code> ( <code><a>APR::Pool object</a></code> )</dt>
<dd>
<p>apr_pool_t the pool</p>
</dd>
<dt id="since:-subject-to-change6">since: subject to change</dt>
<dd>
</dd>
</dl>
<h2 id="unlock"><code>unlock</code></h2>
<p>META: Autogenerated - needs to be reviewed/completed</p>
<p>Release the lock for the given lock.</p>
<pre><code> $ret = $lock->unlock();</code></pre>
<dl>
<dt id="obj:-lock-APR::ThreadRWLock-object5">obj: <code>$lock</code> ( <code><a>APR::ThreadRWLock object</a></code> )</dt>
<dd>
<p>the lock from which to release the lock.</p>
</dd>
<dt id="ret:-ret-integer4">ret: <code>$ret</code> ( integer )</dt>
<dd>
</dd>
<dt id="since:-subject-to-change7">since: subject to change</dt>
<dd>
</dd>
</dl>
<h1 id="See-Also">See Also</h1>
<p><a>mod_perl 2.0 documentation</a>.</p>
<h1 id="Copyright">Copyright</h1>
<p>mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.</p>
<h1 id="Authors">Authors</h1>
<p><a>The mod_perl development team and numerous contributors</a>.</p>
</body>
</html>
|