/usr/share/doc/libapache2-mod-perl2-doc/docs/2.0/api/APR/SockAddr.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 | <?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="#ip_get">ip_get</a></li>
<li><a href="#port">port</a></li>
</ul>
</li>
<li><a href="#Unsupported-API">Unsupported API</a>
<ul>
<li><a href="#equal">equal</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::SockAddr - Perl API for APR socket address structure</p>
<h1 id="Synopsis">Synopsis</h1>
<pre><code> use APR::SockAddr ();
my $ip = $sock_addr->ip_get;
my $port = $sock_addr->port;</code></pre>
<h1 id="Description">Description</h1>
<p><code>APR::SockAddr</code> provides an access to a socket address structure fields.</p>
<p>Normally you'd get a socket address object, by calling:</p>
<pre><code> use Apache2::Connection ();
my $remote_sock_addr = $c->remote_addr;
my $local_sock_addr = $c->remote_local;</code></pre>
<h1 id="API">API</h1>
<p><code>APR::SockAddr</code> provides the following functions and/or methods:</p>
<h2 id="ip_get"><code>ip_get</code></h2>
<p>Get the IP address of the socket</p>
<pre><code> $ip = $sock_addr->ip_get();</code></pre>
<dl>
<dt id="obj:-sock_addr-APR::SockAddr-object">obj: <code>$sock_addr</code> ( <code><a>APR::SockAddr object</a></code> )</dt>
<dd>
</dd>
<dt id="ret:-ip-string">ret: <code>$ip</code> ( string )</dt>
<dd>
</dd>
<dt id="since:-2.0.00">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<p>If you are familiar with how perl's <code>Socket</code> works:</p>
<pre><code> use Socket 'sockaddr_in';
my ($serverport, $serverip) = sockaddr_in(getpeername($local_sock));
my ($remoteport, $remoteip) = sockaddr_in(getpeername($remote_sock));</code></pre>
<p>in apr-speak that'd be written as:</p>
<pre><code> use APR::SockAddr ();
use Apache2::Connection ();
my $serverport = $c->local_addr->port;
my $serverip = $c->local_addr->ip_get;
my $remoteport = $c->remote_addr->port;
my $remoteip = $c->remote_addr->ip_get;</code></pre>
<h2 id="port"><code>port</code></h2>
<p>Get the IP address of the socket</p>
<pre><code> $port = $sock_addr->port();</code></pre>
<dl>
<dt id="obj:-sock_addr-APR::SockAddr-object1">obj: <code>$sock_addr</code> ( <code><a>APR::SockAddr object</a></code> )</dt>
<dd>
</dd>
<dt id="ret:-port-integer">ret: <code>$port</code> ( integer )</dt>
<dd>
</dd>
<dt id="since:-2.0.001">since: 2.0.00</dt>
<dd>
</dd>
</dl>
<p>Example: see <code><a href="#C_ip_get_">ip_get()</a></code></p>
<h1 id="Unsupported-API">Unsupported API</h1>
<p><code>APR::SockAddr</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="equal"><code>equal</code></h2>
<p>META: Autogenerated - needs to be reviewed/completed</p>
<p>See if the IP addresses in two APR socket addresses are equivalent. Appropriate logic is present for comparing IPv4-mapped IPv6 addresses with IPv4 addresses.</p>
<pre><code> $ret = $addr1->equal($addr2);</code></pre>
<dl>
<dt id="obj:-addr1-APR::SockAddr-object">obj: <code>$addr1</code> ( <code><a>APR::SockAddr object</a></code> )</dt>
<dd>
<p>One of the APR socket addresses.</p>
</dd>
<dt id="arg1:-addr2-APR::SockAddr-object">arg1: <code>$addr2</code> ( <code><a>APR::SockAddr object</a></code> )</dt>
<dd>
<p>The other APR socket address.</p>
</dd>
<dt id="ret:-ret-integer">ret: <code>$ret</code> ( integer )</dt>
<dd>
</dd>
<dt id="since:-subject-to-change">since: subject to change</dt>
<dd>
</dd>
</dl>
<p>The return value will be non-zero if the addresses are equivalent.</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>
|