📄 response.html
字号:
<?xml version="1.0" ?>
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<!-- saved from url=(0017)http://localhost/ -->
<script language="JavaScript" src="../../displayToc.js"></script>
<script language="JavaScript" src="../../tocParas.js"></script>
<script language="JavaScript" src="../../tocTab.js"></script>
<link rel="stylesheet" type="text/css" href="../../scineplex.css">
<title>HTTP::Response - HTTP style response message</title>
<link rel="stylesheet" href="../../Active.css" type="text/css" />
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:" />
</head>
<body>
<script>writelinks('__top__',2);</script>
<h1><a>HTTP::Response - HTTP style response message</a></h1>
<p><a name="__index__"></a></p>
<!-- INDEX BEGIN -->
<ul>
<li><a href="#name">NAME</a></li>
<li><a href="#synopsis">SYNOPSIS</a></li>
<li><a href="#description">DESCRIPTION</a></li>
<li><a href="#see_also">SEE ALSO</a></li>
<li><a href="#copyright">COPYRIGHT</a></li>
</ul>
<!-- INDEX END -->
<hr />
<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>HTTP::Response - HTTP style response message</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<p>Response objects are returned by the <a href="#item_request"><code>request()</code></a> method of the <code>LWP::UserAgent</code>:</p>
<pre>
<span class="comment"># ...</span>
<span class="variable">$response</span> <span class="operator">=</span> <span class="variable">$ua</span><span class="operator">-></span><span class="variable">request</span><span class="operator">(</span><span class="variable">$request</span><span class="operator">)</span>
<span class="keyword">if</span> <span class="operator">(</span><span class="variable">$response</span><span class="operator">-></span><span class="variable">is_success</span><span class="operator">)</span> <span class="operator">{</span>
<span class="keyword">print</span> <span class="variable">$response</span><span class="operator">-></span><span class="variable">content</span><span class="operator">;</span>
<span class="operator">}</span>
<span class="keyword">else</span> <span class="operator">{</span>
<span class="keyword">print</span> <span class="variable">STDERR</span> <span class="variable">$response</span><span class="operator">-></span><span class="variable">status_line</span><span class="operator">,</span> <span class="string">"\n"</span><span class="operator">;</span>
<span class="operator">}</span>
</pre>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p>The <code>HTTP::Response</code> class encapsulates HTTP style responses. A
response consists of a response line, some headers, and a content
body. Note that the LWP library uses HTTP style responses even for
non-HTTP protocol schemes. Instances of this class are usually
created and returned by the <a href="#item_request"><code>request()</code></a> method of an <code>LWP::UserAgent</code>
object.</p>
<p><code>HTTP::Response</code> is a subclass of <code>HTTP::Message</code> and therefore
inherits its methods. The following additional methods are available:</p>
<dl>
<dt><strong><a name="item_new">$r = HTTP::Response->new( $code )</a></strong>
<dt><strong>$r = HTTP::Response->new( $code, $msg )</strong>
<dt><strong>$r = HTTP::Response->new( $code, $msg, $header )</strong>
<dt><strong>$r = HTTP::Response->new( $code, $msg, $header, $content )</strong>
<dd>
<p>Constructs a new <code>HTTP::Response</code> object describing a response with
response code $code and optional message $msg. The optional $header
argument should be a reference to an <code>HTTP::Headers</code> object or a
plain array reference of key/value pairs. The optional $content
argument should be a string of bytes. The meaning these arguments are
described below.</p>
</dd>
</li>
<dt><strong><a name="item_parse">$r = HTTP::Response->parse( $str )</a></strong>
<dd>
<p>This constructs a new response object by parsing the given string.</p>
</dd>
</li>
<dt><strong><a name="item_code">$r->code</a></strong>
<dt><strong>$r->code( $code )</strong>
<dd>
<p>This is used to get/set the code attribute. The code is a 3 digit
number that encode the overall outcome of a HTTP response. The
<code>HTTP::Status</code> module provide constants that provide mnemonic names
for the code attribute.</p>
</dd>
</li>
<dt><strong><a name="item_message">$r->message</a></strong>
<dt><strong>$r->message( $message )</strong>
<dd>
<p>This is used to get/set the message attribute. The message is a short
human readable single line string that explains the response code.</p>
</dd>
</li>
<dt><strong><a name="item_header">$r->header( $field )</a></strong>
<dt><strong>$r->header( $field => $value )</strong>
<dd>
<p>This is used to get/set header values and it is inherited from
<code>HTTP::Headers</code> via <code>HTTP::Message</code>. See <a href="../../lib/HTTP/Headers.html">the HTTP::Headers manpage</a> for
details and other similar methods that can be used to access the
headers.</p>
</dd>
</li>
<dt><strong><a name="item_content">$r->content</a></strong>
<dt><strong>$r->content( $content )</strong>
<dd>
<p>This is used to get/set the raw content and it is inherited from the
<code>HTTP::Message</code> base class. See <a href="../../lib/HTTP/Message.html">the HTTP::Message manpage</a> for details and
other methods that can be used to access the content.</p>
</dd>
</li>
<dt><strong><a name="item_decoded_content">$r->decoded_content( %options )</a></strong>
<dd>
<p>This will return the content after any <code>Content-Encoding</code> and
charsets has been decoded. See <a href="../../lib/HTTP/Message.html">the HTTP::Message manpage</a> for details.</p>
</dd>
</li>
<dt><strong><a name="item_request">$r->request</a></strong>
<dt><strong>$r->request( $request )</strong>
<dd>
<p>This is used to get/set the request attribute. The request attribute
is a reference to the the request that caused this response. It does
not have to be the same request passed to the $ua-><a href="#item_request"><code>request()</code></a> method,
because there might have been redirects and authorization retries in
between.</p>
</dd>
</li>
<dt><strong><a name="item_previous">$r->previous</a></strong>
<dt><strong>$r->previous( $response )</strong>
<dd>
<p>This is used to get/set the previous attribute. The previous
attribute is used to link together chains of responses. You get
chains of responses if the first response is redirect or unauthorized.
The value is <a href="../../lib/Pod/perlfunc.html#item_undef"><code>undef</code></a> if this is the first response in a chain.</p>
</dd>
</li>
<dt><strong><a name="item_status_line">$r->status_line</a></strong>
<dd>
<p>Returns the string "<code> <message>". If the message attribute
is not set then the official name of <code> (see <a href="../../lib/HTTP/Status.html">the HTTP::Status manpage</a>)
is substituted.</p>
</dd>
</li>
<dt><strong><a name="item_base">$r->base</a></strong>
<dd>
<p>Returns the base URI for this response. The return value will be a
reference to a URI object.</p>
</dd>
<dd>
<p>The base URI is obtained from one the following sources (in priority
order):</p>
</dd>
<ol>
<li>
<p>Embedded in the document content, for instance <BASE HREF="...">
in HTML documents.</p>
</li>
<li>
<p>A "Content-Base:" or a "Content-Location:" header in the response.</p>
<p>For backwards compatibility with older HTTP implementations we will
also look for the "Base:" header.</p>
</li>
<li>
<p>The URI used to request this response. This might not be the original
URI that was passed to $ua-><a href="#item_request"><code>request()</code></a> method, because we might have
received some redirect responses first.</p>
</li>
</ol>
<p>If neither of these sources provide an absolute URI, undef is
returned.</p>
<p>When the LWP protocol modules produce the HTTP::Response object, then
any base URI embedded in the document (step 1) will already have
initialized the "Content-Base:" header. This means that this method
only performs the last 2 steps (the content is not always available
either).</p>
<dt><strong><a name="item_as_string">$r->as_string</a></strong>
<dt><strong>$r->as_string( $eol )</strong>
<dd>
<p>Returns a textual representation of the response.</p>
</dd>
</li>
<dt><strong><a name="item_is_info">$r->is_info</a></strong>
<dt><strong><a name="item_is_success">$r->is_success</a></strong>
<dt><strong><a name="item_is_redirect">$r->is_redirect</a></strong>
<dt><strong><a name="item_is_error">$r->is_error</a></strong>
<dd>
<p>These methods indicate if the response was informational, successful, a
redirection, or an error. See <a href="../../lib/HTTP/Status.html">the HTTP::Status manpage</a> for the meaning of these.</p>
</dd>
</li>
<dt><strong><a name="item_error_as_html">$r->error_as_HTML</a></strong>
<dd>
<p>Returns a string containing a complete HTML document indicating what
error occurred. This method should only be called when $r->is_error
is TRUE.</p>
</dd>
</li>
<dt><strong><a name="item_current_age">$r->current_age</a></strong>
<dd>
<p>Calculates the "current age" of the response as specified by RFC 2616
section 13.2.3. The age of a response is the time since it was sent
by the origin server. The returned value is a number representing the
age in seconds.</p>
</dd>
</li>
<dt><strong><a name="item_freshness_lifetime">$r->freshness_lifetime</a></strong>
<dd>
<p>Calculates the "freshness lifetime" of the response as specified by
RFC 2616 section 13.2.4. The "freshness lifetime" is the length of
time between the generation of a response and its expiration time.
The returned value is a number representing the freshness lifetime in
seconds.</p>
</dd>
<dd>
<p>If the response does not contain an "Expires" or a "Cache-Control"
header, then this function will apply some simple heuristic based on
'Last-Modified' to determine a suitable lifetime.</p>
</dd>
</li>
<dt><strong><a name="item_is_fresh">$r->is_fresh</a></strong>
<dd>
<p>Returns TRUE if the response is fresh, based on the values of
<a href="#item_freshness_lifetime"><code>freshness_lifetime()</code></a> and current_age(). If the response is no longer
fresh, then it has to be refetched or revalidated by the origin
server.</p>
</dd>
</li>
<dt><strong><a name="item_fresh_until">$r->fresh_until</a></strong>
<dd>
<p>Returns the time when this entity is no longer fresh.</p>
</dd>
</li>
</dl>
<p>
</p>
<hr />
<h1><a name="see_also">SEE ALSO</a></h1>
<p><a href="../../lib/HTTP/Headers.html">the HTTP::Headers manpage</a>, <a href="../../lib/HTTP/Message.html">the HTTP::Message manpage</a>, <a href="../../lib/HTTP/Status.html">the HTTP::Status manpage</a>, <a href="../../lib/HTTP/Request.html">the HTTP::Request manpage</a></p>
<p>
</p>
<hr />
<h1><a name="copyright">COPYRIGHT</a></h1>
<p>Copyright 1995-2004 Gisle Aas.</p>
<p>This library is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.</p>
</body>
</html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -