apache2::serverrec.3

来自「视频监控网络部分的协议ddns,的模块的实现代码,请大家大胆指正.」· 3 代码 · 共 838 行 · 第 1/2 页

.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.05)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'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 turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "mod_perl-2.0.2::docs::api::Apache2::ServerRec 3"
.TH mod_perl-2.0.2::docs::api::Apache2::ServerRec 3 "2005-10-21" "perl v5.10.0" "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::ServerRec \- Perl API for Apache server record accessors
.SH "Synopsis"
.IX Header "Synopsis"
.Vb 1
\&  use Apache2::ServerRec ();
\&  
\&  $error_fname = $s\->error_fname();
\&  
\&  $is_virtual = $s\->is_virtual();
\&  
\&  $keep_alive         = $s\->keep_alive();
\&  $keep_alive_max     = $s\->keep_alive_max();
\&  $keep_alive_timeout = $s\->keep_alive_timeout();
\&  
\&  $limit_req_fields    = $s\->limit_req_fields();
\&  $limit_req_fieldsize = $s\->limit_req_fieldsize();
\&  $limit_req_line      = $s\->limit_req_line();
\&  
\&  $path = $s\->path();
\&  
\&  $hostname = $s\->server_hostname();
\&  $port     = $s\->port();
\&  
\&  $server_admin = $s\->server_admin();
\&  
\&  $proc = $s\->process();
\&  
\&  $timeout  = $s\->timeout();
\&  $loglevel = $s\->loglevel();
\&  
\&  my $server = Apache2::ServerUtil\->server;
\&  my $vhosts = 0;
\&  for (my $s = $server\->next; $s; $s = $s\->next) {
\&      $vhosts++;
\&  }
\&  print "There are $vhosts virtual hosts";
.Ve
.SH "Description"
.IX Header "Description"
\&\f(CW\*(C`Apache2::ServerRec\*(C'\fR provides the Perl \s-1API\s0 for Apache server_rec
object.
.PP
\&\f(CW\*(C`Apache2::ServerUtil\*(C'\fR provides
an extra functionality.
.SH "API"
.IX Header "API"
\&\f(CW\*(C`Apache2::ServerRec\*(C'\fR provides the following functions and/or methods:
.ie n .Sh """error_fname"""
.el .Sh "\f(CWerror_fname\fP"
.IX Subsection "error_fname"
Get/set the \f(CW\*(C`ErrorLog\*(C'\fR file value (e.g. \fIlogs/error_log\fR)
.PP
.Vb 2
\&  $error_fname      = $s\->error_fname();
\&  $prev_error_fname = $s\->error_fname($new_error_fname);
.Ve
.ie n .IP "obj: $s\fR ( \f(CW""Apache2::ServerRec object"" )" 4
.el .IP "obj: \f(CW$s\fR ( \f(CWApache2::ServerRec object\fR )" 4
.IX Item "obj: $s ( Apache2::ServerRec object )"
.PD 0
.ie n .IP "opt arg1: $new_error_fname ( string )" 4
.el .IP "opt arg1: \f(CW$new_error_fname\fR ( string )" 4
.IX Item "opt arg1: $new_error_fname ( string )"
.PD
If passed, sets the new value for \f(CW\*(C`ErrorLog\*(C'\fR
.Sp
Note the limited functionality under threaded
MPMs.
.ie n .IP "ret: $error_fname ( string )" 4
.el .IP "ret: \f(CW$error_fname\fR ( string )" 4
.IX Item "ret: $error_fname ( string )"
Returns the \f(CW\*(C`ErrorLog\*(C'\fR value setting.
.Sp
If \f(CW$new_error_fname\fR is passed returns the setting before the change.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.ie n .Sh """is_virtual"""
.el .Sh "\f(CWis_virtual\fP"
.IX Subsection "is_virtual"
Test whether \f(CW$s\fR is a virtual host object
.PP
.Vb 1
\&  $is_virtual = $s\->is_virtual();
.Ve
.ie n .IP "obj: $s\fR ( \f(CW""Apache2::ServerRec object"" )" 4
.el .IP "obj: \f(CW$s\fR ( \f(CWApache2::ServerRec object\fR )" 4
.IX Item "obj: $s ( Apache2::ServerRec object )"
.PD 0
.ie n .IP "ret: $is_virtual ( boolean )" 4
.el .IP "ret: \f(CW$is_virtual\fR ( boolean )" 4
.IX Item "ret: $is_virtual ( boolean )"
.PD
Returns the is_virtual setting.
.Sp
If \f(CW$new_is_virtual\fR is passed, returns the setting before the
change.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PP
Example:
.PP
.Vb 1
\&  print "This is a virtual host" if $s\->is_virtual();
.Ve
.ie n .Sh """keep_alive"""
.el .Sh "\f(CWkeep_alive\fP"
.IX Subsection "keep_alive"
Get/set the \f(CW\*(C`KeepAlive\*(C'\fR setting, which specifies whether Apache
should accept more than one request over the same connection from the
same client.
.PP
.Vb 2
\&  $keep_alive      = $s\->keep_alive();
\&  $prev_keep_alive = $s\->keep_alive($new_keep_alive);
.Ve
.ie n .IP "obj: $s\fR ( \f(CW""Apache2::ServerRec object"" )" 4
.el .IP "obj: \f(CW$s\fR ( \f(CWApache2::ServerRec object\fR )" 4
.IX Item "obj: $s ( Apache2::ServerRec object )"
.PD 0
.ie n .IP "opt arg1: $new_keep_alive ( boolean )" 4
.el .IP "opt arg1: \f(CW$new_keep_alive\fR ( boolean )" 4
.IX Item "opt arg1: $new_keep_alive ( boolean )"
.PD
If passed, sets the new keep_alive.
.Sp
Note the limited functionality under threaded
MPMs.
.ie n .IP "ret: $keep_alive ( boolean )" 4
.el .IP "ret: \f(CW$keep_alive\fR ( boolean )" 4
.IX Item "ret: $keep_alive ( boolean )"
Returns the \f(CW\*(C`KeepAlive\*(C'\fR setting.
.Sp
If \f(CW$new_keep_alive\fR is passed, returns the setting before the
change.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.ie n .Sh """keep_alive_max"""
.el .Sh "\f(CWkeep_alive_max\fP"
.IX Subsection "keep_alive_max"
Get/set the \f(CW\*(C`MaxKeepAliveRequest\*(C'\fR setting, which specifies the
maximum number of requests Apache will serve over a \f(CW\*(C`KeepAlive\*(C'\fR
connection.
.PP
.Vb 2
\&  $keep_alive_max      = $s\->keep_alive_max();
\&  $prev_keep_alive_max = $s\->keep_alive_max($new_keep_alive_max);
.Ve
.ie n .IP "obj: $s\fR ( \f(CW""Apache2::ServerRec object"" )" 4
.el .IP "obj: \f(CW$s\fR ( \f(CWApache2::ServerRec object\fR )" 4
.IX Item "obj: $s ( Apache2::ServerRec object )"
.PD 0
.ie n .IP "opt arg1: $new_keep_alive_max ( integer )" 4
.el .IP "opt arg1: \f(CW$new_keep_alive_max\fR ( integer )" 4
.IX Item "opt arg1: $new_keep_alive_max ( integer )"
.PD
If passed, sets the new keep_alive_max.
.Sp
Note the limited functionality under threaded
MPMs.
.ie n .IP "ret: $keep_alive_max ( integer )" 4
.el .IP "ret: \f(CW$keep_alive_max\fR ( integer )" 4
.IX Item "ret: $keep_alive_max ( integer )"
Returns the keep_alive_max setting.
.Sp
If \f(CW$new_keep_alive_max\fR is passed, returns the setting before the
change.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.ie n .Sh """keep_alive_timeout"""
.el .Sh "\f(CWkeep_alive_timeout\fP"
.IX Subsection "keep_alive_timeout"
Get/set the \f(CW\*(C`KeepAliveTimeout\*(C'\fR setting (in microsecs), which
specifies how long Apache will wait for another request before
breaking a \f(CW\*(C`KeepAlive\*(C'\fR connection.
.PP
.Vb 2
\&  $keep_alive_timeout      = $s\->keep_alive_timeout();
\&  $prev_keep_alive_timeout = $s\->keep_alive_timeout($new_timeout);
.Ve
.ie n .IP "obj: $s\fR ( \f(CW""Apache2::ServerRec object"" )" 4
.el .IP "obj: \f(CW$s\fR ( \f(CWApache2::ServerRec object\fR )" 4
.IX Item "obj: $s ( Apache2::ServerRec object )"
.PD 0
.ie n .IP "opt arg1: $new_keep_alive_timeout ( integer )" 4
.el .IP "opt arg1: \f(CW$new_keep_alive_timeout\fR ( integer )" 4
.IX Item "opt arg1: $new_keep_alive_timeout ( integer )"
.PD
The expected value is in microsecs.
.Sp
If passed, sets the new \f(CW\*(C`KeepAlive\*(C'\fR timeout.
.Sp
Note the limited functionality under threaded
MPMs.
.ie n .IP "ret: $keep_alive_timeout ( integer )" 4
.el .IP "ret: \f(CW$keep_alive_timeout\fR ( integer )" 4
.IX Item "ret: $keep_alive_timeout ( integer )"
Returns the \f(CW\*(C`KeepAlive\*(C'\fR timeout value (in microsecs).
.Sp
If \f(CW$new_timeout\fR is passed, returns the setting before the change.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.ie n .Sh """limit_req_fields"""
.el .Sh "\f(CWlimit_req_fields\fP"
.IX Subsection "limit_req_fields"
Get/set limit on number of request header fields
.PP
.Vb 2
\&  $limit_req_fields      = $s\->limit_req_fields();
\&  $prev_limit_req_fields = $s\->limit_req_fields($new_limit_req_fields);
.Ve
.ie n .IP "obj: $s\fR ( \f(CW""Apache2::ServerRec object"" )" 4
.el .IP "obj: \f(CW$s\fR ( \f(CWApache2::ServerRec object\fR )" 4
.IX Item "obj: $s ( Apache2::ServerRec object )"
.PD 0
.ie n .IP "opt arg1: $new_limit_req_fields ( integer )" 4
.el .IP "opt arg1: \f(CW$new_limit_req_fields\fR ( integer )" 4
.IX Item "opt arg1: $new_limit_req_fields ( integer )"
.PD
If passed, sets the new request headers number limit.
.Sp
Note the limited functionality under threaded
MPMs.
.ie n .IP "ret: $limit_req_fields ( integer )" 4
.el .IP "ret: \f(CW$limit_req_fields\fR ( integer )" 4
.IX Item "ret: $limit_req_fields ( integer )"
Returns the request headers number limit.
.Sp
If \f(CW$new_limit_req_fields\fR is passed, returns the setting before the
change.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.ie n .Sh """limit_req_fieldsize"""
.el .Sh "\f(CWlimit_req_fieldsize\fP"
.IX Subsection "limit_req_fieldsize"
Get/set limit on size of any request header field
.PP
.Vb 2
\&  $limit_req_fieldsize = $s\->limit_req_fieldsize();
\&  $prev_limit          = $s\->limit_req_fieldsize($new_limit);
.Ve
.ie n .IP "obj: $s\fR ( \f(CW""Apache2::ServerRec object"" )" 4
.el .IP "obj: \f(CW$s\fR ( \f(CWApache2::ServerRec object\fR )" 4
.IX Item "obj: $s ( Apache2::ServerRec object )"
.PD 0
.ie n .IP "opt arg1: $new_limit_req_fieldsize ( integer )" 4
.el .IP "opt arg1: \f(CW$new_limit_req_fieldsize\fR ( integer )" 4
.IX Item "opt arg1: $new_limit_req_fieldsize ( integer )"
.PD
If passed, sets the new request header size limit.
.Sp
Note the limited functionality under threaded
MPMs.
.ie n .IP "ret: $limit_req_fieldsize ( integer )" 4
.el .IP "ret: \f(CW$limit_req_fieldsize\fR ( integer )" 4
.IX Item "ret: $limit_req_fieldsize ( integer )"
Returns the request header size limit.
.Sp
If \f(CW$new_limit\fR is passed, returns the setting before the change.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.ie n .Sh """limit_req_line"""
.el .Sh "\f(CWlimit_req_line\fP"
.IX Subsection "limit_req_line"
Get/set limit on size of the \s-1HTTP\s0 request line
.PP
.Vb 2
\&  $limit_req_line      = $s\->limit_req_line();
\&  $prev_limit_req_line = $s\->limit_req_line($new_limit_req_line);
.Ve
.ie n .IP "obj: $s\fR ( \f(CW""Apache2::ServerRec object"" )" 4
.el .IP "obj: \f(CW$s\fR ( \f(CWApache2::ServerRec object\fR )" 4
.IX Item "obj: $s ( Apache2::ServerRec object )"
.PD 0
.ie n .IP "opt arg1: $new_limit_req_line ( integer )" 4
.el .IP "opt arg1: \f(CW$new_limit_req_line\fR ( integer )" 4
.IX Item "opt arg1: $new_limit_req_line ( integer )"
.PD
If passed, sets the new request line limit value.
.Sp