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 / Process.pm < prev    next >
Encoding:
Perl POD Document  |  2004-09-23  |  2.7 KB  |  181 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 Apache::Process;
  18.  
  19. use strict;
  20. use warnings FATAL => 'all';
  21.  
  22.  
  23.  
  24. use Apache::XSLoader ();
  25. our $VERSION = '0.01';
  26. Apache::XSLoader::load __PACKAGE__;
  27.  
  28.  
  29.  
  30. 1;
  31. __END__
  32.  
  33. =head1 NAME
  34.  
  35. Apache::Process - Perl API for Apache process record
  36.  
  37.  
  38.  
  39.  
  40. =head1 Synopsis
  41.  
  42.   use Apache::Process ();
  43.   use Apache::ServerRec ();
  44.   my $proc = $s->process;
  45.   
  46.   # global pool cleared on exit
  47.   my $global_pool = $proc->pool;
  48.   
  49.   # configuration pool cleared on restart
  50.   my $pconf = $proc->pconf;
  51.   
  52.   # short program name (e.g. httpd)
  53.   my $proc_name = $proc->short_name;
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60. =head1 Description
  61.  
  62. C<Apache::Process> provides the API for the Apache process object,
  63. which you can retrieve with
  64. C<L<$s-E<gt>process|docs::2.0::api::Apache::ServerRec/C_process_>>:
  65.  
  66.   use Apache::ServerRec ();
  67.   $proc = $s->process;
  68.  
  69.  
  70.  
  71.  
  72. =head1 API
  73.  
  74. C<Apache::Process> provides the following functions and/or methods:
  75.  
  76.  
  77.  
  78.  
  79. =head2 C<pconf>
  80.  
  81. Get configuration pool object.
  82.  
  83.   $p = $proc->pconf();
  84.  
  85. =over 4
  86.  
  87. =item obj: C<$proc>
  88. ( C<L<Apache::Process object|docs::2.0::api::Apache::Process>> )
  89.  
  90. =item ret: C<$p>
  91. ( C<L<APR::Pool object|docs::2.0::api::APR::Pool>> )
  92.  
  93. =item since: 1.99_15
  94.  
  95. =back
  96.  
  97. This pool object gets cleared on server restart.
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105. =head2 C<pool>
  106.  
  107. Get the global pool object.
  108.  
  109.   $p = $proc->pool();
  110.  
  111. =over 4
  112.  
  113. =item obj: C<$proc>
  114. ( C<L<Apache::Process object|docs::2.0::api::Apache::Process>> )
  115.  
  116. =item ret: C<$p>
  117. ( C<L<APR::Pool object|docs::2.0::api::APR::Pool>> )
  118.  
  119. =item since: 1.99_15
  120.  
  121. =back
  122.  
  123. This pool object gets cleared only on (normal) server exit
  124.  
  125.  
  126.  
  127.  
  128.  
  129.  
  130.  
  131.  
  132. =head2 C<short_name>
  133.  
  134. The name of the program used to execute the program
  135.  
  136.   $short_name = $proc->short_name();
  137.  
  138. =over 4
  139.  
  140. =item obj: C<$proc>
  141. ( C<L<Apache::Process object|docs::2.0::api::Apache::Process>> )
  142.  
  143. =item ret: C<$short_name> (string)
  144.  
  145. e.g. C<httpd>
  146.  
  147. =item since: 1.99_15
  148.  
  149. =back
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159. =head1 See Also
  160.  
  161. L<mod_perl 2.0 documentation|docs::2.0::index>.
  162.  
  163.  
  164.  
  165.  
  166. =head1 Copyright
  167.  
  168. mod_perl 2.0 and its core modules are copyrighted under
  169. The Apache Software License, Version 2.0.
  170.  
  171.  
  172.  
  173.  
  174. =head1 Authors
  175.  
  176. L<The mod_perl development team and numerous
  177. contributors|about::contributors::people>.
  178.  
  179. =cut
  180.  
  181.