/usr/share/doc/libapache2-mod-perl2-doc/docs/2.0/api/APR/Status.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 291 292 293 294 295 296 297 298 299 300 301 302 | <?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="#Functions">Functions</a>
<ul>
<li><a href="#is_EACCES">is_EACCES</a></li>
<li><a href="#is_EAGAIN">is_EAGAIN</a></li>
<li><a href="#is_ENOENT">is_ENOENT</a></li>
<li><a href="#is_EOF">is_EOF</a></li>
<li><a href="#is_ECONNABORTED">is_ECONNABORTED</a></li>
<li><a href="#is_ECONNRESET">is_ECONNRESET</a></li>
<li><a href="#is_TIMEUP">is_TIMEUP</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::Status - Perl Interface to the APR_STATUS_IS_* macros</p>
<h1 id="Synopsis">Synopsis</h1>
<pre><code> use APR::Status ();
eval { $obj->mp_method() };
if ($@ && $ref $@ eq 'APR::Error' && APR::Status::is_EAGAIN($@)) {
# APR_STATUS_IS_EAGAIN(s) of apr_errno.h is satisfied
}</code></pre>
<h1 id="Description">Description</h1>
<p>An interface to <i>apr_errno.h</i> composite error codes.</p>
<p>As discussed in the <code><a>APR::Error</a></code> manpage, it is possible to handle APR/Apache/mod_perl exceptions in the following way:</p>
<pre><code> eval { $obj->mp_method() };
if ($@ && $ref $@ eq 'APR::Error' && $@ == $some_code)
warn "handled exception: $@";
}</code></pre>
<p>However, in cases where <code>$some_code</code> is an <a>APR::Const constant</a>, there may be more than one condition satisfying the intent of this exception. For this purpose the APR C library provides in <i>apr_errno.h</i> a series of macros, <code>APR_STATUS_IS_*</code>, which are the recommended way to check for such conditions. For example, the <code>APR_STATUS_IS_EAGAIN</code> macro is defined as</p>
<pre><code> #define APR_STATUS_IS_EAGAIN(s) ((s) == APR_EAGAIN \
|| (s) == APR_OS_START_SYSERR + ERROR_NO_DATA \
|| (s) == APR_OS_START_SYSERR + SOCEWOULDBLOCK \
|| (s) == APR_OS_START_SYSERR + ERROR_LOCK_VIOLATION)</code></pre>
<p>The purpose of <code>APR::Status</code> is to provide functions corresponding to these macros.</p>
<h1 id="Functions">Functions</h1>
<h2 id="is_EACCES"><code>is_EACCES</code></h2>
<p>Check if the error is matching <code>EACCES</code> and its variants (corresponds to the <code>APR_STATUS_IS_EACCES</code> macro).</p>
<pre><code> $status = APR::Status::is_EACCES($error_code);</code></pre>
<dl>
<dt id="arg1:-error_code-integer-or-APR::Error-object">arg1: <code>$error_code</code> (integer or <code><a>APR::Error object</a></code> )</dt>
<dd>
<p>The error code or to check, normally <code>$@</code> blessed into <code><a>APR::Error object</a></code>.</p>
</dd>
<dt id="ret:-status-boolean">ret: <code>$status</code> ( boolean )</dt>
<dd>
</dd>
<dt id="since:-2.0.00">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<p>An example of using <code>is_EACCES</code> is when reading the contents of a file where access may be forbidden:</p>
<pre><code> eval { $obj->slurp_filename(0) };
if ($@) {
return Apache2::Const::FORBIDDEN
if ref $@ eq 'APR::Error' && APR::Status::is_EACCES($@);
die $@;
}</code></pre>
<p>Due to possible variants in conditions matching <code>EACCES</code>, the use of this function is recommended for checking error codes against this value, rather than just using <code><a>APR::Const::EACCES</a></code> directly.</p>
<h2 id="is_EAGAIN"><code>is_EAGAIN</code></h2>
<p>Check if the error is matching <code>EAGAIN</code> and its variants (corresponds to the <code>APR_STATUS_IS_EAGAIN</code> macro).</p>
<pre><code> $status = APR::Status::is_EAGAIN($error_code);</code></pre>
<dl>
<dt id="arg1:-error_code-integer-or-APR::Error-object1">arg1: <code>$error_code</code> (integer or <code><a>APR::Error object</a></code> )</dt>
<dd>
<p>The error code or to check, normally <code>$@</code> blessed into <code><a>APR::Error object</a></code>.</p>
</dd>
<dt id="ret:-status-boolean1">ret: <code>$status</code> ( boolean )</dt>
<dd>
</dd>
<dt id="since:-2.0.001">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<p>For example, here is how you may want to handle socket read exceptions and do retries:</p>
<pre><code> use APR::Status ();
# ....
my $tries = 0;
my $buffer;
RETRY: my $rlen = eval { $socket->recv($buffer, SIZE) };
if ($@ && ref($@) && APR::Status::is_EAGAIN($@)) {
if ($tries++ < 3) {
goto RETRY;
}
else {
# do something else
}
}
else {
die "eval block has failed: $@";
}</code></pre>
<p>Notice that just checking against <code><a>APR::Const::EAGAIN</a></code> may work on some Unices, but then it will certainly break on win32. Thefore make sure to use this macro and not <code>APR::Const::EAGAIN</code> unless you know what you are doing.</p>
<h2 id="is_ENOENT"><code>is_ENOENT</code></h2>
<p>Check if the error is matching <code>ENOENT</code> and its variants (corresponds to the <code>APR_STATUS_IS_ENOENT</code> macro).</p>
<pre><code> $status = APR::Status::is_ENOENT($error_code);</code></pre>
<dl>
<dt id="arg1:-error_code-integer-or-APR::Error-object2">arg1: <code>$error_code</code> (integer or <code><a>APR::Error object</a></code> )</dt>
<dd>
<p>The error code or to check, normally <code>$@</code> blessed into <code><a>APR::Error object</a></code>.</p>
</dd>
<dt id="ret:-status-boolean2">ret: <code>$status</code> ( boolean )</dt>
<dd>
</dd>
<dt id="since:-2.0.002">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<p>An example of using <code>is_ENOENT</code> is when reading the contents of a file which may not exist:</p>
<pre><code> eval { $obj->slurp_filename(0) };
if ($@) {
return Apache2::Const::NOT_FOUND
if ref $@ eq 'APR::Error' && APR::Status::is_ENOENT($@);
die $@;
}</code></pre>
<p>Due to possible variants in conditions matching <code>ENOENT</code>, the use of this function is recommended for checking error codes against this value, rather than just using <code><a>APR::Const::ENOENT</a></code> directly.</p>
<h2 id="is_EOF"><code>is_EOF</code></h2>
<p>Check if the error is matching <code>EOF</code> and its variants (corresponds to the <code>APR_STATUS_IS_EOF</code> macro).</p>
<pre><code> $status = APR::Status::is_EOF($error_code);</code></pre>
<dl>
<dt id="arg1:-error_code-integer-or-APR::Error-object3">arg1: <code>$error_code</code> (integer or <code><a>APR::Error object</a></code> )</dt>
<dd>
<p>The error code or to check, normally <code>$@</code> blessed into <code><a>APR::Error object</a></code>.</p>
</dd>
<dt id="ret:-status-boolean3">ret: <code>$status</code> ( boolean )</dt>
<dd>
</dd>
<dt id="since:-2.0.003">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<p>Due to possible variants in conditions matching <code>EOF</code>, the use of this function is recommended for checking error codes against this value, rather than just using <code><a>APR::Const::EOF</a></code> directly.</p>
<h2 id="is_ECONNABORTED"><code>is_ECONNABORTED</code></h2>
<p>Check if the error is matching <code>ECONNABORTED</code> and its variants (corresponds to the <code>APR_STATUS_IS_ECONNABORTED</code> macro).</p>
<pre><code> $status = APR::Status::is_ECONNABORTED($error_code);</code></pre>
<dl>
<dt id="arg1:-error_code-integer-or-APR::Error-object4">arg1: <code>$error_code</code> (integer or <code><a>APR::Error object</a></code> )</dt>
<dd>
<p>The error code or to check, normally <code>$@</code> blessed into <code><a>APR::Error object</a></code>.</p>
</dd>
<dt id="ret:-status-boolean4">ret: <code>$status</code> ( boolean )</dt>
<dd>
</dd>
<dt id="since:-2.0.004">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<p>Due to possible variants in conditions matching <code>ECONNABORTED</code>, the use of this function is recommended for checking error codes against this value, rather than just using <code><a>APR::Const::ECONNABORTED</a></code> directly.</p>
<h2 id="is_ECONNRESET"><code>is_ECONNRESET</code></h2>
<p>Check if the error is matching <code>ECONNRESET</code> and its variants (corresponds to the <code>APR_STATUS_IS_ECONNRESET</code> macro).</p>
<pre><code> $status = APR::Status::is_ECONNRESET($error_code);</code></pre>
<dl>
<dt id="arg1:-error_code-integer-or-APR::Error-object5">arg1: <code>$error_code</code> (integer or <code><a>APR::Error object</a></code> )</dt>
<dd>
<p>The error code or to check, normally <code>$@</code> blessed into <code><a>APR::Error object</a></code>.</p>
</dd>
<dt id="ret:-status-boolean5">ret: <code>$status</code> ( boolean )</dt>
<dd>
</dd>
<dt id="since:-2.0.005">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<p>Due to possible variants in conditions matching <code>ECONNRESET</code>, the use of this function is recommended for checking error codes against this value, rather than just using <code><a>APR::Const::ECONNRESET</a></code> directly.</p>
<h2 id="is_TIMEUP"><code>is_TIMEUP</code></h2>
<p>Check if the error is matching <code>TIMEUP</code> and its variants (corresponds to the <code>APR_STATUS_IS_TIMEUP</code> macro).</p>
<pre><code> $status = APR::Status::is_TIMEUP($error_code);</code></pre>
<dl>
<dt id="arg1:-error_code-integer-or-APR::Error-object6">arg1: <code>$error_code</code> (integer or <code><a>APR::Error object</a></code> )</dt>
<dd>
<p>The error code or to check, normally <code>$@</code> blessed into <code><a>APR::Error object</a></code>.</p>
</dd>
<dt id="ret:-status-boolean6">ret: <code>$status</code> ( boolean )</dt>
<dd>
</dd>
<dt id="since:-2.0.006">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<p>Due to possible variants in conditions matching <code>TIMEUP</code>, the use of this function is recommended for checking error codes against this value, rather than just using <code><a>APR::Const::TIMEUP</a></code> directly.</p>
<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>
|