/usr/share/doc/libapache2-mod-perl2-doc/docs/2.0/api/Apache2/ConnectionUtil.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 | <?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>
<ul>
<li><a href="#pnotes">pnotes</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>Apache2::ConnectionUtil - Perl API for Apache connection utils</p>
<h1 id="Synopsis">Synopsis</h1>
<pre><code> use Apache2::Connection ();
use Apache2::ConnectionUtil ();
use Apache2::RequestRec ();
# grab the connection object;
my $c = $r->connection;
# share perl objects like $r->pnotes
$old_val = $c->pnotes($key => $value);</code></pre>
<h1 id="Description">Description</h1>
<p><code>Apache2::ConnectionUtil</code> provides the <a>Apache connection record object</a> utilities API.</p>
<h1 id="API">API</h1>
<p><code>Apache2::ConnectionUtil</code> provides the following functions and/or methods:</p>
<h2 id="pnotes"><code>pnotes</code></h2>
<p>Share Perl variables between requests over the lifetime of the connection.</p>
<pre><code> $old_val = $c->pnotes($key => $val);
$val = $c->pnotes($key);
$hash_ref = $c->pnotes();</code></pre>
<dl>
<dt id="obj:-c-Apache2::Connection-object">obj: <code>$c</code> ( <code><a>Apache2::Connection object</a></code> )</dt>
<dd>
</dd>
<dt id="opt-arg1:-key-string">opt arg1: <code>$key</code> ( string )</dt>
<dd>
<p>A key value</p>
</dd>
<dt id="opt-arg2:-val-SCALAR">opt arg2: <code>$val</code> ( SCALAR )</dt>
<dd>
<p>Any scalar value (e.g. a reference to an array)</p>
</dd>
<dt id="ret:-3-different-possible-values">ret: (3 different possible values)</dt>
<dd>
<p>if both, <code>$key</code> and <code>$val</code> are passed the previous value for <code>$key</code> is returned if such existed, otherwise undef is returned.</p>
<p>if only <code>$key</code> is passed, the current value for the given key is returned.</p>
<p>if no arguments are passed, a hash reference is returned, which can then be directly accessed without going through the <code>pnotes()</code> interface.</p>
</dd>
<dt id="since:-2.0.3">since: 2.0.3</dt>
<dd>
</dd>
</dl>
<p>See (<code><a>Apache2::RequestUtil::pnotes</a></code>) for the details of the <code>pnotes</code> method usage. The usage is identical except for a few differences. First is the use of <code>$c</code> instead of <code>$r</code> as the invocant. The second is that the the data persists for the lifetime of the connection instead of the lifetime of the request. If the connection is lost, so is the data stored in <code>pnotes</code>.</p>
<h1 id="See-Also">See Also</h1>
<p><a>Apache2::Connection</a>.</p>
<p><a>Apache2::RequestUtil::pnotes</a>.</p>
<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>
|