apache2::cmdparms.3

视频监控网络部分的协议ddns,的模块的实现代码,请大家大胆指正.

.\" 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::CmdParms 3"
.TH mod_perl-2.0.2::docs::api::Apache2::CmdParms 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::CmdParms \- Perl API for Apache command parameters object
.SH "Synopsis"
.IX Header "Synopsis"
.Vb 3
\&  use Apache2::CmdParms ();
\&  use Apache2::Module ();
\&  use Apache2::Const \-compile => qw(NOT_IN_LOCATION);
\&  
\&  my @directives = (
\&    {
\&      name => \*(AqMyDirective\*(Aq,
\&      cmd_data => \*(Aqsome extra data\*(Aq,
\&    },
\&  );
\&  
\&  Apache2::Module::add(_\|_PACKAGE_\|_, \e@directives);
\&  
\&  sub MyDirective {
\&      my ($self, $parms, $args) = @_;
\&  
\&      # push config
\&      $parms\->add_config([\*(AqServerTokens off\*(Aq]);
\&  
\&      # this command\*(Aqs command object
\&      $cmd = $parms\->cmd;
\&  
\&      # check the current command\*(Aqs context
\&      $error = $parms\->check_cmd_context(Apache2::Const::NOT_IN_LOCATION);
\&  
\&      # this command\*(Aqs context
\&      $context = $parms\->context;
\&  
\&      # this command\*(Aqs directive object
\&      $directive = $parms\->directive;
\&  
\&      # the extra information passed thru cmd_data to
\&      # Apache2::Module::add()
\&      $info = $parms\->info;
\&  
\&      # which methods are <Limit>ed ?
\&      $is_limited = $parms\->method_is_limited(\*(AqGET\*(Aq);
\&  
\&      # which allow\-override bits are set
\&      $override = $parms\->override;
\&  
\&      # the path this command is being invoked in
\&      $path = $parms\->path;
\&  
\&      # this command\*(Aqs pool
\&      $p = $parms\->pool;
\&  
\&      # this command\*(Aqs configuration time pool
\&      $p = $parms\->temp_pool;
\&  }
.Ve
.SH "Description"
.IX Header "Description"
\&\f(CW\*(C`Apache2::CmdParms\*(C'\fR provides the Perl \s-1API\s0 for Apache command
parameters object.
.SH "API"
.IX Header "API"
\&\f(CW\*(C`Apache2::CmdParms\*(C'\fR provides the following functions and/or methods:
.ie n .Sh """add_config"""
.el .Sh "\f(CWadd_config\fP"
.IX Subsection "add_config"
Dynamically add Apache configuration at request processing runtime:
.PP
.Vb 1
\&  $parms\->add_config($lines);
.Ve
.ie n .IP "obj: $parms\fR ( \f(CW""Apache2::CmdParms object"" )" 4
.el .IP "obj: \f(CW$parms\fR ( \f(CWApache2::CmdParms object\fR )" 4
.IX Item "obj: $parms ( Apache2::CmdParms object )"
.PD 0
.ie n .IP "arg1: $lines (\s-1ARRAY\s0 ref)" 4
.el .IP "arg1: \f(CW$lines\fR (\s-1ARRAY\s0 ref)" 4
.IX Item "arg1: $lines (ARRAY ref)"
.PD
An \s-1ARRAY\s0 reference containing configuration lines per element, without
the new line terminators.
.IP "ret: no return value" 4
.IX Item "ret: no return value"
.PD 0
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PD
.PP
See also:
\&\f(CW\*(C`$s\->add_config\*(C'\fR,
\&\f(CW\*(C`$r\->add_config\*(C'\fR
.ie n .Sh """check_cmd_context"""
.el .Sh "\f(CWcheck_cmd_context\fP"
.IX Subsection "check_cmd_context"
Check the current command against a context bitmask of forbidden contexts.
.PP
.Vb 1
\&  $error = $parms\->check_cmd_context($check);
.Ve
.ie n .IP "obj: $parms\fR ( \f(CW""Apache2::CmdParms object"" )" 4
.el .IP "obj: \f(CW$parms\fR ( \f(CWApache2::CmdParms object\fR )" 4
.IX Item "obj: $parms ( Apache2::CmdParms object )"
.PD 0
.ie n .IP "arg1: $check\fR ( \f(CW""Apache2::Const :context constant"" )" 4
.el .IP "arg1: \f(CW$check\fR ( \f(CWApache2::Const :context constant\fR )" 4
.IX Item "arg1: $check ( Apache2::Const :context constant )"
.PD
the context to check against.
.ie n .IP "ret: $error ( string / undef )" 4
.el .IP "ret: \f(CW$error\fR ( string / undef )" 4
.IX Item "ret: $error ( string / undef )"
If the context is forbidden, this method returns a textual description
of why it was forbidden. If the context is permitted, this method returns
\&\f(CW\*(C`undef\*(C'\fR.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PP
For example here is how to check whether a command is allowed in the
\&\f(CW\*(C`<Location>\*(C'\fR container:
.PP
.Vb 4
\&  use Apache2::Const \-compile qw(NOT_IN_LOCATION);
\&  if (my $error = $parms\->check_cmd_context(Apache2::Const::NOT_IN_LOCATION)) {
\&      die "directive ... not allowed in <Location> context"
\&  }
.Ve
.ie n .Sh """cmd"""
.el .Sh "\f(CWcmd\fP"
.IX Subsection "cmd"
This module's command information
.PP
.Vb 1
\&  $cmd = $parms\->cmd();
.Ve