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 / IpSubnet.pm < prev    next >
Encoding:
Perl POD Document  |  2004-09-23  |  3.4 KB  |  175 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::IpSubnet;
  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::IpSubnet - Perl API for accessing APRs ip_subnet structures
  36.  
  37.  
  38.  
  39.  
  40. =head1 Synopsis
  41.  
  42.   use APR::IpSubnet ();
  43.   
  44.   my $ipsub = APR::IpSubnet->new($pool, "127.0.0.1");
  45.   $ok = $ipsub->test($sock_addr);
  46.  
  47.  
  48.  
  49.  
  50.  
  51. =head1 Description
  52.  
  53. C<APR::IpSubnet> object represents a range of IP addresses
  54. (IPv4/IPv6). A socket connection can be matched against this range to
  55. test whether the IP it's coming from is inside or outside of this
  56. range.
  57.  
  58.  
  59.  
  60.  
  61. =head1 API
  62.  
  63. C<APR::IpSubnet> provides the following functions and/or methods:
  64.  
  65.  
  66.  
  67. =head2 C<new>
  68.  
  69. Create an IP subnet represenation object
  70.  
  71.   $ipsubnet = APR::IpSubnet->new($pool, $ip);
  72.   $ipsubnet = APR::IpSubnet->new($pool, $ip, $mask_or_numbits);
  73.  
  74. =over 4
  75.  
  76. =item obj: C<APR::IpSubnet> (class name)
  77.  
  78. =item arg1: C<$pool>
  79. ( C<L<APR::Pool object|docs::2.0::api::APR::Pool>> )
  80.  
  81. =item arg2: C<$ip> ( string )
  82.  
  83. IP address in one of the two formats: IPv4 (e.g. I<"127.0.0.1">) or
  84. IPv6 (e.g. I<"::1">). IPv6 addresses are accepted only if APR has the
  85. IPv6 support enabled.
  86.  
  87. =item opt arg3: C<$mask_or_numbits> ( string )
  88.  
  89. An optional IP mask (e.g. I<"255.0.0.0">) or number of bits
  90. (e.g. I<"15">).
  91.  
  92. If none provided, the default is not to mask off.
  93.  
  94. =item ret: C<$ret>
  95. ( C<L<APR::IpSubnet object|docs::2.0::api::APR::IpSubnet>> )
  96.  
  97. The IP-subnet object
  98.  
  99. =item excpt: C<L<APR::Error|docs::2.0::api::APR::Error>>
  100.  
  101. =item since: 1.99_15
  102.  
  103. =back
  104.  
  105.  
  106. =head2 C<test>
  107.  
  108. Test the IP address in the socket address object against a pre-built
  109. ip-subnet representation.
  110.  
  111.   $ret = $ipsub->test($sockaddr);
  112.  
  113. =over 4
  114.  
  115. =item obj: C<$ipsub>
  116. ( C<L<APR::IpSubnet object|docs::2.0::api::APR::IpSubnet>> )
  117.  
  118. The ip-subnet representation
  119.  
  120. =item arg1: C<$sockaddr>
  121. ( C<L<APR::SockAddr object|docs::2.0::api::APR::SockAddr>> )
  122.  
  123. The socket address to test
  124.  
  125. =item ret: C<$ret> ( boolean )
  126.  
  127. true if the socket address is within the subnet, false otherwise
  128.  
  129. =item since: 1.99_15
  130.  
  131. =back
  132.  
  133. This method is used for testing whether or not an address is within a
  134. subnet. It's used by module C<mod_access> to check whether the client
  135. IP fits into the IP range, supplied by C<Allow>/C<Deny> directives.
  136.  
  137. Example:
  138.  
  139. Allow accesses only from the localhost (IPv4):
  140.  
  141.   use APR::IpSubnet ();
  142.   use Apache::Connection ();
  143.   use Apache::RequestRec ();
  144.   my $ipsub = APR::IpSubnet->new($r->pool, "127.0.0.1");
  145.   ok $ipsub->test($r->connection->remote_addr);
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153. =head1 See Also
  154.  
  155. L<mod_perl 2.0 documentation|docs::2.0::index>.
  156.  
  157.  
  158.  
  159.  
  160. =head1 Copyright
  161.  
  162. mod_perl 2.0 and its core modules are copyrighted under
  163. The Apache Software License, Version 2.0.
  164.  
  165.  
  166.  
  167.  
  168. =head1 Authors
  169.  
  170. L<The mod_perl development team and numerous
  171. contributors|about::contributors::people>.
  172.  
  173. =cut
  174.  
  175.