home *** CD-ROM | disk | FTP | other *** search
/ PC Professionell 2004 December / PCpro_2004_12.ISO / files / webserver / xampp / xampp-perl-addon-1.4.9-installer.exe / SockAddr.pm < prev    next >
Encoding:
Perl POD Document  |  2004-09-23  |  3.7 KB  |  195 lines
  1. # 
  2. # /*
  3. #  * *********** WARNING **************
  4. #  * This file generated by ModPerl::WrapXS/0.01
  5. #  * Any changes made here will be lost
  6. #  * ***********************************
  7. #  * 01: lib/ModPerl/Code.pm:701
  8. #  * 02: O:\147xampp\sources\mod_perl-1.99_16\blib\lib/ModPerl/WrapXS.pm:584
  9. #  * 03: O:\147xampp\sources\mod_perl-1.99_16\blib\lib/ModPerl/WrapXS.pm:1100
  10. #  * 04: Makefile.PL:335
  11. #  * 05: Makefile.PL:283
  12. #  * 06: Makefile.PL:51
  13. #  */
  14. # 
  15.  
  16.  
  17. package APR::SockAddr;
  18.  
  19. use strict;
  20. use warnings FATAL => 'all';
  21.  
  22.  
  23. use APR ();
  24. use APR::XSLoader ();
  25. our $VERSION = '0.01';
  26. APR::XSLoader::load __PACKAGE__;
  27.  
  28.  
  29.  
  30. 1;
  31. __END__
  32.  
  33. =head1 NAME
  34.  
  35. APR::SockAddr - Perl API for APR socket address structure
  36.  
  37.  
  38.  
  39.  
  40. =head1 Synopsis
  41.  
  42.   use APR::SockAddr ();
  43.   
  44.   my $ip = $sock_addr->ip_get;
  45.   my $port = $sock_addr->port;
  46.  
  47.  
  48.  
  49.  
  50.  
  51. =head1 Description
  52.  
  53. C<APR::SockAddr> provides an access to a socket address structure
  54. fields.
  55.  
  56. Normally you'd get a socket address object, by calling:
  57.  
  58.   use Apache::Connection ();
  59.   my $remote_sock_addr = $c->remote_addr;
  60.   my $local_sock_addr  = $c->remote_local;
  61.  
  62.  
  63.  
  64.  
  65. =head1 API
  66.  
  67. C<APR::SockAddr> provides the following functions and/or methods:
  68.  
  69.  
  70.  
  71.  
  72.  
  73. =head2 C<ip_get>
  74.  
  75. Get the IP address of the socket
  76.  
  77.   $ip = $sock_addr->ip_get();
  78.  
  79. =over 4
  80.  
  81. =item obj: C<$sock_addr>
  82. ( C<L<APR::SockAddr object|docs::2.0::api::APR::SockAddr>> )
  83.  
  84. =item ret: C<$ip> ( string )
  85.  
  86. =item since: 1.99_10
  87.  
  88. =back
  89.  
  90. If you are familiar with how perl's C<Socket> works:
  91.  
  92.   use Socket 'sockaddr_in';
  93.   my ($serverport, $serverip) = sockaddr_in(getpeername($local_sock));
  94.   my ($remoteport, $remoteip) = sockaddr_in(getpeername($remote_sock));
  95.  
  96. in apr-speak that'd be written as:
  97.  
  98.   use APR::SockAddr ();
  99.   use Apache::Connection ();
  100.   my $serverport = $c->local_addr->port;
  101.   my $serverip   = $c->local_addr->ip_get;
  102.   my $remoteport = $c->remote_addr->port;
  103.   my $remoteip   = $c->remote_addr->ip_get;
  104.  
  105.  
  106. =head2 C<port>
  107.  
  108. Get the IP address of the socket
  109.  
  110.   $port = $sock_addr->port();
  111.  
  112. =over 4
  113.  
  114. =item obj: C<$sock_addr>
  115. ( C<L<APR::SockAddr object|docs::2.0::api::APR::SockAddr>> )
  116.  
  117. =item ret: C<$port> ( integer )
  118.  
  119. =item since: 1.99_10
  120.  
  121. =back
  122.  
  123. Example: see C<L<ip_get()|/C_ip_get_>>
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130. =head1 Unsupported API
  131.  
  132. C<APR::SockAddr> also provides auto-generated Perl interface for a few
  133. other methods which aren't tested at the moment and therefore their
  134. API is a subject to change. These methods will be finalized later as a
  135. need arises. If you want to rely on any of the following methods
  136. please contact the L<the mod_perl development mailing
  137. list|maillist::dev> so we can help each other take the steps necessary
  138. to shift the method to an officially supported API.
  139.  
  140.  
  141. =head2 C<equal>
  142.  
  143. META: Autogenerated - needs to be reviewed/completed
  144.  
  145. See if the IP addresses in two APR socket addresses are
  146. equivalent.  Appropriate logic is present for comparing
  147. IPv4-mapped IPv6 addresses with IPv4 addresses.
  148.  
  149.   $ret = $addr1->equal($addr2);
  150.  
  151. =over 4
  152.  
  153. =item obj: C<$addr1>
  154. ( C<L<APR::SockAddr object|docs::2.0::api::APR::SockAddr>> )
  155.  
  156. One of the APR socket addresses.
  157.  
  158. =item arg1: C<$addr2>
  159. ( C<L<APR::SockAddr object|docs::2.0::api::APR::SockAddr>> )
  160.  
  161. The other APR socket address.
  162.  
  163. =item ret: C<$ret> ( integer )
  164.  
  165. =item since: subject to change
  166.  
  167. =back
  168.  
  169. The return value will be non-zero if the addresses
  170. are equivalent.
  171.  
  172.  
  173. =head1 See Also
  174.  
  175. L<mod_perl 2.0 documentation|docs::2.0::index>.
  176.  
  177.  
  178.  
  179.  
  180. =head1 Copyright
  181.  
  182. mod_perl 2.0 and its core modules are copyrighted under
  183. The Apache Software License, Version 2.0.
  184.  
  185.  
  186.  
  187.  
  188. =head1 Authors
  189.  
  190. L<The mod_perl development team and numerous
  191. contributors|about::contributors::people>.
  192.  
  193. =cut
  194.  
  195.