/usr/share/doc/libapache2-mod-perl2-doc/docs/2.0/api/APR/ThreadMutex.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 | <?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="#lock">lock</a></li>
<li><a href="#new">new</a></li>
<li><a href="#pool_get">pool_get</a></li>
<li><a href="#trylock">trylock</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::ThreadMutex - Perl API for APR thread mutexes</p>
<h1 id="Synopsis">Synopsis</h1>
<pre><code> use APR::ThreadMutex ();
my $mutex = APR::ThreadMutex->new($r->pool);
$mutex->lock;
$mutex->unlock;
$mutex->trylock;</code></pre>
<h1 id="Description">Description</h1>
<p><code>APR::ThreadMutex</code> interfaces APR thread mutexes.</p>
<h1 id="API">API</h1>
<p><code>APR::ThreadMutex</code> provides the following functions and/or methods:</p>
<h1 id="Unsupported-API">Unsupported API</h1>
<p><code>APR::ThreadMutex</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 mutex and free the memory associated with the lock.</p>
<pre><code> $mutex->DESTROY();</code></pre>
<dl>
<dt id="obj:-mutex-APR::ThreadMutex-object">obj: <code>$mutex</code> ( <code><a>APR::ThreadMutex object</a></code> )</dt>
<dd>
<p>the mutex 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="lock"><code>lock</code></h2>
<p>META: Autogenerated - needs to be reviewed/completed</p>
<p>Acquire the lock for the given mutex. If the mutex is already locked, the current thread will be put to sleep until the lock becomes available.</p>
<pre><code> $ret = $mutex->lock();</code></pre>
<dl>
<dt id="obj:-mutex-APR::ThreadMutex-object1">obj: <code>$mutex</code> ( <code><a>APR::ThreadMutex object</a></code> )</dt>
<dd>
<p>the mutex 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="new"><code>new</code></h2>
<p>Create a new mutex</p>
<pre><code> my $mutex = APR::ThreadMutex->new($p);</code></pre>
<dl>
<dt id="obj:-APR::ThreadMutex-class-name">obj: <code>APR::ThreadMutex</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:-mutex-APR::ThreadMutex-object">ret: <code>$mutex</code> ( <code><a>APR::ThreadMutex object</a></code> )</dt>
<dd>
</dd>
<dt id="since:-subject-to-change2">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_mutex.</p>
<pre><code> $ret = $obj->pool_get();</code></pre>
<dl>
<dt id="obj:-obj-APR::ThreadMutex-object">obj: <code>$obj</code> ( <code><a>APR::ThreadMutex 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-change3">since: subject to change</dt>
<dd>
</dd>
</dl>
<h2 id="trylock"><code>trylock</code></h2>
<p>META: Autogenerated - needs to be reviewed/completed</p>
<p>Attempt to acquire the lock for the given mutex. If the mutex has already been acquired, the call returns immediately with APR_EBUSY. Note: it is important that the APR_STATUS_IS_EBUSY(s) macro be used to determine if the return value was APR_EBUSY, for portability reasons.</p>
<pre><code> $ret = $mutex->trylock();</code></pre>
<dl>
<dt id="obj:-mutex-APR::ThreadMutex-object2">obj: <code>$mutex</code> ( <code><a>APR::ThreadMutex object</a></code> )</dt>
<dd>
<p>the mutex on which to attempt the lock acquiring.</p>
</dd>
<dt id="ret:-ret-integer1">ret: <code>$ret</code> (integer)</dt>
<dd>
</dd>
<dt id="since:-subject-to-change4">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 mutex.</p>
<pre><code> $ret = $mutex->unlock();</code></pre>
<dl>
<dt id="obj:-mutex-APR::ThreadMutex-object3">obj: <code>$mutex</code> ( <code><a>APR::ThreadMutex object</a></code> )</dt>
<dd>
<p>the mutex from which to release the lock.</p>
</dd>
<dt id="ret:-ret-integer2">ret: <code>$ret</code> ( integer )</dt>
<dd>
</dd>
<dt id="since:-subject-to-change5">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>
|