apr::ipsubnet(3) [osx man page]

apache_mod_perl-108~358::mod_perl-2.0.7::docs::api::APR:UseruContributed Perl apache_mod_perl-108~358::mod_perl-2.0.7::docs::api::APR::IpSubnet(3)

NAME

       APR::IpSubnet - Perl API for accessing APRs ip_subnet structures

Synopsis
	 use APR::IpSubnet ();

	 my $ipsub = APR::IpSubnet->new($pool, "127.0.0.1");
	 $ok = $ipsub->test($sock_addr);

Description
       "APR::IpSubnet" object represents a range of IP addresses (IPv4/IPv6). A socket connection can be matched against this range to test
       whether the IP it's coming from is inside or outside of this range.

API

       "APR::IpSubnet" provides the following functions and/or methods:

   "new"
       Create an IP subnet represenation object

	 $ipsubnet = APR::IpSubnet->new($pool, $ip);
	 $ipsubnet = APR::IpSubnet->new($pool, $ip, $mask_or_numbits);

       obj: "APR::IpSubnet" (class name)
       arg1: $pool ( "APR::Pool object" )
       arg2: $ip ( string )
	   IP address in one of the two formats: IPv4 (e.g. "127.0.0.1") or IPv6 (e.g. "::1"). IPv6 addresses are accepted only if APR has the
	   IPv6 support enabled.

       opt arg3: $mask_or_numbits ( string )
	   An optional IP mask (e.g. "255.0.0.0") or number of bits (e.g. "15").

	   If none provided, the default is not to mask off.

       ret: $ret ( "APR::IpSubnet object" )
	   The IP-subnet object

       excpt: "APR::Error"
       since: 2.0.00

   "test"
       Test the IP address in the socket address object against a pre-built ip-subnet representation.

	 $ret = $ipsub->test($sockaddr);

       obj: $ipsub ( "APR::IpSubnet object" )
	   The ip-subnet representation

       arg1: $sockaddr ( "APR::SockAddr object" )
	   The socket address to test

       ret: $ret ( boolean )
	   true if the socket address is within the subnet, false otherwise

       since: 2.0.00

       This method is used for testing whether or not an address is within a subnet. It's used by module "mod_access" to check whether the client
       IP fits into the IP range, supplied by "Allow"/"Deny" directives.

       Example:

       Allow accesses only from the localhost (IPv4):

	 use APR::IpSubnet ();
	 use Apache2::Connection ();
	 use Apache2::RequestRec ();
	 my $ipsub = APR::IpSubnet->new($r->pool, "127.0.0.1");
	 ok $ipsub->test($r->connection->remote_addr);

See Also
       mod_perl 2.0 documentation.

Copyright
       mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.

Authors
       The mod_perl development team and numerous contributors.

perl v5.16.2							    2011-02-07apache_mod_perl-108~358::mod_perl-2.0.7::docs::api::APR::IpSubnet(3)

apache_mod_perl-108~358::mod_perl-2.0.7::docs::api::APR:UserkContributed Perl apache_mod_perl-108~358::mod_perl-2.0.7::docs::api::APR::SockAddr(3)

NAME

       APR::SockAddr - Perl API for APR socket address structure

Synopsis
	 use APR::SockAddr ();

	 my $ip = $sock_addr->ip_get;
	 my $port = $sock_addr->port;

Description
       "APR::SockAddr" provides an access to a socket address structure fields.

       Normally you'd get a socket address object, by calling:

	 use Apache2::Connection ();
	 my $remote_sock_addr = $c->remote_addr;
	 my $local_sock_addr  = $c->remote_local;

API

       "APR::SockAddr" provides the following functions and/or methods:

   "ip_get"
       Get the IP address of the socket

	 $ip = $sock_addr->ip_get();

       obj: $sock_addr ( "APR::SockAddr object" )
       ret: $ip ( string )
       since: 2.0.00

       If you are familiar with how perl's "Socket" works:

	 use Socket 'sockaddr_in';
	 my ($serverport, $serverip) = sockaddr_in(getpeername($local_sock));
	 my ($remoteport, $remoteip) = sockaddr_in(getpeername($remote_sock));

       in apr-speak that'd be written as:

	 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;

   "port"
       Get the IP address of the socket

	 $port = $sock_addr->port();

       obj: $sock_addr ( "APR::SockAddr object" )
       ret: $port ( integer )
       since: 2.0.00

       Example: see "ip_get()"

Unsupported API
       "APR::SockAddr" 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 the mod_perl development mailing list so we can help each other take the steps necessary to shift the method to an
       officially supported API.

   "equal"
       META: Autogenerated - needs to be reviewed/completed

       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.

	 $ret = $addr1->equal($addr2);

       obj: $addr1 ( "APR::SockAddr object" )
	   One of the APR socket addresses.

       arg1: $addr2 ( "APR::SockAddr object" )
	   The other APR socket address.

       ret: $ret ( integer )
       since: subject to change

       The return value will be non-zero if the addresses are equivalent.

See Also
       mod_perl 2.0 documentation.

Copyright
       mod_perl 2.0 and its core modules are copyrighted under The Apache Software License, Version 2.0.

Authors
       The mod_perl development team and numerous contributors.

perl v5.16.2							    2011-02-07apache_mod_perl-108~358::mod_perl-2.0.7::docs::api::APR::SockAddr(3)