apache2::response.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::Response 3"
.TH mod_perl-2.0.2::docs::api::Apache2::Response 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::Response \- Perl API for Apache HTTP request response methods
.SH "Synopsis"
.IX Header "Synopsis"
.Vb 1
\&  use Apache2::Response ();
\&  
\&  $r\->custom_response(Apache2::Const::FORBIDDEN, "No Entry today");
\&  
\&  $etag = $r\->make_etag($force_weak);
\&  $r\->set_etag();
\&  $status = $r\->meets_conditions();
\&  
\&  $mtime_rat = $r\->rationalize_mtime($mtime);
\&  $r\->set_last_modified($mtime);
\&  $r\->update_mtime($mtime);
\&  
\&  $r\->send_cgi_header($buffer);
\&  
\&  $r\->set_content_length($length);
\&  
\&  $ret = $r\->set_keepalive();
.Ve
.SH "Description"
.IX Header "Description"
\&\f(CW\*(C`Apache2::Response\*(C'\fR provides the Apache request
object utilities \s-1API\s0 for dealing
with \s-1HTTP\s0 response generation process.
.SH "API"
.IX Header "API"
\&\f(CW\*(C`Apache2::Response\*(C'\fR provides the following functions and/or methods:
.ie n .Sh """custom_response"""
.el .Sh "\f(CWcustom_response\fP"
.IX Subsection "custom_response"
Install a custom response handler for a given status
.PP
.Vb 1
\&  $r\->custom_response($status, $string);
.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 "arg1: $status\fR ( \f(CW""Apache2::Const constant"" )" 4
.el .IP "arg1: \f(CW$status\fR ( \f(CWApache2::Const constant\fR )" 4
.IX Item "arg1: $status ( Apache2::Const constant )"
The status for which the custom response should be used
(e.g. \f(CW\*(C`Apache2::Const::AUTH_REQUIRED\*(C'\fR)
.ie n .IP "arg2: $string (string)" 4
.el .IP "arg2: \f(CW$string\fR (string)" 4
.IX Item "arg2: $string (string)"
The custom response to use.  This can be a static string, or a \s-1URL\s0,
full or just the uri path (\fI/foo/bar.txt\fR).
.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
\&\f(CW\*(C`custom_response()\*(C'\fR doesn't alter the response code, but is used to
replace the standard response body. For example, here is how to change
the response body for the access handler failure:
.PP
.Vb 5
\&  package MyApache2::MyShop;
\&  use Apache2::Response ();
\&  use Apache2::Const \-compile => qw(FORBIDDEN OK);
\&  sub access {
\&      my $r = shift;
\&   
\&      if (MyApache2::MyShop::tired_squirrels()) {
\&          $r\->custom_response(Apache2::Const::FORBIDDEN,
\&              "It\*(Aqs siesta time, please try later");
\&          return Apache2::Const::FORBIDDEN;
\&      }
\&  
\&      return Apache2::Const::OK;
\&  }
\&  ...
\&
\&  # httpd.conf
\&  PerlModule MyApache2::MyShop
\&  <Location /TestAPI_\|_custom_response>
\&      AuthName dummy
\&      AuthType none
\&      PerlAccessHandler   MyApache2::MyShop::access
\&      PerlResponseHandler MyApache2::MyShop::response
\&  </Location>
.Ve
.PP
When squirrels can't run any more, the handler will return 403, with
the custom message:
.PP
.Vb 1
\&  It\*(Aqs siesta time, please try later
.Ve
.ie n .Sh """make_etag"""
.el .Sh "\f(CWmake_etag\fP"
.IX Subsection "make_etag"
Construct an entity tag from the resource information.  If it's a real
file, build in some of the file characteristics.
.PP
.Vb 1
\&  $etag = $r\->make_etag($force_weak);
.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 "arg1: $force_weak (number)" 4
.el .IP "arg1: \f(CW$force_weak\fR (number)" 4
.IX Item "arg1: $force_weak (number)"
Force the entity tag to be weak \- it could be modified
again in as short an interval.
.ie n .IP "ret: $etag (string)" 4
.el .IP "ret: \f(CW$etag\fR (string)" 4
.IX Item "ret: $etag (string)"
The entity tag
.IP "since: 2.0.00" 4
.IX Item "since: 2.0.00"
.ie n .Sh """meets_conditions"""
.el .Sh "\f(CWmeets_conditions\fP"
.IX Subsection "meets_conditions"
Implements condition \f(CW\*(C`GET\*(C'\fR rules for \s-1HTTP/1\s0.1 specification.  This
function inspects the client headers and determines if the response
fulfills the specified requirements.
.PP
.Vb 1
\&  $status = $r\->meets_conditions();
.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 )"