apache2::hookrun.3

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

.ie n .Sh """run_access_checker"""
.el .Sh "\f(CWrun_access_checker\fP"
.IX Subsection "run_access_checker"
Run the resource access
control phase.
.PP
.Vb 1
\&  $rc = $r\->run_access_checker();
.Ve
.ie n .IP "obj: $r\fR ( \f(CW""Apache2::RequestRec object"" )" 4
.el .IP "obj: \f(CW$r\fR ( \f(CWApache2::RequestRec object\fR )" 4
.IX Item "obj: $r ( Apache2::RequestRec object )"
the current request
.ie n .IP "ret: $rc ( integer )" 4
.el .IP "ret: \f(CW$rc\fR ( integer )" 4
.IX Item "ret: $rc ( integer )"
The status of the current phase run: \f(CW\*(C`Apache2::Const::OK\*(C'\fR,
\&\f(CW\*(C`Apache2::Const::DECLINED\*(C'\fR, \f(CW\*(C`Apache2::HTTP_...\*(C'\fR.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PP
This phase runs before a user is authenticated, so this hook is really
to apply additional restrictions independent of a user. It also runs
independent of '\f(CW\*(C`Require\*(C'\fR' directive usage.
.ie n .Sh """run_auth_checker"""
.el .Sh "\f(CWrun_auth_checker\fP"
.IX Subsection "run_auth_checker"
Run the
authentication
phase.
.PP
.Vb 1
\&  $rc = $r\->run_auth_checker();
.Ve
.ie n .IP "obj: $r\fR ( \f(CW""Apache2::RequestRec object"" )" 4
.el .IP "obj: \f(CW$r\fR ( \f(CWApache2::RequestRec object\fR )" 4
.IX Item "obj: $r ( Apache2::RequestRec object )"
the current request
.ie n .IP "ret: $rc ( integer )" 4
.el .IP "ret: \f(CW$rc\fR ( integer )" 4
.IX Item "ret: $rc ( integer )"
The status of the current phase run: \f(CW\*(C`Apache2::Const::OK\*(C'\fR,
\&\f(CW\*(C`Apache2::Const::DECLINED\*(C'\fR, \f(CW\*(C`Apache2::HTTP_...\*(C'\fR.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PP
This phase is used to check to see if the resource being requested is
available for the authenticated user (\f(CW\*(C`$r\->user\*(C'\fR and
\&\f(CW\*(C`$r\->ap_auth_type\*(C'\fR).
.PP
It runs after the access_checker and
check_user_id hooks.
.PP
Note that it will only be called if Apache determines that access
control has been applied to this resource (through a '\f(CW\*(C`Require\*(C'\fR'
directive).
.ie n .Sh """run_check_user_id"""
.el .Sh "\f(CWrun_check_user_id\fP"
.IX Subsection "run_check_user_id"
Run the
authorization
phase.
.PP
.Vb 1
\&  $rc = $r\->run_check_user_id();
.Ve
.ie n .IP "obj: $r\fR ( \f(CW""Apache2::RequestRec object"" )" 4
.el .IP "obj: \f(CW$r\fR ( \f(CWApache2::RequestRec object\fR )" 4
.IX Item "obj: $r ( Apache2::RequestRec object )"
The current request
.ie n .IP "ret: $rc ( integer )" 4
.el .IP "ret: \f(CW$rc\fR ( integer )" 4
.IX Item "ret: $rc ( integer )"
The status of the current phase run: \f(CW\*(C`Apache2::Const::OK\*(C'\fR,
\&\f(CW\*(C`Apache2::Const::DECLINED\*(C'\fR, \f(CW\*(C`Apache2::HTTP_...\*(C'\fR.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PP
This hook is used to analyze the request headers, authenticate the
user, and set the user information in the request record
(\f(CW\*(C`$r\->user\*(C'\fR and \f(CW\*(C`$r\->ap_auth_type\*(C'\fR).
.PP
This hook is only run when Apache determines that
authentication/authorization is required for this resource (as
determined by the '\f(CW\*(C`Require\*(C'\fR' directive).
.PP
It runs after the access_checker hook, and
before the auth_checker hook.
.ie n .Sh """run_fixups"""
.el .Sh "\f(CWrun_fixups\fP"
.IX Subsection "run_fixups"
Run the fixup
phase.
.PP
.Vb 1
\&  $rc = $r\->run_fixups();
.Ve
.ie n .IP "obj: $r\fR ( \f(CW""Apache2::RequestRec object"" )" 4
.el .IP "obj: \f(CW$r\fR ( \f(CWApache2::RequestRec object\fR )" 4
.IX Item "obj: $r ( Apache2::RequestRec object )"
The current request
.ie n .IP "ret: $rc ( integer )" 4
.el .IP "ret: \f(CW$rc\fR ( integer )" 4
.IX Item "ret: $rc ( integer )"
The status of the current phase run: \f(CW\*(C`Apache2::Const::OK\*(C'\fR,
\&\f(CW\*(C`Apache2::Const::DECLINED\*(C'\fR, \f(CW\*(C`Apache2::HTTP_...\*(C'\fR.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PP
This phase allows modules to perform module-specific fixing of \s-1HTTP\s0
header fields.  This is invoked just before the
response phase.
.ie n .Sh """run_handler"""
.el .Sh "\f(CWrun_handler\fP"
.IX Subsection "run_handler"
Run the
response phase.
.PP
.Vb 1
\&  $rc = $r\->run_handler();
.Ve
.ie n .IP "obj: $r\fR ( \f(CW""Apache2::RequestRec object"" )" 4
.el .IP "obj: \f(CW$r\fR ( \f(CWApache2::RequestRec object\fR )" 4
.IX Item "obj: $r ( Apache2::RequestRec object )"
The request_rec
.ie n .IP "ret: $rc ( integer )" 4
.el .IP "ret: \f(CW$rc\fR ( integer )" 4
.IX Item "ret: $rc ( integer )"
The status of the current phase run: \f(CW\*(C`Apache2::Const::OK\*(C'\fR,
\&\f(CW\*(C`Apache2::Const::DECLINED\*(C'\fR, \f(CW\*(C`Apache2::HTTP_...\*(C'\fR.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PP
\&\f(CW\*(C`run_handler()\*(C'\fR is called internally by
\&\f(CW\*(C`invoke_handler()\*(C'\fR. Use \f(CW\*(C`run_handler()\*(C'\fR only
if you want to bypass the extra functionality provided by
\&\f(CW\*(C`invoke_handler()\*(C'\fR.
.ie n .Sh """run_header_parser"""
.el .Sh "\f(CWrun_header_parser\fP"
.IX Subsection "run_header_parser"
Run the header
parser phase.
.PP
.Vb 1
\&  $rc = $r\->run_header_parser();
.Ve
.ie n .IP "obj: $r\fR ( \f(CW""Apache2::RequestRec object"" )" 4
.el .IP "obj: \f(CW$r\fR ( \f(CWApache2::RequestRec object\fR )" 4
.IX Item "obj: $r ( Apache2::RequestRec object )"
The current request
.ie n .IP "ret: $rc ( integer )" 4
.el .IP "ret: \f(CW$rc\fR ( integer )" 4
.IX Item "ret: $rc ( integer )"
\&\f(CW\*(C`Apache2::Const::OK\*(C'\fR or \f(CW\*(C`Apache2::Const::DECLINED\*(C'\fR.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.ie n .Sh """run_log_transaction"""
.el .Sh "\f(CWrun_log_transaction\fP"
.IX Subsection "run_log_transaction"
Run the logging
phase.
.PP
.Vb 1
\&  $rc = $r\->run_log_transaction();
.Ve
.ie n .IP "obj: $r\fR ( \f(CW""Apache2::RequestRec object"" )" 4
.el .IP "obj: \f(CW$r\fR ( \f(CWApache2::RequestRec object\fR )" 4
.IX Item "obj: $r ( Apache2::RequestRec object )"
The current request
.ie n .IP "ret: $rc ( integer )" 4
.el .IP "ret: \f(CW$rc\fR ( integer )" 4
.IX Item "ret: $rc ( integer )"
The status of the current phase run: \f(CW\*(C`Apache2::Const::OK\*(C'\fR,
\&\f(CW\*(C`Apache2::Const::DECLINED\*(C'\fR, \f(CW\*(C`Apache2::HTTP_...\*(C'\fR
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PP
This hook allows modules to perform any module-specific logging
activities over and above the normal server things.
.ie n .Sh """run_map_to_storage"""
.el .Sh "\f(CWrun_map_to_storage\fP"
.IX Subsection "run_map_to_storage"
Run the
map_to_storage
phase.
.PP
.Vb 1
\&  $rc = $r\->run_map_to_storage();
.Ve
.ie n .IP "obj: $r\fR ( \f(CW""Apache2::RequestRec object"" )" 4
.el .IP "obj: \f(CW$r\fR ( \f(CWApache2::RequestRec object\fR )" 4
.IX Item "obj: $r ( Apache2::RequestRec object )"
The current request
.ie n .IP "ret: $rc ( integer )" 4
.el .IP "ret: \f(CW$rc\fR ( integer )" 4
.IX Item "ret: $rc ( integer )"
\&\f(CW\*(C`Apache2::Const::DONE\*(C'\fR (or \f(CW\*(C`Apache2::HTTP_*\*(C'\fR) if this contextless request was
just fulfilled (such as \f(CW\*(C`TRACE\*(C'\fR), \f(CW\*(C`Apache2::Const::OK\*(C'\fR if this is not a
file, and \f(CW\*(C`Apache2::Const::DECLINED\*(C'\fR if this is a file.  The core
map_to_storage (\f(CW\*(C`Apache2::HOOK_RUN_LAST\*(C'\fR) will \f(CW\*(C`directory_walk()\*(C'\fR and
\&\f(CW\*(C`file_walk()\*(C'\fR the \f(CW\*(C`$r\->filename\*(C'\fR (all internal C functions).
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PP
This phase allows modules to set the per_dir_config based on their own
context (such as \f(CW\*(C`<Proxy>\*(C'\fR sections) and responds to
contextless requests such as \f(CW\*(C`TRACE\*(C'\fR that need no security or
filesystem mapping based on the filesystem.
.ie n .Sh """run_post_read_request"""
.el .Sh "\f(CWrun_post_read_request\fP"
.IX Subsection "run_post_read_request"
Run the
post_read_request
phase.
.PP
.Vb 1
\&  $rc = $r\->run_post_read_request();
.Ve
.ie n .IP "obj: $r\fR ( \f(CW""Apache2::RequestRec object"" )" 4
.el .IP "obj: \f(CW$r\fR ( \f(CWApache2::RequestRec object\fR )" 4
.IX Item "obj: $r ( Apache2::RequestRec object )"
The current request
.ie n .IP "ret: $rc ( integer )" 4
.el .IP "ret: \f(CW$rc\fR ( integer )" 4
.IX Item "ret: $rc ( integer )"
The status of the current phase run: \f(CW\*(C`Apache2::Const::OK\*(C'\fR or
\&\f(CW\*(C`Apache2::Const::DECLINED\*(C'\fR.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PP
This phase is run right after \f(CW\*(C`read_request()\*(C'\fR or
\&\f(CW\*(C`internal_redirect()\*(C'\fR, and not run during any subrequests.  This hook
allows modules to affect the request immediately after the request has
been read, and before any other phases have been processes.  This
allows modules to make decisions based upon the input header fields
.ie n .Sh """run_translate_name"""
.el .Sh "\f(CWrun_translate_name\fP"
.IX Subsection "run_translate_name"
Run the translate
phase.
.PP
.Vb 1
\&  $rc = $r\->run_translate_name();
.Ve
.ie n .IP "obj: $r\fR ( \f(CW""Apache2::RequestRec object"" )" 4
.el .IP "obj: \f(CW$r\fR ( \f(CWApache2::RequestRec object\fR )" 4
.IX Item "obj: $r ( Apache2::RequestRec object )"
The current request
.ie n .IP "ret: $rc ( integer )" 4
.el .IP "ret: \f(CW$rc\fR ( integer )" 4
.IX Item "ret: $rc ( integer )"
The status of the current phase run: \f(CW\*(C`Apache2::Const::OK\*(C'\fR,
\&\f(CW\*(C`Apache2::Const::DECLINED\*(C'\fR, \f(CW\*(C`Apache2::HTTP_...\*(C'\fR.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PP
This phase gives modules an opportunity to translate the \s-1URI\s0 into an
actual filename.  If no modules do anything special, the server's
default rules will be applied.
.ie n .Sh """run_type_checker"""
.el .Sh "\f(CWrun_type_checker\fP"
.IX Subsection "run_type_checker"
Run the
type_checker phase.
.PP
.Vb 1
\&  $rc = $r\->run_type_checker();
.Ve
.ie n .IP "obj: $r\fR ( \f(CW""Apache2::RequestRec object"" )" 4
.el .IP "obj: \f(CW$r\fR ( \f(CWApache2::RequestRec object\fR )" 4
.IX Item "obj: $r ( Apache2::RequestRec object )"
the current request
.ie n .IP "ret: $rc ( integer )" 4
.el .IP "ret: \f(CW$rc\fR ( integer )" 4
.IX Item "ret: $rc ( integer )"
The status of the current phase run: \f(CW\*(C`Apache2::Const::OK\*(C'\fR,
\&\f(CW\*(C`Apache2::Const::DECLINED\*(C'\fR, \f(CW\*(C`Apache2::HTTP_...\*(C'\fR.
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.PP
This phase is used to determine and/or set the various document type
information bits, like \f(CW\*(C`Content\-type\*(C'\fR (via \f(CW\*(C`$r\->content_type\*(C'\fR),
language, etc.
.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.