apache2::cmdparms.3

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

.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 "ret: $cmd\fR ( \f(CW""Apache2::Command object"" )" 4
.el .IP "ret: \f(CW$cmd\fR ( \f(CWApache2::Command object\fR )" 4
.IX Item "ret: $cmd ( Apache2::Command object )"
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PD
.ie n .Sh """directive"""
.el .Sh "\f(CWdirective\fP"
.IX Subsection "directive"
This command's directive object in the configuration tree
.PP
.Vb 1
\&  $directive = $parms\->directive;
.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 "ret: $directive\fR ( \f(CW""Apache2::Directive object"" )" 4
.el .IP "ret: \f(CW$directive\fR ( \f(CWApache2::Directive object\fR )" 4
.IX Item "ret: $directive ( Apache2::Directive object )"
.PD
The current directive node in the configuration tree
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.ie n .Sh """info"""
.el .Sh "\f(CWinfo\fP"
.IX Subsection "info"
The extra information passed through \f(CW\*(C`cmd_data\*(C'\fR in
\&\f(CW\*(C`Apache2::Module::add()\*(C'\fR.
.PP
.Vb 1
\&  $info = $parms\->info;
.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 "ret: $info ( string )" 4
.el .IP "ret: \f(CW$info\fR ( string )" 4
.IX Item "ret: $info ( string )"
.PD
The string passed in \f(CW\*(C`cmd_data\*(C'\fR
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PP
For example here is how to pass arbitrary information to a directive
subroutine:
.PP
.Vb 10
\&  my @directives = (
\&    {
\&      name => \*(AqMyDirective1\*(Aq,
\&      func => \e&MyDirective,
\&      cmd_data => \*(AqOne\*(Aq,
\&    },
\&    {
\&      name => \*(AqMyDirective2\*(Aq,
\&      func => \e&MyDirective,
\&      cmd_data => \*(AqTwo\*(Aq,
\&    },
\&  );
\&  Apache2::Module::add(_\|_PACKAGE_\|_, \e@directives);
\&  
\&  sub MyDirective {
\&    my ($self, $parms, $args) = @_;
\&    my $info = $parms\->info;
\&  }
.Ve
.PP
In this example \f(CW$info\fR will either be \f(CW\*(AqOne\*(Aq\fR or \f(CW\*(AqTwo\*(Aq\fR depending
on whether the directive was called as \fIMyDirective1\fR or
\&\fIMyDirective2\fR.
.ie n .Sh """method_is_limited"""
.el .Sh "\f(CWmethod_is_limited\fP"
.IX Subsection "method_is_limited"
Discover if a method is <Limit>ed in the current scope
.PP
.Vb 1
\&  $is_limited = $parms\->method_is_limited($method);
.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: $method (string)" 4
.el .IP "arg1: \f(CW$method\fR (string)" 4
.IX Item "arg1: $method (string)"
.PD
The name of the method to check for
.ie n .IP "ret: $is_limited ( boolean )" 4
.el .IP "ret: \f(CW$is_limited\fR ( boolean )" 4
.IX Item "ret: $is_limited ( boolean )"
.PD 0
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PD
.PP
For example, to check if the \f(CW\*(C`GET\*(C'\fR method is being
\&\f(CW\*(C`<Limit>\*(C'\fRed in the current scope, do:
.PP
.Vb 3
\&  if ($parms\->method_is_limited(\*(AqGET\*(Aq) {
\&      die "...";
\&  }
.Ve
.ie n .Sh """override"""
.el .Sh "\f(CWoverride\fP"
.IX Subsection "override"
Which allow-override bits are set (\f(CW\*(C`AllowOverride\*(C'\fR directive)
.PP
.Vb 1
\&  $override = $parms\->override;
.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 "ret: $override ( bitmask )" 4
.el .IP "ret: \f(CW$override\fR ( bitmask )" 4
.IX Item "ret: $override ( bitmask )"
.PD
the allow-override bits bitmask, which can be tested against
\&\f(CW\*(C`Apache2::Const :override
constants\*(C'\fR.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PP
For example to check that the \f(CW\*(C`AllowOverride\*(C'\fR's \f(CW\*(C`AuthConfig\*(C'\fR and
\&\f(CW\*(C`FileInfo\*(C'\fR options are enabled for this command, do:
.PP
.Vb 6
\&  use Apache2::Const \-compile qw(:override);
\&  $wanted = Apache2::Const::OR_AUTHCFG | Apache2::Const::OR_FILEINFO;
\&  $masked = $parms\->override & $wanted;
\&  unless ($wanted == $masked) {
\&      die "...";
\&  }
.Ve
.ie n .Sh """path"""
.el .Sh "\f(CWpath\fP"
.IX Subsection "path"
The current pathname/location/match of the block this command is in
.PP
.Vb 1
\&  $path = $parms\->path;
.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 "ret: $path\fR ( string / \f(CW""undef"" )" 4
.el .IP "ret: \f(CW$path\fR ( string / \f(CWundef\fR )" 4
.IX Item "ret: $path ( string / undef )"
.PD
If configuring for a block like <Location>,
<LocationMatch>, <Directory>, etc., the pathname part
of that directive. Otherwise, \f(CW\*(C`undef\*(C'\fR is returned.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PP
For example for a container block:
.PP
.Vb 3
\&  <Location /foo>
\&  ...
\&  </Location>
.Ve
.PP
\&\fI'/foo'\fR will be returned.
.ie n .Sh """pool"""
.el .Sh "\f(CWpool\fP"
.IX Subsection "pool"
Pool associated with this command
.PP
.Vb 1
\&  $p = $parms\->pool;
.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 "ret: $p\fR ( \f(CW""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
.ie n .Sh """server"""
.el .Sh "\f(CWserver\fP"
.IX Subsection "server"
The (vhost) server this command was defined in \fIhttpd.conf\fR
.PP
.Vb 1
\&  $s = $parms\->server;
.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 "ret: $s\fR ( \f(CW""Apache2::Server object"" )" 4
.el .IP "ret: \f(CW$s\fR ( \f(CWApache2::Server object\fR )" 4
.IX Item "ret: $s ( Apache2::Server object )"
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PD
.ie n .Sh """temp_pool"""
.el .Sh "\f(CWtemp_pool\fP"
.IX Subsection "temp_pool"
Pool for scratch memory; persists during configuration, but destroyed
before the first request is served.
.PP
.Vb 1
\&  $temp_pool = $parms\->temp_pool;
.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 "ret: $temp_pool\fR ( \f(CW""APR::Pool object"" )" 4
.el .IP "ret: \f(CW$temp_pool\fR ( \f(CWAPR::Pool object\fR )" 4
.IX Item "ret: $temp_pool ( APR::Pool object )"
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PD
.PP
Most likely you shouldn't use this pool object, unless you know what
you are doing. Use \f(CW\*(C`$parms\->pool\*(C'\fR instead.
.SH "Unsupported API"
.IX Header "Unsupported API"
\&\f(CW\*(C`Apache2::CmdParms\*(C'\fR also provides auto-generated Perl interface for
a few other methods which aren't tested at the moment and therefore
their \s-1API\s0 is a subject to change. These methods will be finalized
later as a need arises. If you want to rely on any of the following
methods please contact the the mod_perl development mailing
list so we can help each other take the steps necessary
to shift the method to an officially supported \s-1API\s0.
.ie n .Sh """context"""
.el .Sh "\f(CWcontext\fP"
.IX Subsection "context"
Get context containing pointers to modules' per-dir
config structures.
.PP
.Vb 1
\&  $context = $parms\->context;
.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 "ret: $newval\fR ( \f(CW""Apache2::ConfVector object"" )" 4
.el .IP "ret: \f(CW$newval\fR ( \f(CWApache2::ConfVector object\fR )" 4
.IX Item "ret: $newval ( Apache2::ConfVector object )"
.PD
Returns the commands' per-dir config structures
.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.