.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "docs::api::Apache2::Process 3pm"
.TH docs::api::Apache2::Process 3pm 2024-03-29 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Apache2::Process \- Perl API for Apache process record
.SH Synopsis
.IX Header "Synopsis"
.Vb 3
\&  use Apache2::Process ();
\&  use Apache2::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;
.Ve
.SH Description
.IX Header "Description"
\&\f(CW\*(C`Apache2::Process\*(C'\fR provides the API for the Apache process object,
which you can retrieve with
\&\f(CW\*(C`$s\->process\*(C'\fR:
.PP
.Vb 2
\&  use Apache2::ServerRec ();
\&  $proc = $s\->process;
.Ve
.SH API
.IX Header "API"
\&\f(CW\*(C`Apache2::Process\*(C'\fR provides the following functions and/or methods:
.ie n .SS """pconf"""
.el .SS \f(CWpconf\fP
.IX Subsection "pconf"
Get configuration pool object.
.PP
.Vb 1
\&  $p = $proc\->pconf();
.Ve
.ie n .IP "obj: $proc ( ""Apache2::Process object"" )" 4
.el .IP "obj: \f(CW$proc\fR ( \f(CWApache2::Process object\fR )" 4
.IX Item "obj: $proc ( Apache2::Process object )"
.PD 0
.ie n .IP "ret: $p ( ""APR::Pool object"" )" 4
.el .IP "ret: \f(CW$p\fR ( \f(CWAPR::Pool object\fR )" 4
.IX Item "ret: $p ( APR::Pool object )"
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PD
.PP
This pool object gets cleared on server restart.
.ie n .SS """pool"""
.el .SS \f(CWpool\fP
.IX Subsection "pool"
Get the global pool object.
.PP
.Vb 1
\&  $p = $proc\->pool();
.Ve
.ie n .IP "obj: $proc ( ""Apache2::Process object"" )" 4
.el .IP "obj: \f(CW$proc\fR ( \f(CWApache2::Process object\fR )" 4
.IX Item "obj: $proc ( Apache2::Process object )"
.PD 0
.ie n .IP "ret: $p ( ""APR::Pool object"" )" 4
.el .IP "ret: \f(CW$p\fR ( \f(CWAPR::Pool object\fR )" 4
.IX Item "ret: $p ( APR::Pool object )"
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PD
.PP
This pool object gets cleared only on (normal) server exit
.ie n .SS """short_name"""
.el .SS \f(CWshort_name\fP
.IX Subsection "short_name"
The name of the program used to execute the program
.PP
.Vb 1
\&  $short_name = $proc\->short_name();
.Ve
.ie n .IP "obj: $proc ( ""Apache2::Process object"" )" 4
.el .IP "obj: \f(CW$proc\fR ( \f(CWApache2::Process object\fR )" 4
.IX Item "obj: $proc ( Apache2::Process object )"
.PD 0
.ie n .IP "ret: $short_name (string)" 4
.el .IP "ret: \f(CW$short_name\fR (string)" 4
.IX Item "ret: $short_name (string)"
.PD
e.g. \f(CW\*(C`httpd\*(C'\fR
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.SH "See Also"
.IX Header "See Also"
mod_perl 2.0 documentation.
.SH Copyright
.IX Header "Copyright"
mod_perl 2.0 and its core modules are copyrighted under
The Apache Software License, Version 2.0.
.SH Authors
.IX Header "Authors"
The mod_perl development team and numerous
contributors.