perl-docs-cvs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From s...@apache.org
Subject cvs commit: modperl-docs/src/docs/2.0/api/Apache Process.pod
Date Fri, 16 Jul 2004 21:36:52 GMT
stas        2004/07/16 14:36:52

  Modified:    src/docs/2.0/api/Apache Process.pod
  Log:
  Apache::Process manpage is complete
  
  Revision  Changes    Path
  1.4       +56 -19    modperl-docs/src/docs/2.0/api/Apache/Process.pod
  
  Index: Process.pod
  ===================================================================
  RCS file: /home/cvs/modperl-docs/src/docs/2.0/api/Apache/Process.pod,v
  retrieving revision 1.3
  retrieving revision 1.4
  diff -u -u -r1.3 -r1.4
  --- Process.pod	22 May 2004 02:03:27 -0000	1.3
  +++ Process.pod	16 Jul 2004 21:36:52 -0000	1.4
  @@ -1,6 +1,6 @@
   =head1 NAME
   
  -Apache::Process - Perl API for XXX
  +Apache::Process - Perl API for Apache process record
   
   
   
  @@ -8,15 +8,31 @@
   =head1 Synopsis
   
     use Apache::Process ();
  +  use Apache::ServerRec ();
  +  my $proc = $s->process;
  +  
  +  # global pool cleared on exit
  +  my $global_pool = $proc->pool;
  +  
  +  # configuration pool cleared on restart
  +  my $pconf = $proc->pconf;
  +  
  +  # short program name (e.g. httpd)
  +  my $proc_name = $proc->short_name;
  +
   
  -META: to be completed
   
   
   
   
   =head1 Description
   
  -META: to be completed
  +C<Apache::Process> provides the API for the Apache process object,
  +which you can retrieve with
  +C<L<$s-<Egt>process|docs::2.0::api::Apache::ServerRec/C_process_>>:
  +
  +  use Apache::ServerRec ();
  +  $proc = $s->process;
   
   
   
  @@ -28,49 +44,60 @@
   
   
   
  -=head2 C<pool>
  -
  -META: Autogenerated - needs to be reviewed/completed
  +=head2 C<pconf>
   
  -Global pool. Cleared upon normal exit
  +Get configuration pool object.
   
  -  $p = $proc->pool();
  +  $p = $proc->pconf();
   
   =over 4
   
  -=item obj: C<$proc> (C<L<Apache::Process|docs::2.0::api::Apache::Process>>)
  +=item obj: C<$proc>
  +( C<L<Apache::Process object|docs::2.0::api::Apache::Process>> )
  +
  +=item ret: C<$p>
  +( C<L<APR::Pool object|docs::2.0::api::APR::Pool>> )
   
  -=item ret: C<$p> (C<L<APR::Pool|docs::2.0::api::APR::Pool>>)
  +=item since: 1.99_15
   
   =back
   
  +This pool object gets cleared on server restart.
  +
  +
   
   
   
   
  -=head2 C<pconf>
   
  -META: Autogenerated - needs to be reviewed/completed
  +=head2 C<pool>
   
  -Configuration pool. Cleared upon restart
  +Get the global pool object.
   
  -  $p = $proc->pconf($newval);
  +  $p = $proc->pool();
   
   =over 4
   
  -=item obj: C<$proc> (C<L<Apache::Process|docs::2.0::api::Apache::Process>>)
  +=item obj: C<$proc>
  +( C<L<Apache::Process object|docs::2.0::api::Apache::Process>> )
  +
  +=item ret: C<$p>
  +( C<L<APR::Pool object|docs::2.0::api::APR::Pool>> )
   
  -=item ret: C<$p> (C<L<APR::Pool|docs::2.0::api::APR::Pool>>)
  +=item since: 1.99_15
   
   =back
   
  +This pool object gets cleared only on (normal) server exit
  +
  +
   
   
   
   
  -=head2 C<short_name>
   
  -META: Autogenerated - needs to be reviewed/completed
  +
  +=head2 C<short_name>
   
   The name of the program used to execute the program
   
  @@ -78,11 +105,21 @@
   
   =over 4
   
  -=item obj: C<$proc> (C<L<Apache::Process|docs::2.0::api::Apache::Process>>)
  +=item obj: C<$proc>
  +( C<L<Apache::Process object|docs::2.0::api::Apache::Process>> )
   
   =item ret: C<$short_name> (string)
   
  +e.g. C<httpd>
  +
  +=item since: 1.99_15
  +
   =back
  +
  +
  +
  +
  +
   
   
   
  
  
  

---------------------------------------------------------------------
To unsubscribe, e-mail: docs-cvs-unsubscribe@perl.apache.org
For additional commands, e-mail: docs-cvs-help@perl.apache.org


Mime
View raw message