You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by pg...@apache.org on 2006/08/09 12:20:11 UTC
svn commit: r430022 [13/29] - in /httpd/site/trunk:
docs/apreq/docs/libapreq2/ xdocs/apreq/docs/libapreq2/
Modified: httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request.html
URL: http://svn.apache.org/viewvc/httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request.html?rev=430022&r1=430021&r2=430022&view=diff
==============================================================================
--- httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request.html (original)
+++ httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request.html Wed Aug 9 03:20:06 2006
@@ -1,7 +1,7 @@
<html>
<head>
<link rel="stylesheet" type="text/css" href="dox.css" />
- <title>libapreq2-2.06-dev: libapreq2: APR::Request</title>
+ <title>libapreq2-2.08: libapreq2: APR::Request</title>
</head>
<body>
<div id="page-header">
@@ -10,8 +10,16 @@
<a href="http://httpd.apache.org/apreq/">Request Library Subproject</a></p>
<p class="apache">Apache HTTP Server Request Library</p>
<img alt="" src="feather.gif" /></div>
-<!-- Generated by Doxygen 1.4.3-20050530 -->
-<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
+<!-- Generated by Doxygen 1.4.6 -->
+<div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main Page</span></a></li>
+ <li><a href="modules.html"><span>Modules</span></a></li>
+ <li><a href="annotated.html"><span>Data Structures</span></a></li>
+ <li><a href="files.html"><span>Files</span></a></li>
+ <li><a href="pages.html"><span>Related Pages</span></a></li>
+ <li><a href="examples.html"><span>Examples</span></a></li>
+ </ul></div>
<h1>APR::Request<br>
<small>
[<a class="el" href="group__apreq__xs.html">Perl</a>]</small>
@@ -51,7 +59,7 @@
<li><a href="#args">args</a></li>
<li><a href="#body">body</a></li>
<li><a href="#param">param</a></li>
- <li><a href="#uploads__apr__request__param__table_">uploads (APR::Request::Param::Table???)</a></li>
+ <li><a href="#upload">upload</a></li>
<li><a href="#read_limit">read_limit</a></li>
<li><a href="#brigade_limit">brigade_limit</a></li>
<li><a href="#temp_dir">temp_dir</a></li>
@@ -68,6 +76,30 @@
</ul>
<li><a href="#subclassing">SUBCLASSING</a></li>
+ <li><a href="#methods">METHODS</a></li>
+ <ul>
+
+ <li><a href="#cookie_class">cookie_class</a></li>
+ <li><a href="#get">get</a></li>
+ <li><a href="#fetch">FETCH</a></li>
+ <li><a href="#exists">EXISTS</a></li>
+ <li><a href="#firstkey">FIRSTKEY</a></li>
+ <li><a href="#nextkey">NEXTKEY</a></li>
+ <li><a href="#do">do</a></li>
+ </ul>
+
+ <li><a href="#methods">METHODS</a></li>
+ <ul>
+
+ <li><a href="#param_class">param_class</a></li>
+ <li><a href="#get">get</a></li>
+ <li><a href="#fetch">FETCH</a></li>
+ <li><a href="#exists">EXISTS</a></li>
+ <li><a href="#nextkey">NEXTKEY</a></li>
+ <li><a href="#firstkey">FIRSTKEY</a></li>
+ <li><a href="#do">do</a></li>
+ </ul>
+
<li><a href="#see_also">SEE ALSO</a></li>
<li><a href="#copyright">COPYRIGHT</a></li>
</ul>
@@ -96,12 +128,12 @@
use APR::Request;</pre>
<pre>
- $req = APR::Request::Custom->handle($pool,
- "foo=arg1&bar=arg2",
- "cookie=apache",
+ $req = APR::Request::Custom->handle($pool,
+ "foo=arg1&bar=arg2",
+ "apache=quux",
$parser, 1e6, $bb);
$param = $req->param("foo");
- $cookie = $req->jar("cookie");</pre>
+ $cookie = $req->jar("apache");</pre>
<p>
@@ -114,8 +146,10 @@
for interfacing with libapreq2's module API. It also provides
a few utility functions and constants.</p>
-<p>This manpage documents the APR::Request and APR::Request::Custom
-packages.</p>
+<p>This manpage documents version 2.08
+of the APR::Request, APR::Request::Custom,
+APR::Request::Cookie::Table, and
+APR::Request::Param::Table packages.</p>
<p>
@@ -133,7 +167,7 @@
<h2><a name="handle">handle</a></h2>
<pre>
- APR::Request::Custom->handle($pool,
+ APR::Request::Custom->handle($pool,
$query_string,
$cookie_header,
$parser,
@@ -141,10 +175,10 @@
$brigade)</pre>
<p>Creates a new APR::Request::Custom object. The $query_string
-and $cookie_headers are immediately parsed into the <code>args</code> and
+and $cookie_headers are immediately parsed into the <code>args</code> and
<code>jar</code> tables. The $parser is an APR::Request::Parser object
-which is invoked when fetching <code>body</code> entries from the $brigade.
-The $read_limit represents the maximum number of bytes this handle
+which is invoked when fetching <code>body</code> entries from the $brigade.
+The $read_limit represents the maximum number of bytes this handle
may feed into the parser.</p>
<p>
@@ -232,9 +266,16 @@
<pre>
$req->parse()</pre>
-<p>Parses the jar, args, and body tables. Returns
+<p>Parses the jar, args, and body tables. Returns
<code>$req->jar_status, $req->args_status, $req->body_status</code>.</p>
+<pre>
+ @status = $req->parse;
+ ok @status == 3;
+ ok $status[0] == $req->jar_status;
+ ok $status[1] == $req->args_status;
+ ok $status[2] == $req->body_status;</pre>
+
<p>
</p>
@@ -245,15 +286,30 @@
$req->jar()
$req->jar($key)</pre>
-<p>With no arguments, this method returns a tied APR::Request::Cookie::Table
-object in scalar context, or the names (in order, with repetitions) of all
-the parsed cookies.</p>
+<p>With no arguments, this method returns a tied APR::Request::Cookie::Table
+object (or undef if the ``Cookie'' header is absent) in scalar context, or
+the names (in order, with repetitions) of all the parsed cookies.</p>
-<p>With the <code>$key</code> argument, in scalar context this method fetches the first
+<p>With the <code>$key</code> argument, in scalar context this method fetches the first
matching cookie. In list context it returns all matching cookies.
The returned cookies are the values as they appeared in the incoming
Cookie header.</p>
+<p><code>jar()</code> will throw an APR::Request::Error object whenever <code>jar_status()</code>
+is non-zero and the return value is potentially invalid (eg
+<code>scalar $req->jar($key)</code> will not die if the desired cookie
+was successfully parsed).</p>
+
+<pre>
+ $jar = $req->jar;
+ @cookie_names = $req->jar;
+ ok $jar->isa("APR::Request::Cookie::Table");
+ ok shift @cookie_names eq $_ for keys %$jar;</pre>
+
+<pre>
+ $cookie = $req->jar("apache");
+ @cookies = $req->jar("apache");</pre>
+
<p>
</p>
@@ -264,13 +320,28 @@
$req->args()
$req->args($key)</pre>
-<p>With no arguments, this method returns a tied APR::Request::Param::Table
-object in scalar context, or the names (in order, with repetitions) of all
-the parsed query-string arguments.</p>
+<p>With no arguments, this method returns a tied APR::Request::Param::Table
+object (or undef if the query string is absent) in scalar context, or the
+names (in order, with repetitions) of all the parsed query-string arguments.</p>
-<p>With the <code>$key</code> argument, in scalar context this method fetches the first
+<p>With the <code>$key</code> argument, in scalar context this method fetches the first
matching query-string arg. In list context it returns all matching args.</p>
+<p><code>args()</code> will throw an APR::Request::Error object whenever <code>args_status()</code>
+is non-zero and the return value is potentially invalid (eg
+<code>scalar $req->args($key)</code> will not die if the desired query argument
+was successfully parsed).</p>
+
+<pre>
+ $args = $req->args;
+ @arg_names = $req->args;
+ ok $args->isa("APR::Request::Param::Table");
+ ok shift @arg_names eq $_ for keys %$args;</pre>
+
+<pre>
+ $foo = $req->args("foo");
+ @bar = $req->args("bar");</pre>
+
<p>
</p>
@@ -281,13 +352,28 @@
$req->body()
$req->body($key)</pre>
-<p>With no arguments, this method returns a tied APR::Request::Param::Table
-object in scalar context, or the names (in order, with repetitions) of all
-the parsed cookies.</p>
+<p>With no arguments, this method returns a tied APR::Request::Param::Table
+object (or undef if the request body is absent) in scalar context, or the
+names (in order, with repetitions) of all the parsed cookies.</p>
-<p>With the <code>$key</code> argument, in scalar context this method fetches the first
+<p>With the <code>$key</code> argument, in scalar context this method fetches the first
matching body param. In list context it returns all matching body params.</p>
+<p><code>body()</code> will throw an APR::Request::Error object whenever <code>body_status()</code>
+is non-zero and the return value is potentially invalid (eg
+<code>scalar $req->body($key)</code> will not die if the desired body param was
+successfully parsed).</p>
+
+<pre>
+ $body = $req->body;
+ @body_names = $req->body;
+ ok $body->isa("APR::Request::Param::Table");
+ ok shift @body_names eq $_ for keys %$body;</pre>
+
+<pre>
+ $alpha = $req->body("alpha");
+ @beta = $req->body("beta");</pre>
+
<p>
</p>
@@ -298,22 +384,63 @@
$req->param()
$req->param($key)</pre>
-<p>With no arguments, this method returns a tied APR::Request::Cookie::Table
-object in scalar context, or the names (in order, with repetitions) of all
-the incoming (args + body) params.</p>
+<p>With no arguments, this method returns a tied APR::Request::Param::Table
+object (or undef, if the query string and request body are absent) in scalar
+context, or the names (in order, with repetitions) of all the incoming
+(args + body) params.</p>
-<p>With the <code>$key</code> argument, in scalar context this method fetches the first
+<p>With the <code>$key</code> argument, in scalar context this method fetches the first
matching param. In list context it returns all matching params.</p>
+<p><code>param()</code> will throw an APR::Request::Error object whenever <code>param_status()</code>
+is non-zero and the return value is potentially invalid (eg
+<code>scalar $req->param($key)</code> will not die if the desired param
+was successfully parsed).</p>
+
+<pre>
+ $param = $req->param;
+ @param_names = $req->param;
+ ok $param->isa("APR::Request::Param::Table");
+ ok shift @param_names eq $_ for keys %$param;</pre>
+
+<pre>
+ $foo = $req->param("foo");
+ @foo = $req->param("foo");</pre>
+
<p>
</p>
-<h2><a name="uploads__apr__request__param__table_">uploads (APR::Request::Param::Table???)</a></h2>
+<h2><a name="upload">upload</a></h2>
<pre>
- $req->uploads()
- $req->uploads($key)</pre>
+ $req->upload()
+ $req->upload($key)</pre>
+
+<p>With no arguments, this method returns a tied APR::Request::Param::Table
+object (or undef if the request body is absent) in scalar context (whose
+entries are APR::Request::Param objects), or the names (in order, with
+repetitions) of all the incoming uploads.</p>
+
+<p>With the <code>$key</code> argument, in scalar context this method fetches the first
+matching upload. In list context it returns all matching uploads. The return
+values are APR::Request::Param objects.</p>
+
+<p><code>upload()</code> will throw an APR::Request::Error object whenever <code>body_status()</code>
+is non-zero.</p>
+
+<pre>
+ $uploads = $req->upload;
+ @upload_names = $req->upload;
+ ok $uploads->isa("APR::Request::Param::Table");
+ ok shift @upload_names eq $_ for keys %$uploads;
+ ok $_->upload for values %$uploads;</pre>
+
+<pre>
+ $up = $req->upload("beta");
+ @ups = $req->upload("beta");
+ ok $_->isa("APR::Request::Param") for $up, @ups;
+ ok $_->upload for $up, @ups;</pre>
<p>
@@ -325,6 +452,9 @@
$req->read_limit()
$req->read_limit($set)</pre>
+<p>Get/set the read limit, which controls the total amount of
+bytes that can be fed to the current parser.</p>
+
<p>
</p>
@@ -336,7 +466,7 @@
$req->brigade_limit($set)</pre>
<p>Get/set the brigade_limit for the current parser. This limit
-determines how many bytes of a file upload that the parser may
+determines how many bytes of a file upload that the parser may
spool into main memory. Uploads exceeding this limit are written
directly to disk.</p>
@@ -435,8 +565,8 @@
use APR::Request::Custom;
our @ISA = qw(APR::Request);
sub new {
- my($class, @args) = @_;
- return bless { r => APR::Request::Custom->handle(@args) }, $class;
+ my($class, @args) = @_;
+ return bless { r => APR::Request::Custom->handle(@args) }, $class;
}</pre>
<p>
@@ -444,10 +574,222 @@
</p>
<hr />
+<h1><a name="methods">METHODS</a></h1>
+
+<pre>
+ APR::Request::Cookie::Table - read-only version of APR::Table.</pre>
+
+<p>Tables in this class normally arise from calls to
+<code>APR::Request::jar()</code>.</p>
+
+<p>
+
+</p>
+
+<h2><a name="cookie_class">cookie_class</a></h2>
+
+<pre>
+ $table->cookie_class()
+ $table->cookie_class($set)</pre>
+
+<p>Get/set the class each table element is blessed into during a
+<a href="#get">the get manpage</a> or <em>FETCH</em> call. If defined, the class must be derived
+from APR::Request::Cookie. When called with $set, it returns
+the $table. Otherwise it returns the name of the current class,
+or undef if no cookie class is defined.</p>
+
+<p>
+
+</p>
+
+<h2><a name="get">get</a></h2>
+
+<pre>
+ $table->get($key)</pre>
+
+<p>Same as FETCH.</p>
+
+<p>
+
+</p>
+
+<h2><a name="fetch">FETCH</a></h2>
+
+<pre>
+ $table->FETCH($key)</pre>
+
+<p>In scalar context, this returns the first value matching
+$key (note: see NEXTKEY for additional notes). The match
+is always case-insensitive. In list context, this returns
+all matching values. Note: the type of the return values
+depends on the table's current cookie_class.</p>
+
+<p>
+
+</p>
+
+<h2><a name="exists">EXISTS</a></h2>
+
+<p>Synonym for <code>defined</code>; these tables are not
+allowed to contain undefined values. Since these
+are constant tables, they don't autovivify either.</p>
+
+<p>
+
+</p>
+
+<h2><a name="firstkey">FIRSTKEY</a></h2>
+
+<pre>
+ $table->FIRSTKEY()</pre>
+
+<p>Returns the first key in the table.</p>
+
+<p>
+
+</p>
+
+<h2><a name="nextkey">NEXTKEY</a></h2>
+
+<pre>
+ $table->NEXTKEY()</pre>
+
+<p>Returns the next key in the table. For perl 5.8+,
+if the key is multivalued, a subsequent FETCH on
+this key will return the corresponding value, until
+either NEXTKEY or FIRSTKEY is invoked again. For
+perl 5.6, FETCH always returns the first value.</p>
+
+<p>
+
+</p>
+
+<h2><a name="do">do</a></h2>
+
+<pre>
+ $table->do($callback, @keys)</pre>
+
+<p>Same as APR::Table::do; iterates over the table
+calling $callback->($key, $value) for each matching
+@keys. If @keys is empty, this iterates over the
+entire table.</p>
+
+<p>Note: The type of $value inserted into the callback
+depends on the table's current cookie_class.</p>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="methods">METHODS</a></h1>
+
+<p>APR::Request::Param::Table</p>
+
+<p>
+
+</p>
+
+<h2><a name="param_class">param_class</a></h2>
+
+<pre>
+ $table->param_class()
+ $table->param_class($set)</pre>
+
+<p>Get/set the class each table element is blessed into during a
+<code>get</code> or <code>FETCH</code> call. If defined, the class must be derived
+from APR::Request::Param. When called with $set, it returns
+the $table. Otherwise it returns the name of the current class,
+or undef if no param class is defined.</p>
+
+<p>
+
+</p>
+
+<h2><a name="get">get</a></h2>
+
+<pre>
+ $table->get($key)</pre>
+
+<p>Same as FETCH.</p>
+
+<p>
+
+</p>
+
+<h2><a name="fetch">FETCH</a></h2>
+
+<pre>
+ $table->FETCH($key)</pre>
+
+<p>In scalar context, this returns the first value matching
+$key (see NEXTKEY for additional notes on this). The match
+is always case-insensitive. In list context, this returns
+all matching values. Note: the type of the return values
+depends on the table's current param_class.</p>
+
+<p>
+
+</p>
+
+<h2><a name="exists">EXISTS</a></h2>
+
+<p>Synonym for <code>defined</code>; these tables are not
+allowed to contain undefined values. Since these
+are constant tables, they don't autovivify either.</p>
+
+<p>
+
+</p>
+
+<h2><a name="nextkey">NEXTKEY</a></h2>
+
+<pre>
+ $table->NEXTKEY()</pre>
+
+<p>Returns the next key in the table. For perl 5.8+,
+if the key is multivalued, a subsequent FETCH on
+this key will return the corresponding value, until
+either NEXTKEY or FIRSTKEY is invoked again. For
+perl 5.6, FETCH always returns the first value.</p>
+
+<p>
+
+</p>
+
+<h2><a name="firstkey">FIRSTKEY</a></h2>
+
+<pre>
+ $table->FIRSTKEY()</pre>
+
+<p>Returns the first key in the table.</p>
+
+<p>
+
+</p>
+
+<h2><a name="do">do</a></h2>
+
+<pre>
+ $table->do($callback, @keys)</pre>
+
+<p>Same as APR::Table::do; iterates over the table
+calling $callback->($key, $value) for each matching
+@keys. If @keys is empty, this iterates over the
+entire table.</p>
+
+<p>Note: The type of $value inserted into the callback
+depends on the table's current value_class.</p>
+
+<p>
+
+</p>
+<hr />
+
<h1><a name="see_also">SEE ALSO</a></h1>
-<p><a href="/APR/Request/Error.html">the APR::Request::Error manpage</a>, <a href="/APR/Request/Param.html">the APR::Request::Param manpage</a>,
-<a href="/APR/Request/Cookie.html">the APR::Request::Cookie manpage</a>, <a href="/APR/Request/Parser.html">the APR::Request::Parser manpage</a></p>
+<p><a href="group__apreq__xs__apr__request__error.html">the APR::Request::Error manpage</a>, <a href="group__apreq__xs__apr__request__param.html">the APR::Request::Param manpage</a>,
+<a href="group__apreq__xs__apr__request__cookie.html">the APR::Request::Cookie manpage</a>, <a href="group__apreq__xs__apr__request__parser.html">the APR::Request::Parser manpage</a></p>
<p>
@@ -457,7 +799,7 @@
<h1><a name="copyright">COPYRIGHT</a></h1>
<pre>
- Copyright 2003-2005 The Apache Software Foundation</pre>
+ Copyright 2003-2006 The Apache Software Foundation</pre>
<pre>
Licensed under the Apache License, Version 2.0 (the "License");
@@ -475,13 +817,13 @@
limitations under the License.</pre>
-<div id="footer">
+ <div id="footer">
<p class="apache">
-Copyright © 2003-2005 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
+Copyright © 2003-2006 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
See <a href="apreq_license.html">LICENSE</a>.</p>
<p class="menu">
<span style="color:#aaa">page generated by <a href="http://www.doxygen.org/"><code>doxygen</code></a>
-version 1.4.3-20050530 on 19 Jul 2005</span>
+version 1.4.6 on 8 Aug 2006</span>
</p>
</div>
</body>
Modified: httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request__apache2.html
URL: http://svn.apache.org/viewvc/httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request__apache2.html?rev=430022&r1=430021&r2=430022&view=diff
==============================================================================
--- httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request__apache2.html (original)
+++ httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request__apache2.html Wed Aug 9 03:20:06 2006
@@ -1,7 +1,7 @@
<html>
<head>
<link rel="stylesheet" type="text/css" href="dox.css" />
- <title>libapreq2-2.06-dev: libapreq2: APR::Request::Apache2</title>
+ <title>libapreq2-2.08: libapreq2: APR::Request::Apache2</title>
</head>
<body>
<div id="page-header">
@@ -10,8 +10,16 @@
<a href="http://httpd.apache.org/apreq/">Request Library Subproject</a></p>
<p class="apache">Apache HTTP Server Request Library</p>
<img alt="" src="feather.gif" /></div>
-<!-- Generated by Doxygen 1.4.3-20050530 -->
-<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
+<!-- Generated by Doxygen 1.4.6 -->
+<div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main Page</span></a></li>
+ <li><a href="modules.html"><span>Modules</span></a></li>
+ <li><a href="annotated.html"><span>Data Structures</span></a></li>
+ <li><a href="files.html"><span>Files</span></a></li>
+ <li><a href="pages.html"><span>Related Pages</span></a></li>
+ <li><a href="examples.html"><span>Examples</span></a></li>
+ </ul></div>
<h1>APR::Request::Apache2<br>
<small>
[<a class="el" href="group__apreq__xs.html">Perl</a>]</small>
@@ -75,7 +83,8 @@
<p>The APR::Request::Apache2 module provides a constructor
for interfacing with the mod_apreq2 Apache module.</p>
-<p>This manpage documents the APR::Request::Apache2 package.</p>
+<p>This manpage documents version 2.08 of
+the APR::Request::Apache2 package.</p>
<p>
@@ -105,7 +114,7 @@
<h1><a name="see_also">SEE ALSO</a></h1>
-<p><a href="/APR/Request.html">the APR::Request manpage</a>, <a href="/Apache2/RequestRec.html">the Apache2::RequestRec manpage</a>.</p>
+<p><a href="group__apreq__xs__apr__request.html">the APR::Request manpage</a>, <a href="group__apreq__xs__requestrec.html">the Apache2::RequestRec manpage</a>.</p>
<p>
@@ -115,7 +124,7 @@
<h1><a name="copyright">COPYRIGHT</a></h1>
<pre>
- Copyright 2003-2005 The Apache Software Foundation</pre>
+ Copyright 2003-2006 The Apache Software Foundation</pre>
<pre>
Licensed under the Apache License, Version 2.0 (the "License");
@@ -133,13 +142,13 @@
limitations under the License.</pre>
-<div id="footer">
+ <div id="footer">
<p class="apache">
-Copyright © 2003-2005 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
+Copyright © 2003-2006 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
See <a href="apreq_license.html">LICENSE</a>.</p>
<p class="menu">
<span style="color:#aaa">page generated by <a href="http://www.doxygen.org/"><code>doxygen</code></a>
-version 1.4.3-20050530 on 19 Jul 2005</span>
+version 1.4.6 on 8 Aug 2006</span>
</p>
</div>
</body>
Modified: httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request__cgi.html
URL: http://svn.apache.org/viewvc/httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request__cgi.html?rev=430022&r1=430021&r2=430022&view=diff
==============================================================================
--- httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request__cgi.html (original)
+++ httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request__cgi.html Wed Aug 9 03:20:06 2006
@@ -1,7 +1,7 @@
<html>
<head>
<link rel="stylesheet" type="text/css" href="dox.css" />
- <title>libapreq2-2.06-dev: libapreq2: APR::Request::CGI</title>
+ <title>libapreq2-2.08: libapreq2: APR::Request::CGI</title>
</head>
<body>
<div id="page-header">
@@ -10,8 +10,16 @@
<a href="http://httpd.apache.org/apreq/">Request Library Subproject</a></p>
<p class="apache">Apache HTTP Server Request Library</p>
<img alt="" src="feather.gif" /></div>
-<!-- Generated by Doxygen 1.4.3-20050530 -->
-<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
+<!-- Generated by Doxygen 1.4.6 -->
+<div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main Page</span></a></li>
+ <li><a href="modules.html"><span>Modules</span></a></li>
+ <li><a href="annotated.html"><span>Data Structures</span></a></li>
+ <li><a href="files.html"><span>Files</span></a></li>
+ <li><a href="pages.html"><span>Related Pages</span></a></li>
+ <li><a href="examples.html"><span>Examples</span></a></li>
+ </ul></div>
<h1>APR::Request::CGI<br>
<small>
[<a class="el" href="group__apreq__xs.html">Perl</a>]</small>
@@ -75,7 +83,8 @@
<p>The APR::Request::CGI module provides a constructor
for accessing CGI request data associated to a pool via libapreq2.</p>
-<p>This manpage documents the APR::Request::CGI package.</p>
+<p>This manpage documents version 2.08
+of the APR::Request::CGI package.</p>
<p>
@@ -95,7 +104,7 @@
<pre>
APR::Request::CGI->handle($pool)</pre>
-<p>Creates an APR::Request::CGI object. The argument <code>$pool</code>
+<p>Creates an APR::Request::CGI object. The argument <code>$pool</code>
is an APR::Pool object.</p>
<p>
@@ -105,7 +114,7 @@
<h1><a name="see_also">SEE ALSO</a></h1>
-<p><a href="/APR/Request.html">the APR::Request manpage</a>, <a href="/APR/Pool.html">the APR::Pool manpage</a>.</p>
+<p><a href="group__apreq__xs__apr__request.html">the APR::Request manpage</a>, <a href="http://apr.apache.org/docs/apr/apr__pools_8h.html">the APR::Pool manpage</a>.</p>
<p>
@@ -115,7 +124,7 @@
<h1><a name="copyright">COPYRIGHT</a></h1>
<pre>
- Copyright 2003-2005 The Apache Software Foundation</pre>
+ Copyright 2003-2006 The Apache Software Foundation</pre>
<pre>
Licensed under the Apache License, Version 2.0 (the "License");
@@ -133,13 +142,13 @@
limitations under the License.</pre>
-<div id="footer">
+ <div id="footer">
<p class="apache">
-Copyright © 2003-2005 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
+Copyright © 2003-2006 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
See <a href="apreq_license.html">LICENSE</a>.</p>
<p class="menu">
<span style="color:#aaa">page generated by <a href="http://www.doxygen.org/"><code>doxygen</code></a>
-version 1.4.3-20050530 on 19 Jul 2005</span>
+version 1.4.6 on 8 Aug 2006</span>
</p>
</div>
</body>
Modified: httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request__cookie.html
URL: http://svn.apache.org/viewvc/httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request__cookie.html?rev=430022&r1=430021&r2=430022&view=diff
==============================================================================
--- httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request__cookie.html (original)
+++ httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request__cookie.html Wed Aug 9 03:20:06 2006
@@ -1,7 +1,7 @@
<html>
<head>
<link rel="stylesheet" type="text/css" href="dox.css" />
- <title>libapreq2-2.06-dev: libapreq2: APR::Request::Cookie</title>
+ <title>libapreq2-2.08: libapreq2: APR::Request::Cookie</title>
</head>
<body>
<div id="page-header">
@@ -10,8 +10,16 @@
<a href="http://httpd.apache.org/apreq/">Request Library Subproject</a></p>
<p class="apache">Apache HTTP Server Request Library</p>
<img alt="" src="feather.gif" /></div>
-<!-- Generated by Doxygen 1.4.3-20050530 -->
-<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
+<!-- Generated by Doxygen 1.4.6 -->
+<div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main Page</span></a></li>
+ <li><a href="modules.html"><span>Modules</span></a></li>
+ <li><a href="annotated.html"><span>Data Structures</span></a></li>
+ <li><a href="files.html"><span>Files</span></a></li>
+ <li><a href="pages.html"><span>Related Pages</span></a></li>
+ <li><a href="examples.html"><span>Examples</span></a></li>
+ </ul></div>
<h1>APR::Request::Cookie<br>
<small>
[<a class="el" href="group__apreq__xs.html">Perl</a>]</small>
@@ -63,18 +71,6 @@
<li><a href="#expires">expires</a></li>
</ul>
- <li><a href="#methods">METHODS</a></li>
- <ul>
-
- <li><a href="#cookie_class">cookie_class</a></li>
- <li><a href="#get">get</a></li>
- <li><a href="#fetch">FETCH</a></li>
- <li><a href="#exists">EXISTS</a></li>
- <li><a href="#firstkey">FIRSTKEY</a></li>
- <li><a href="#nextkey">NEXTKEY</a></li>
- <li><a href="#do">do</a></li>
- </ul>
-
<li><a href="#see_also">SEE ALSO</a></li>
<li><a href="#copyright">COPYRIGHT</a></li>
</ul>
@@ -109,7 +105,7 @@
<pre>
# generate new cookie
- $cookie = APR::Request::Cookie->new($req->pool,
+ $cookie = APR::Request::Cookie->new($req->pool,
name => "foo",
value => "bar",
domain => "capricorn.com");
@@ -134,8 +130,8 @@
for interfacing with libapreq2's cookie API. It also provides
a few utility functions and constants.</p>
-<p>This manpage documents the APR::Request::Cookie and
-APR::Request::Cookie::Table packages.</p>
+<p>This manpage documents version 2.08
+of the APR::Request::Cookie package.</p>
<p>
@@ -158,6 +154,9 @@
<p>The double-quote interpolation operator maps to
<code>APR::Request::Cookie::value()</code>.</p>
+<pre>
+ ok "$cookie" eq $cookie->value;</pre>
+
<p>
</p>
@@ -174,14 +173,14 @@
<h2><a name="new">new</a></h2>
<pre>
- APR::Request::Cookie->new($pool,
- name => $name,
- value => $value,
+ APR::Request::Cookie->new($pool,
+ name => $name,
+ value => $value,
%args)</pre>
<p>Creates a new cookie. Here <code>$pool</code> is an APR::Pool object,
and <code>$name</code> is the cookie's name. The <code>$value</code> is transformed
-into the cookie's raw value through the class' <code>freeze()</code> method.
+into the cookie's raw value through the class' <code>freeze()</code> method.
The remaining arguments are optional:</p>
<dl>
@@ -189,65 +188,57 @@
<dt>
<strong>
<a name="item__2dsecure">-secure</a>
-</strong><br />
+</strong>
-</dt>
<dt>
<strong>
<a name="item__2dversion">-version</a>
-</strong><br />
+</strong>
-</dt>
<dt>
<strong>
<a name="item__2dpath">-path</a>
-</strong><br />
+</strong>
-</dt>
<dt>
<strong>
<a name="item__2ddomain">-domain</a>
-</strong><br />
+</strong>
-</dt>
<dt>
<strong>
<a name="item__2dport">-port</a>
-</strong><br />
+</strong>
-</dt>
<dt>
<strong>
<a name="item__2dexpires">-expires</a>
-</strong><br />
+</strong>
-</dt>
<dt>
<strong>
<a name="item__2dcomment">-comment</a>
-</strong><br />
+</strong>
-</dt>
<dt>
<strong>
<a name="item__2dcommenturl">-commentURL</a>
-</strong><br />
+</strong>
-</dt>
</dl>
@@ -268,6 +259,9 @@
<p>Class method representing the default serializer;
here it returns $value unmodified.</p>
+<pre>
+ ok "foo" eq APR::Request::Cookie->freeze("foo");</pre>
+
<p>
</p>
@@ -275,10 +269,13 @@
<h2><a name="thaw">thaw</a></h2>
<pre>
- APR::Request::Cookie->thaw($value)</pre>
+ $cookie->thaw()</pre>
-<p>Class method that reverses <code>freeze()</code>;
-here it returns $value unmodified.</p>
+<p>Reverses <code>freeze()</code>; here it simply returns
+$cookie->value since <code>freeze()</code> is a noop.</p>
+
+<pre>
+ ok $cookie->thaw eq $cookie->value;</pre>
<p>
@@ -289,9 +286,9 @@
<pre>
$cookie->name()</pre>
-<p>Fetch the cookie's name. This attribute
-cannot be modified and is never serialized;
-ie <code>freeze()</code> and <code>thaw()</code> do not act on the
+<p>Fetch the cookie's name. This attribute
+cannot be modified and is never serialized;
+ie <code>freeze()</code> and <code>thaw()</code> do not act on the
cookie's name.</p>
<p>
@@ -318,6 +315,10 @@
<p>Get/set the cookie's secure flag.</p>
+<pre>
+ $cookie->secure(1);
+ ok $cookie->secure == 1;</pre>
+
<p>
</p>
@@ -333,6 +334,11 @@
spec; Version 1 cookies conform to either
RFC 2109 or RFC 2965.</p>
+<pre>
+ $version = $cookie->version;
+ $cookie->version(1);
+ ok $cookie->version == 1;</pre>
+
<p>
</p>
@@ -345,6 +351,11 @@
<p>Get/set the cookie's path string.</p>
+<pre>
+ $path = $cookie->path;
+ $cookie->path("/1/2/3/4");
+ ok $cookie->path eq "/1/2/3/4";</pre>
+
<p>
</p>
@@ -357,6 +368,11 @@
<p>Get/set the cookie's domain string.</p>
+<pre>
+ $domain = $cookie->domain;
+ $cookie->domain("apache.org");
+ ok $cookie->domain eq "apache.org";</pre>
+
<p>
</p>
@@ -370,6 +386,11 @@
<p>Get/set the cookie's port string.
Only valid for Version 1 cookies.</p>
+<pre>
+ $port = $cookie->port;
+ $cookie->port(8888);
+ ok $cookie->port == 8888;</pre>
+
<p>
</p>
@@ -383,6 +404,11 @@
<p>Get/set the cookie's comment string.
Only valid for Version 1 cookies.</p>
+<pre>
+ $comment = $cookie->comment;
+ $cookie->comment("quux");
+ ok $cookie->comment eq "quux";</pre>
+
<p>
</p>
@@ -396,6 +422,11 @@
<p>Get/set the cookie's commentURL string.
Only valid for Version 1 cookies.</p>
+<pre>
+ $commentURL = $cookie->commentURL;
+ $cookie->commentURL("/foo/bar");
+ ok $cookie->commentURL eq "/foo/bar";</pre>
+
<p>
</p>
@@ -408,6 +439,11 @@
<p>Get/set the cookie's internal tainted flag.</p>
+<pre>
+ $tainted = $cookie->is_tainted;
+ $cookie->is_tainted(1);
+ ok $cookie->is_tainted == 1;</pre>
+
<p>
</p>
@@ -417,7 +453,7 @@
<pre>
APR::Request::Cookie->make($pool, $name, $value)</pre>
-<p>Fast XS cookie constructor invoked by <code>new()</code>.
+<p>Fast XS cookie constructor invoked by <code>new()</code>.
The cookie's raw name & value are taken directly from the
passed in arguments; no freezing/encoding is done on the $value.</p>
@@ -433,6 +469,9 @@
<p>String representation of the cookie, suitable for inclusion
in a ``Set-Cookie'' header.</p>
+<pre>
+ print "Set-Cookie: ", $cookie->as_string, "\n";</pre>
+
<p>
</p>
@@ -457,127 +496,9 @@
</p>
<hr />
-<h1><a name="methods">METHODS</a></h1>
-
-<pre>
- APR::Request::Cookie::Table - read-only version of APR::Table.</pre>
-
-<p>Tables in this class normally arise from calls to
-<code>APR::Request::jar()</code>.</p>
-
-<p>
-
-</p>
-
-<h2><a name="cookie_class">cookie_class</a></h2>
-
-<pre>
- $table->cookie_class()
- $table->cookie_class($set)</pre>
-
-<p>Get/set the class each table element is blessed into during a
-<a href="#get">the get manpage</a> or <em>FETCH</em> call. If defined, the class must be derived
-from APR::Request::Cookie. When called with $set, it returns
-the $table. Otherwise it returns the name of the current class,
-or undef if no cookie class is defined.</p>
-
-<pre>
- {
- package FOO;
- @ISA= 'APR::Request::Cookie';
- }</pre>
-
-<pre>
- $jar->cookie_class("FOO");
- ok $_->isa("FOO") for values %$jar;</pre>
-
-<p>
-
-</p>
-
-<h2><a name="get">get</a></h2>
-
-<pre>
- $table->get($key)</pre>
-
-<p>Same as FETCH.</p>
-
-<p>
-
-</p>
-
-<h2><a name="fetch">FETCH</a></h2>
-
-<pre>
- $table->FETCH($key)</pre>
-
-<p>In scalar context, this returns the first value matching
-$key (note: see NEXTKEY for additional notes). The match
-is always case-insensitive. In list context, this returns
-all matching values. Note: the type of the return values
-depends on the table's current cookie_class.</p>
-
-<p>
-
-</p>
-
-<h2><a name="exists">EXISTS</a></h2>
-
-<p>Synonym for <code>defined</code>; these tables are not
-allowed to contain undefined values. Since these
-are constant tables, they don't autovivify either.</p>
-
-<p>
-
-</p>
-
-<h2><a name="firstkey">FIRSTKEY</a></h2>
-
-<pre>
- $table->FIRSTKEY()</pre>
-
-<p>Returns the first key in the table.</p>
-
-<p>
-
-</p>
-
-<h2><a name="nextkey">NEXTKEY</a></h2>
-
-<pre>
- $table->NEXTKEY()</pre>
-
-<p>Returns the next key in the table. For perl 5.8+,
-if the key is multivalued, a subsequent FETCH on
-this key will return the corresponding value, until
-either NEXTKEY or FIRSTKEY is invoked again. For
-perl 5.6, FETCH always returns the first value.</p>
-
-<p>
-
-</p>
-
-<h2><a name="do">do</a></h2>
-
-<pre>
- $table->do($callback, @keys)</pre>
-
-<p>Same as APR::Table::do; iterates over the table
-calling $callback->($key, $value) for each matching
-@keys. If @keys is empty, this iterates over the
-entire table.</p>
-
-<p>Note: The type of $value inserted into the callback
-depends on the table's current cookie_class.</p>
-
-<p>
-
-</p>
-<hr />
-
<h1><a name="see_also">SEE ALSO</a></h1>
-<p><a href="/Apache2/Cookie.html">the Apache2::Cookie manpage</a>, <a href="/APR/Request.html">the APR::Request manpage</a>, <a href="/APR/Table.html">the APR::Table manpage</a>.</p>
+<p><a href="group__apreq__xs__cookie.html">the Apache2::Cookie manpage</a>, <a href="group__apreq__xs__apr__request.html">the APR::Request manpage</a>.</p>
<p>
@@ -587,7 +508,7 @@
<h1><a name="copyright">COPYRIGHT</a></h1>
<pre>
- Copyright 2003-2005 The Apache Software Foundation</pre>
+ Copyright 2003-2006 The Apache Software Foundation</pre>
<pre>
Licensed under the Apache License, Version 2.0 (the "License");
@@ -605,13 +526,13 @@
limitations under the License.</pre>
-<div id="footer">
+ <div id="footer">
<p class="apache">
-Copyright © 2003-2005 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
+Copyright © 2003-2006 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
See <a href="apreq_license.html">LICENSE</a>.</p>
<p class="menu">
<span style="color:#aaa">page generated by <a href="http://www.doxygen.org/"><code>doxygen</code></a>
-version 1.4.3-20050530 on 19 Jul 2005</span>
+version 1.4.6 on 8 Aug 2006</span>
</p>
</div>
</body>
Modified: httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request__error.html
URL: http://svn.apache.org/viewvc/httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request__error.html?rev=430022&r1=430021&r2=430022&view=diff
==============================================================================
--- httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request__error.html (original)
+++ httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request__error.html Wed Aug 9 03:20:06 2006
@@ -1,7 +1,7 @@
<html>
<head>
<link rel="stylesheet" type="text/css" href="dox.css" />
- <title>libapreq2-2.06-dev: libapreq2: APR::Request::Error</title>
+ <title>libapreq2-2.08: libapreq2: APR::Request::Error</title>
</head>
<body>
<div id="page-header">
@@ -10,8 +10,16 @@
<a href="http://httpd.apache.org/apreq/">Request Library Subproject</a></p>
<p class="apache">Apache HTTP Server Request Library</p>
<img alt="" src="feather.gif" /></div>
-<!-- Generated by Doxygen 1.4.3-20050530 -->
-<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
+<!-- Generated by Doxygen 1.4.6 -->
+<div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main Page</span></a></li>
+ <li><a href="modules.html"><span>Modules</span></a></li>
+ <li><a href="annotated.html"><span>Data Structures</span></a></li>
+ <li><a href="files.html"><span>Files</span></a></li>
+ <li><a href="pages.html"><span>Related Pages</span></a></li>
+ <li><a href="examples.html"><span>Examples</span></a></li>
+ </ul></div>
<h1>APR::Request::Error<br>
<small>
[<a class="el" href="group__apreq__xs.html">Perl</a>]</small>
@@ -37,6 +45,26 @@
<li><a href="#strerror">strerror</a></li>
</ul>
+ <li><a href="#error_constants">ERROR CONSTANTS</a></li>
+ <ul>
+
+ <li><a href="#general">GENERAL</a></li>
+ <li><a href="#tainted">TAINTED</a></li>
+ <li><a href="#baddata">BADDATA</a></li>
+ <li><a href="#badchar">BADCHAR</a></li>
+ <li><a href="#badseq">BADSEQ</a></li>
+ <li><a href="#badattr">BADATTR</a></li>
+ <li><a href="#badheader">BADHEADER</a></li>
+ <li><a href="#nodata">NODATA</a></li>
+ <li><a href="#notoken">NOTOKEN</a></li>
+ <li><a href="#noattr">NOATTR</a></li>
+ <li><a href="#noheader">NOHEADER</a></li>
+ <li><a href="#noparser">NOPARSER</a></li>
+ <li><a href="#mismatch">MISMATCH</a></li>
+ <li><a href="#overlimit">OVERLIMIT</a></li>
+ <li><a href="#notempty">NOTEMPTY</a></li>
+ </ul>
+
<li><a href="#see_also">SEE ALSO</a></li>
<li><a href="#copyright">COPYRIGHT</a></li>
</ul>
@@ -71,7 +99,8 @@
<h1><a name="description">DESCRIPTION</a></h1>
-<p>This manpage documents the APR::Request::Error package.</p>
+<p>This manpage documents version 2.08
+of the APR::Request::Error package.</p>
<p>
@@ -98,9 +127,136 @@
</p>
<hr />
+<h1><a name="error_constants">ERROR CONSTANTS</a></h1>
+
+<p>
+
+</p>
+
+<h2><a name="general">GENERAL</a></h2>
+
+<p>Internal apreq error</p>
+
+<p>
+
+</p>
+
+<h2><a name="tainted">TAINTED</a></h2>
+
+<p>Attempt to perform unsafe action with tainted data</p>
+
+<p>
+
+</p>
+
+<h2><a name="baddata">BADDATA</a></h2>
+
+<p>Malformed input data</p>
+
+<p>
+
+</p>
+
+<h2><a name="badchar">BADCHAR</a></h2>
+
+<p>Invalid character</p>
+
+<p>
+
+</p>
+
+<h2><a name="badseq">BADSEQ</a></h2>
+
+<p>Invalid byte sequence</p>
+
+<p>
+
+</p>
+
+<h2><a name="badattr">BADATTR</a></h2>
+
+<p>Unrecognized attribute</p>
+
+<p>
+
+</p>
+
+<h2><a name="badheader">BADHEADER</a></h2>
+
+<p>Malformed header string</p>
+
+<p>
+
+</p>
+
+<h2><a name="nodata">NODATA</a></h2>
+
+<p>Missing input data</p>
+
+<p>
+
+</p>
+
+<h2><a name="notoken">NOTOKEN</a></h2>
+
+<p>Expected token not present</p>
+
+<p>
+
+</p>
+
+<h2><a name="noattr">NOATTR</a></h2>
+
+<p>Missing attribute</p>
+
+<p>
+
+</p>
+
+<h2><a name="noheader">NOHEADER</a></h2>
+
+<p>Missing header</p>
+
+<p>
+
+</p>
+
+<h2><a name="noparser">NOPARSER</a></h2>
+
+<p>Missing parser</p>
+
+<p>
+
+</p>
+
+<h2><a name="mismatch">MISMATCH</a></h2>
+
+<p>Conflicting information</p>
+
+<p>
+
+</p>
+
+<h2><a name="overlimit">OVERLIMIT</a></h2>
+
+<p>Exceeds configured maximum limit</p>
+
+<p>
+
+</p>
+
+<h2><a name="notempty">NOTEMPTY</a></h2>
+
+<p>Setting already configured</p>
+
+<p>
+
+</p>
+<hr />
+
<h1><a name="see_also">SEE ALSO</a></h1>
-<p><a href="/APR/Request.html">the APR::Request manpage</a>, <a href="/APR/Error.html">the APR::Error manpage</a></p>
+<p><a href="group__apreq__xs__apr__request.html">the APR::Request manpage</a>, <a href="http://apr.apache.org/docs/apr/apr__errors_8h.html">the APR::Error manpage</a></p>
<p>
@@ -110,7 +266,7 @@
<h1><a name="copyright">COPYRIGHT</a></h1>
<pre>
- Copyright 2003-2005 The Apache Software Foundation</pre>
+ Copyright 2003-2006 The Apache Software Foundation</pre>
<pre>
Licensed under the Apache License, Version 2.0 (the "License");
@@ -128,13 +284,13 @@
limitations under the License.</pre>
-<div id="footer">
+ <div id="footer">
<p class="apache">
-Copyright © 2003-2005 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
+Copyright © 2003-2006 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
See <a href="apreq_license.html">LICENSE</a>.</p>
<p class="menu">
<span style="color:#aaa">page generated by <a href="http://www.doxygen.org/"><code>doxygen</code></a>
-version 1.4.3-20050530 on 19 Jul 2005</span>
+version 1.4.6 on 8 Aug 2006</span>
</p>
</div>
</body>
Modified: httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request__param.html
URL: http://svn.apache.org/viewvc/httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request__param.html?rev=430022&r1=430021&r2=430022&view=diff
==============================================================================
--- httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request__param.html (original)
+++ httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__apr__request__param.html Wed Aug 9 03:20:06 2006
@@ -1,7 +1,7 @@
<html>
<head>
<link rel="stylesheet" type="text/css" href="dox.css" />
- <title>libapreq2-2.06-dev: libapreq2: APR::Request::Param</title>
+ <title>libapreq2-2.08: libapreq2: APR::Request::Param</title>
</head>
<body>
<div id="page-header">
@@ -10,8 +10,16 @@
<a href="http://httpd.apache.org/apreq/">Request Library Subproject</a></p>
<p class="apache">Apache HTTP Server Request Library</p>
<img alt="" src="feather.gif" /></div>
-<!-- Generated by Doxygen 1.4.3-20050530 -->
-<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
+<!-- Generated by Doxygen 1.4.6 -->
+<div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main Page</span></a></li>
+ <li><a href="modules.html"><span>Modules</span></a></li>
+ <li><a href="annotated.html"><span>Data Structures</span></a></li>
+ <li><a href="files.html"><span>Files</span></a></li>
+ <li><a href="pages.html"><span>Related Pages</span></a></li>
+ <li><a href="examples.html"><span>Examples</span></a></li>
+ </ul></div>
<h1>APR::Request::Param<br>
<small>
[<a class="el" href="group__apreq__xs.html">Perl</a>]</small>
@@ -60,18 +68,6 @@
<li><a href="#methods">METHODS</a></li>
<ul>
- <li><a href="#param_class">param_class</a></li>
- <li><a href="#get">get</a></li>
- <li><a href="#fetch">FETCH</a></li>
- <li><a href="#exists">EXISTS</a></li>
- <li><a href="#nextkey">NEXTKEY</a></li>
- <li><a href="#firstkey">FIRSTKEY</a></li>
- <li><a href="#do">do</a></li>
- </ul>
-
- <li><a href="#methods">METHODS</a></li>
- <ul>
-
<li><a href="#new__tiehandle">new, TIEHANDLE</a></li>
<li><a href="#read">READ</a></li>
<li><a href="#readline">READLINE</a></li>
@@ -118,7 +114,9 @@
ok $_->isa("APR::Request::Param") for values %$body;</pre>
<pre>
- @uploads = grep {$_->upload} values %$body;</pre>
+ @uploads = grep {$_->upload} values %$body;
+ $param = $body->get('beta');
+ $param->upload_slurp(my $content);</pre>
<p>
@@ -131,6 +129,10 @@
for interfacing with libapreq2's param API. It also provides
a few utility functions and constants.</p>
+<p>This manpage documents version 2.08
+of the APR::Request::Param, APR::Request::Brigade,
+and APR::Request::Brigade::IO packages.</p>
+
<p>
</p>
@@ -149,7 +151,7 @@
<pre>
"$param"</pre>
-<p>The double-quote interpolation operator maps to
+<p>The double-quote interpolation operator maps to
<code>APR::Request::Param::value()</code>.</p>
<p>
@@ -200,6 +202,11 @@
this also activates the SvUTF8_on flag during calls
to <code>name()</code> and/or value().</p>
+<pre>
+ $tainted = $param->is_tainted;
+ $param->is_tainted(0);
+ ok $param->is_tainted == 0;</pre>
+
<p>
</p>
@@ -219,33 +226,29 @@
<li>
<strong>
<a name="item_apreq_charset_ascii">APREQ_CHARSET_ASCII (7-bit us-ascii)</a>
-</strong><br />
+</strong>
-</li>
<li>
<strong>
<a name="item_apreq_charset_latin1">APREQ_CHARSET_LATIN1 (8-bit iso-8859-1)</a>
-</strong><br />
+</strong>
-</li>
<li>
<strong>
<a name="item_apreq_charset_cp1252">APREQ_CHARSET_CP1252 (8-bit Windows-1252)</a>
-</strong><br />
+</strong>
-</li>
<li>
<strong>
<a name="item_apreq_charset_utf8">APREQ_CHARSET_UTF8 (utf8 encoded Unicode)</a>
-</strong><br />
+</strong>
-</li>
</ol>
@@ -254,6 +257,11 @@
<p>See <a href="#is_tainted">the is_tainted manpage</a> above for info about how APREQ_CHARSET_UTF8
relates to perl's UTF-8 flag.</p>
+<pre>
+ $charset = $param->charset;
+ $param->charset(2);
+ ok $param->charset == 2;</pre>
+
<p>
</p>
@@ -310,7 +318,7 @@
$param->upload_link($path)</pre>
<p>Links the file-upload content with the local file named <code>$path</code>.
-Creates a hard-link if the spoolfile's (see <a href="#upload_tempname">the upload_tempname manpage</a>)
+Creates a hard-link if the spoolfile's (see <a href="#upload_tempname">the upload_tempname manpage</a>)
temporary directory is on the same device as <code>$path</code>;
otherwise this writes a copy.</p>
@@ -377,7 +385,7 @@
<h2><a name="upload_fh">upload_fh</a></h2>
<pre>
- $param->upload_fh</pre>
+ $param->upload_fh()</pre>
<p>Returns a seekable filehandle representing the file-upload content.</p>
@@ -388,110 +396,6 @@
<h1><a name="methods">METHODS</a></h1>
-<p>APR::Request::Param::Table</p>
-
-<p>
-
-</p>
-
-<h2><a name="param_class">param_class</a></h2>
-
-<pre>
- $table->param_class()
- $table->param_class($set)</pre>
-
-<p>Get/set the class each table element is blessed into during a
-<a href="#get">the get manpage</a> or <em>FETCH</em> call. If defined, the class must be derived
-from APR::Request::Param. When called with $set, it returns
-the $table. Otherwise it returns the name of the current class,
-or undef if no param class is defined.</p>
-
-<p>
-
-</p>
-
-<h2><a name="get">get</a></h2>
-
-<pre>
- $table->get($key)</pre>
-
-<p>Same as FETCH.</p>
-
-<p>
-
-</p>
-
-<h2><a name="fetch">FETCH</a></h2>
-
-<pre>
- $table->FETCH($key)</pre>
-
-<p>In scalar context, this returns the first value matching
-$key (note: see NEXTKEY for additional notes). The match
-is always case-insensitive. In list context, this returns
-all matching values. Note: the type of the return values
-depends on the table's current param_class.</p>
-
-<p>
-
-</p>
-
-<h2><a name="exists">EXISTS</a></h2>
-
-<p>Synonym for <code>defined</code>; these tables are not
-allowed to contain undefined values. Since these
-are constant tables, they don't autovivify either.</p>
-
-<p>
-
-</p>
-
-<h2><a name="nextkey">NEXTKEY</a></h2>
-
-<pre>
- $table->NEXTKEY()</pre>
-
-<p>Returns the next key in the table. For perl 5.8+,
-if the key is multivalued, a subsequent FETCH on
-this key will return the corresponding value, until
-either NEXTKEY or FIRSTKEY is invoked again. For
-perl 5.6, FETCH always returns the first value.</p>
-
-<p>
-
-</p>
-
-<h2><a name="firstkey">FIRSTKEY</a></h2>
-
-<pre>
- $table->FIRSTKEY()</pre>
-
-<p>Returns the first key in the table.</p>
-
-<p>
-
-</p>
-
-<h2><a name="do">do</a></h2>
-
-<pre>
- $table->do($callback, @keys)</pre>
-
-<p>Same as APR::Table::do; iterates over the table
-calling $callback->($key, $value) for each matching
-@keys. If @keys is empty, this iterates over the
-entire table.</p>
-
-<p>Note: The type of $value inserted into the callback
-depends on the table's current value_class.</p>
-
-<p>
-
-</p>
-<hr />
-
-<h1><a name="methods">METHODS</a></h1>
-
<p>APR::Request::Brigade</p>
<p>This class is derived from APR::Brigade, providing additional
@@ -518,7 +422,7 @@
<pre>
use Symbol;
$fh = gensym;
- tie *$fh, "APR::Request:Brigade", $bb;
+ tie *$fh, "APR::Request::Brigade", $bb;
print while <$fh>;</pre>
<p>
@@ -582,7 +486,7 @@
<h1><a name="see_also">SEE ALSO</a></h1>
-<p><a href="/APR/Request.html">the APR::Request manpage</a>, <a href="/APR/Table.html">the APR::Table manpage</a>, <a href="/APR/Brigade.html">the APR::Brigade manpage</a>.</p>
+<p><a href="group__apreq__xs__apr__request.html">the APR::Request manpage</a>, <a href="http://apr.apache.org/docs/apr/apr__tables_8h.html">the APR::Table manpage</a>, <a href="http://apr.apache.org/docs/apr-util/apr__buckets_8h.html">the APR::Brigade manpage</a>.</p>
<p>
@@ -592,7 +496,7 @@
<h1><a name="copyright">COPYRIGHT</a></h1>
<pre>
- Copyright 2003-2005 The Apache Software Foundation</pre>
+ Copyright 2003-2006 The Apache Software Foundation</pre>
<pre>
Licensed under the Apache License, Version 2.0 (the "License");
@@ -610,13 +514,13 @@
limitations under the License.</pre>
-<div id="footer">
+ <div id="footer">
<p class="apache">
-Copyright © 2003-2005 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
+Copyright © 2003-2006 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
See <a href="apreq_license.html">LICENSE</a>.</p>
<p class="menu">
<span style="color:#aaa">page generated by <a href="http://www.doxygen.org/"><code>doxygen</code></a>
-version 1.4.3-20050530 on 19 Jul 2005</span>
+version 1.4.6 on 8 Aug 2006</span>
</p>
</div>
</body>
Modified: httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__cookie.html
URL: http://svn.apache.org/viewvc/httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__cookie.html?rev=430022&r1=430021&r2=430022&view=diff
==============================================================================
--- httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__cookie.html (original)
+++ httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__cookie.html Wed Aug 9 03:20:06 2006
@@ -1,7 +1,7 @@
<html>
<head>
<link rel="stylesheet" type="text/css" href="dox.css" />
- <title>libapreq2-2.06-dev: libapreq2: Apache2::Cookie</title>
+ <title>libapreq2-2.08: libapreq2: Apache2::Cookie</title>
</head>
<body>
<div id="page-header">
@@ -10,8 +10,16 @@
<a href="http://httpd.apache.org/apreq/">Request Library Subproject</a></p>
<p class="apache">Apache HTTP Server Request Library</p>
<img alt="" src="feather.gif" /></div>
-<!-- Generated by Doxygen 1.4.3-20050530 -->
-<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
+<!-- Generated by Doxygen 1.4.6 -->
+<div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main Page</span></a></li>
+ <li><a href="modules.html"><span>Modules</span></a></li>
+ <li><a href="annotated.html"><span>Data Structures</span></a></li>
+ <li><a href="files.html"><span>Files</span></a></li>
+ <li><a href="pages.html"><span>Related Pages</span></a></li>
+ <li><a href="examples.html"><span>Examples</span></a></li>
+ </ul></div>
<h1>Apache2::Cookie<br>
<small>
[<a class="el" href="group__apreq__xs.html">Perl</a>]</small>
@@ -94,7 +102,7 @@
$c_in = $j->cookies("foo"); # get cookie from request headers</pre>
<pre>
- $c_out = Apache2::Cookie->new($r,
+ $c_out = Apache2::Cookie->new($r,
-name => "mycookie",
-value => $c_in->name );</pre>
@@ -109,10 +117,10 @@
<h1><a name="description">DESCRIPTION</a></h1>
-<p>The Apache2::Cookie module is based on the original 1.X versions, which mimic
-the CGI::Cookie API. The current version of this module includes several packages
-and methods which are patterned after Apache2::Request, yet remain largely
-backwards-compatible with the original 1.X API (see the <a href="#porting_from_1_x">PORTING from 1.X</a> section
+<p>The Apache2::Cookie module is based on the original 1.X versions, which mimic
+the CGI::Cookie API. The current version of this module includes several packages
+and methods which are patterned after Apache2::Request, yet remain largely
+backwards-compatible with the original 1.X API (see the <a href="#porting_from_1_x">PORTING from 1.X</a> section
below for known issues).</p>
<p>This manpage documents the Apache2::Cookie and Apache2::Cookie::Jar packages.</p>
@@ -137,7 +145,7 @@
<pre>
Apache2::Cookie::Jar->new($env)</pre>
-<p>Class method that retrieves the parsed cookie jar from the current
+<p>Class method that retrieves the parsed cookie jar from the current
environment.</p>
<p>
@@ -154,14 +162,14 @@
context the first such cookie is returned, and in list context the
full list of such cookies are returned.</p>
-<p>If the $key argument is omitted, <code>scalar $jar->cookies()</code> will
-return an APR::Request::Cookie::Table object containing all the cookies in
-the jar. Modifications to the this object will affect the jar's
-internal <em>cookies</em> table in <code>apreq_jar_t</code>, so their impact will
+<p>If the $key argument is omitted, <code>scalar $jar->cookies()</code> will
+return an APR::Request::Cookie::Table object containing all the cookies in
+the jar. Modifications to the this object will affect the jar's
+internal <em>cookies</em> table in <code>apreq_jar_t</code>, so their impact will
be noticed by all libapreq2 applications during this request.</p>
-<p>In list context <code>$jar->cookies()</code> returns the list of names
-for all the cookies in the jar. The order corresponds to the
+<p>In list context <code>$jar->cookies()</code> returns the list of names
+for all the cookies in the jar. The order corresponds to the
order in which the cookies appeared in the incoming ``Cookie'' header.</p>
<p>This method will throw an <code>APR::Request::Error</code> object into $@ if
@@ -214,16 +222,16 @@
<pre>
$cookie = Apache2::Cookie->new($r,
- -name => 'foo',
- -value => 'bar',
- -expires => '+3M',
- -domain => '.capricorn.com',
+ -name => 'foo',
+ -value => 'bar',
+ -expires => '+3M',
+ -domain => '.capricorn.com',
-path => '/cgi-bin/database',
- -secure => 1
+ -secure => 1
);</pre>
<p>The <code>-value</code> argument may be either an arrayref, a hashref, or
-a string. <code>Apache2::Cookie::freeze</code> encodes this argument into the
+a string. <code>Apache2::Cookie::freeze</code> encodes this argument into the
cookie's raw value.</p>
<p>
@@ -252,9 +260,9 @@
Apache2::Cookie->thaw($value)
$cookie->thaw()</pre>
-<p>This is the helper method (for <code>value</code>) responsible for decoding the
+<p>This is the helper method (for <code>value</code>) responsible for decoding the
raw value of a cookie. An optional argument $value may be used in
-place of the cookie's raw value. This method can also decode cookie
+place of the cookie's raw value. This method can also decode cookie
values created using CGI::Cookie or Apache2::Cookie 1.X.</p>
<pre>
@@ -270,7 +278,7 @@
<pre>
$cookie->as_string()</pre>
-<p>Format the cookie object as a string. The quote-operator for Apache2::Cookie
+<p>Format the cookie object as a string. The quote-operator for Apache2::Cookie
is overloaded to run this method whenever a cookie appears in quotes.</p>
<pre>
@@ -302,14 +310,14 @@
my $value = $cookie->value;
my @values = $cookie->value;</pre>
-<p>Note: if the cookie's value was created using a <code>freeze</code> method,
-one way to reconstitute the object is by subclassing
+<p>Note: if the cookie's value was created using a <code>freeze</code> method,
+one way to reconstitute the object is by subclassing
Apache2::Cookie with a package that provides the associated <code>thaw</code> sub:</p>
<pre>
{
package My::COOKIE;
- @ISA = 'Apache2::Cookie';
+ @ISA = 'Apache2::Cookie';
sub thaw { my $val = shift->raw_value; $val =~ tr/a-z/A-Z/; $val }
}</pre>
@@ -399,7 +407,7 @@
$cookie->version($set)</pre>
<p>Get or set the cookie version for this cookie.
-Netscape spec cookies have version = 0;
+Netscape spec cookies have version = 0;
RFC-compliant cookies have version = 1.</p>
<pre>
@@ -492,6 +500,10 @@
my $cookies = Apache2::Cookie->fetch($r); # APR::Request::Cookie::Table ref</pre>
<pre>
+ It should be noted, that with perl 5.8+ Iterator magic, table is able
+ to handle multiple cookies of the same name.</pre>
+
+<pre>
my %cookies = Apache2::Cookie->fetch($r);</pre>
<p>
@@ -507,28 +519,26 @@
<li>
<strong>
-<a name="item_as"><code>Apache2::Cookie::fetch</code> now expects an <code>$r</code> object as (second)
+<a name="item_as"><code>Apache2::Cookie::fetch</code> now expects an <code>$r</code> object as (second)
argument, although this isn't necessary in mod_perl 2 if
- <code>Apache2::RequestUtil</code> is loaded.</a>
-</strong><br />
+ <code>Apache2::RequestUtil</code> is loaded and 'PerlOptions +GlobalRequest'
+ is in effect.</a>
+</strong>
-</li>
<li>
<strong>
<a name="item_apache2_3a_3acookie_3a_3aparse_is_gone_2e"><code>Apache2::Cookie::parse</code> is gone.</a>
-</strong><br />
+</strong>
-</li>
<li>
<strong>
<a name="item_apache2_3a_3acookie_3a_3anew_no_longer_encodes_the"><code>Apache2::Cookie::new</code> no longer encodes the supplied cookie name.</a>
-</strong><br />
+</strong>
-</li>
<li>
@@ -536,9 +546,8 @@
<a name="item_name"><code>name()</code> and <code>value()</code> no longer accept a ``set'' argument. In other words,
neither a cookie's name, nor its value, may be modified. A new cookie
should be made instead.</a>
-</strong><br />
+</strong>
-</li>
</ul>
@@ -551,8 +560,8 @@
<h1><a name="see_also">SEE ALSO</a></h1>
-<p><a href="/Apache2/Request.html">the Apache2::Request manpage</a>, <a href="/APR/Request/Cookie.html">the APR::Request::Cookie manpage</a>,
-<a href="/APR/Request/Error.html">the APR::Request::Error manpage</a>, CGI::Cookie(3)</p>
+<p><a href="group__apreq__xs__request.html">the Apache2::Request manpage</a>, <a href="group__apreq__xs__apr__request__cookie.html">the APR::Request::Cookie manpage</a>,
+<a href="group__apreq__xs__apr__request__error.html">the APR::Request::Error manpage</a>, CGI::Cookie(3)</p>
<p>
@@ -562,7 +571,7 @@
<h1><a name="copyright">COPYRIGHT</a></h1>
<pre>
- Copyright 2003-2005 The Apache Software Foundation</pre>
+ Copyright 2003-2006 The Apache Software Foundation</pre>
<pre>
Licensed under the Apache License, Version 2.0 (the "License");
@@ -580,13 +589,13 @@
limitations under the License.</pre>
-<div id="footer">
+ <div id="footer">
<p class="apache">
-Copyright © 2003-2005 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
+Copyright © 2003-2006 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
See <a href="apreq_license.html">LICENSE</a>.</p>
<p class="menu">
<span style="color:#aaa">page generated by <a href="http://www.doxygen.org/"><code>doxygen</code></a>
-version 1.4.3-20050530 on 19 Jul 2005</span>
+version 1.4.6 on 8 Aug 2006</span>
</p>
</div>
</body>
Modified: httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__request.html
URL: http://svn.apache.org/viewvc/httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__request.html?rev=430022&r1=430021&r2=430022&view=diff
==============================================================================
--- httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__request.html (original)
+++ httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__request.html Wed Aug 9 03:20:06 2006
@@ -1,7 +1,7 @@
<html>
<head>
<link rel="stylesheet" type="text/css" href="dox.css" />
- <title>libapreq2-2.06-dev: libapreq2: Apache2::Request</title>
+ <title>libapreq2-2.08: libapreq2: Apache2::Request</title>
</head>
<body>
<div id="page-header">
@@ -10,8 +10,16 @@
<a href="http://httpd.apache.org/apreq/">Request Library Subproject</a></p>
<p class="apache">Apache HTTP Server Request Library</p>
<img alt="" src="feather.gif" /></div>
-<!-- Generated by Doxygen 1.4.3-20050530 -->
-<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
+<!-- Generated by Doxygen 1.4.6 -->
+<div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main Page</span></a></li>
+ <li><a href="modules.html"><span>Modules</span></a></li>
+ <li><a href="annotated.html"><span>Data Structures</span></a></li>
+ <li><a href="files.html"><span>Files</span></a></li>
+ <li><a href="pages.html"><span>Related Pages</span></a></li>
+ <li><a href="examples.html"><span>Examples</span></a></li>
+ </ul></div>
<h1>Apache2::Request<br>
<small>
[<a class="el" href="group__apreq__xs.html">Perl</a>]</small>
@@ -110,26 +118,23 @@
<a name="item_as"><code>Apache2::Request::new</code> takes an environment-specific
object <code>$r</code> as (second) argument. Newer versions of CGI.pm also accept
this syntax within modperl.</a>
-</strong><br />
+</strong>
-</li>
<li>
<strong>
<a name="item_the_query_parameters_are_stored_in_apr_3a_3atable_">The query parameters are stored in APR::Table derived objects, and
are therefore retrieved from the table by using case-insensitive keys.</a>
-</strong><br />
+</strong>
-</li>
<li>
<strong>
<a name="item_the_query_string_is_always_parsed_immediately_2c_e">The query string is always parsed immediately, even for POST requests.</a>
-</strong><br />
+</strong>
-</li>
</ul>
@@ -160,38 +165,35 @@
<li>
<strong>
<a name="item_post_max_2c_max_body"><code>POST_MAX</code>, <code>MAX_BODY</code></a>
-</strong><br />
+</strong>
-</li>
-Limit the size of POST data (in bytes).
+<p>Limit the size of POST data (in bytes).</p>
-<p></p>
+</li>
<li>
<strong>
<a name="item_disable_uploads"><code>DISABLE_UPLOADS</code></a>
-</strong><br />
+</strong>
-</li>
-Disable file uploads.
+<p>Disable file uploads.</p>
-<p></p>
+</li>
<li>
<strong>
<a name="item_temp_dir"><code>TEMP_DIR</code></a>
-</strong><br />
+</strong>
-</li>
-Sets the directory where upload files are spooled. On a *nix-like
+<p>Sets the directory where upload files are spooled. On a *nix-like
that supports <em>link(2)</em>, the TEMP_DIR should be located on the same
-file system as the final destination file:
+file system as the final destination file:</p>
<pre>
use Apache2::Upload;
@@ -199,36 +201,34 @@
my $upload = $req->upload('file');
$upload->link("/home/user/myfile");</pre>
-<p>For more details on <code>link</code>, see <a href="/Apache2/Upload.html">the Apache2::Upload manpage</a>.</p>
+<p>For more details on <code>link</code>, see <a href="group__apreq__xs__upload.html">the Apache2::Upload manpage</a>.</p>
-<p></p>
+</li>
<li>
<strong>
<a name="item_hook_data"><code>HOOK_DATA</code></a>
-</strong><br />
+</strong>
-</li>
-Extra configuration info passed as the fourth argument
-to an upload hook. See the description for the next item,
-<a href="#item_upload_hook"><code>UPLOAD_HOOK</code></a>.
+<p>Extra configuration info passed as the fourth argument
+to an upload hook. See the description for the next item,
+<a href="#item_upload_hook"><code>UPLOAD_HOOK</code></a>.</p>
-<p></p>
+</li>
<li>
<strong>
<a name="item_upload_hook"><code>UPLOAD_HOOK</code></a>
-</strong><br />
+</strong>
-</li>
-Sets up a callback to run whenever file upload data is read. This
+<p>Sets up a callback to run whenever file upload data is read. This
can be used to provide an upload progress meter during file uploads.
Apache will automatically continue writing the original data to
-$upload->fh after the hook exits.
+$upload->fh after the hook exits.</p>
<pre>
my $transparent_hook = sub {
@@ -237,12 +237,13 @@
};</pre>
<pre>
- my $req = Apache2::Request->new($r,
+ my $req = Apache2::Request->new($r,
HOOK_DATA => "Note",
UPLOAD_HOOK => $transparent_hook,
);</pre>
-<p></p>
+</li>
+
</ul>
@@ -258,7 +259,7 @@
<p>The default (and only) behavior of <em>Apache2::Request</em> is to intelligently
cache <strong>POST</strong> data for the duration of the request. Thus there is no longer
the need for a separate <a href="#item_instance"><code>instance()</code></a> method as existed in <em>Apache2::Request</em>
-for Apache 1.3 - all <strong>POST</strong> data is always available from each and every
+for Apache 1.3 - all <strong>POST</strong> data is always available from each and every
<em>Apache2::Request</em> object created during the request's lifetime.</p>
<p>However an <a href="#item_instance"><code>instance()</code></a> method is aliased to <code>new()</code> in this release
@@ -289,15 +290,15 @@
# the following differ slightly from CGI.pm</pre>
<pre>
- # returns ref to APR::Request::Param::Table object representing
+ # returns ref to APR::Request::Param::Table object representing
# all (args + body) params
my $table = $req->param;
@table_keys = keys %$table;</pre>
-<p>In list context, or when invoked with no arguments as
-<code>$req->param()</code>, <code>param</code> induces libapreq2 to read
+<p>In list context, or when invoked with no arguments as
+<code>$req->param()</code>, <code>param</code> induces libapreq2 to read
and parse all remaining data in the request body.
-However, <code>scalar $req->param("foo")</code> is lazy: libapreq2
+However, <code>scalar $req->param("foo")</code> is lazy: libapreq2
will only read and parse more data if</p>
<pre>
@@ -308,7 +309,7 @@
blocks of the incoming request body until either</p>
<pre>
- 1) it has found the the "foo" param, or
+ 1) it has found the the "foo" param, or
2) parsing is completed.</pre>
<p>Observe that <code>scalar $req->param("foo")</code> will not raise
@@ -318,7 +319,7 @@
Apache2::Request::Error object into $@ should either parser fail.</p>
<pre>
- $req->args_status(1); # set error state for query-string parser
+ $req->args_status(1); # set error state for query-string parser
ok $req->param_status == 1;</pre>
<pre>
@@ -334,9 +335,9 @@
$req->args_status(0); # reset query-string parser state to "success"</pre>
<p>Note: modifications to the <code>scalar $req->param()</code> table only
-affect the returned table object (the underlying C apr_table_t is
-<em>generated</em> from the parse data by apreq_params()). Modifications
-do not affect the actual request data, and will not be seen by other
+affect the returned table object (the underlying C apr_table_t is
+<em>generated</em> from the parse data by apreq_params()). Modifications
+do not affect the actual request data, and will not be seen by other
libapreq2 applications.</p>
<p>
@@ -348,7 +349,7 @@
<p>The functionality of these functions is assumed by <code>param</code>,
so they are no longer necessary. Aliases to <code>param</code> are
provided in this release for backwards compatibility,
-however they are deprecated and may be removed from a future
+however they are deprecated and may be removed from a future
release.</p>
<p>
@@ -376,7 +377,7 @@
<p>More generally, <code>body()</code> follows the same pattern as <code>param()</code>
with respect to its return values and argument list. The main difference
is that modifications to the <code>scalar $req->body()</code> table affect
-the underlying apr_table_t attribute in apreq_request_t, so their impact
+the underlying apr_table_t attribute in apreq_request_t, so their impact
will be noticed by all libapreq2 applications during this request.</p>
<p>
@@ -390,7 +391,7 @@
$req->upload($name)</pre>
<p>Requires <code>Apache2::Upload</code>. With no arguments, this method
-returns an <em>APR::Request::Param::Table</em> object in scalar context,
+returns an <em>APR::Request::Param::Table</em> object in scalar context,
or the names of all <em>Apache2::Upload</em> objects in list context.</p>
<p>An optional name parameter can be passed to return the <em>Apache2::Upload</em>
@@ -401,12 +402,12 @@
<p>More generally, <code>upload()</code> follows the same pattern as <code>param()</code>
with respect to its return values and argument list. The main difference
-is that its returned values are Apache2::Upload object refs, not
+is that its returned values are Apache2::Upload object refs, not
simple scalars.</p>
<p>Note: modifications to the <code>scalar $req->upload()</code> table only
-affect the returned table object (the underlying C apr_table_t is
-<em>generated</em> by apreq_uploads()). They do not affect the actual request
+affect the returned table object (the underlying C apr_table_t is
+<em>generated</em> by apreq_uploads()). They do not affect the actual request
data, and will not be seen by other libapreq2 applications.</p>
<p>
@@ -451,7 +452,7 @@
<pre>
$req->args_status || $req->body_status</pre>
-<p>In list context <code>param_status</code> returns the list
+<p>In list context <code>param_status</code> returns the list
<code>(args_status, body_status)</code>.</p>
<p>
@@ -486,8 +487,8 @@
}</pre>
<p>Calling <code>$r->discard_request_body</code> outside the content handler
-is generally a mistake, so use <code>$req->parse</code> there, but
-<strong>only as a last resort</strong>. The Apache2::Request API is <strong>designed</strong>
+is generally a mistake, so use <code>$req->parse</code> there, but
+<strong>only as a last resort</strong>. The Apache2::Request API is <strong>designed</strong>
around a lazy-parsing scheme, so calling <code>parse</code> should not
affect the behavior of any other methods.</p>
@@ -520,8 +521,8 @@
<h1><a name="porting_from_1_x">PORTING from 1.X</a></h1>
-<p>This is the complete list of changes to existing methods
-from Apache2::Request 1.X. These issues need to be
+<p>This is the complete list of changes to existing methods
+from Apache2::Request 1.X. These issues need to be
addressed when porting 1.X apps to the new 2.X API.</p>
<ul>
@@ -530,11 +531,10 @@
<strong>
<a name="item_apache2_3a_3aupload_is_now_a_separate_module_2e_ap">Apache2::Upload is now a separate module. Applications
requiring the upload API must <code>use Apache2::Upload</code> in 2.X.
- This is easily addressed by preloading the modules during
+ This is easily addressed by preloading the modules during
server startup.</a>
-</strong><br />
+</strong>
-</li>
<li>
@@ -543,27 +543,24 @@
<code>scalar $req->param</code>, <code>scalar $req->args</code> or
<code>scalar $req->body</code> tables. Nor can you add (or set or delete)
cookies in the <code>scalar $req->jar</code> table.</a>
-</strong><br />
+</strong>
-</li>
<li>
<strong>
-<a name="item_instance"><code>instance()</code> is now identical to <code>new()</code>, and is now deprecated. It
+<a name="item_instance"><code>instance()</code> is now identical to <code>new()</code>, and is now deprecated. It
may be removed from a future 2.X release.</a>
-</strong><br />
+</strong>
-</li>
<li>
<strong>
<a name="item_parms"><code>param</code> includes the functionality of <code>parms()</code> and <code>params()</code>, so
they are now deprecated and may be removed from a future 2.X release.</a>
-</strong><br />
+</strong>
-</li>
</ul>
@@ -576,8 +573,8 @@
<h1><a name="see_also">SEE ALSO</a></h1>
-<p><a href="/APR/Request/Param.html">the APR::Request::Param manpage</a>, <a href="/APR/Request/Error.html">the APR::Request::Error manpage</a>, <a href="/Apache2/Upload.html">the Apache2::Upload manpage</a>,
-<a href="/Apache2/Cookie.html">the Apache2::Cookie manpage</a>, APR::Table(3).</p>
+<p><a href="group__apreq__xs__apr__request__param.html">the APR::Request::Param manpage</a>, <a href="group__apreq__xs__apr__request__error.html">the APR::Request::Error manpage</a>, <a href="group__apreq__xs__upload.html">the Apache2::Upload manpage</a>,
+<a href="group__apreq__xs__cookie.html">the Apache2::Cookie manpage</a>, APR::Table(3).</p>
<p>
@@ -587,7 +584,7 @@
<h1><a name="copyright">COPYRIGHT</a></h1>
<pre>
- Copyright 2003-2005 The Apache Software Foundation</pre>
+ Copyright 2003-2006 The Apache Software Foundation</pre>
<pre>
Licensed under the Apache License, Version 2.0 (the "License");
@@ -605,13 +602,13 @@
limitations under the License.</pre>
-<div id="footer">
+ <div id="footer">
<p class="apache">
-Copyright © 2003-2005 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
+Copyright © 2003-2006 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
See <a href="apreq_license.html">LICENSE</a>.</p>
<p class="menu">
<span style="color:#aaa">page generated by <a href="http://www.doxygen.org/"><code>doxygen</code></a>
-version 1.4.3-20050530 on 19 Jul 2005</span>
+version 1.4.6 on 8 Aug 2006</span>
</p>
</div>
</body>
Modified: httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__upload.html
URL: http://svn.apache.org/viewvc/httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__upload.html?rev=430022&r1=430021&r2=430022&view=diff
==============================================================================
--- httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__upload.html (original)
+++ httpd/site/trunk/docs/apreq/docs/libapreq2/group__apreq__xs__upload.html Wed Aug 9 03:20:06 2006
@@ -1,7 +1,7 @@
<html>
<head>
<link rel="stylesheet" type="text/css" href="dox.css" />
- <title>libapreq2-2.06-dev: libapreq2: Apache2::Upload</title>
+ <title>libapreq2-2.08: libapreq2: Apache2::Upload</title>
</head>
<body>
<div id="page-header">
@@ -10,8 +10,16 @@
<a href="http://httpd.apache.org/apreq/">Request Library Subproject</a></p>
<p class="apache">Apache HTTP Server Request Library</p>
<img alt="" src="feather.gif" /></div>
-<!-- Generated by Doxygen 1.4.3-20050530 -->
-<div class="qindex"><a class="qindex" href="index.html">Main Page</a> | <a class="qindex" href="modules.html">Modules</a> | <a class="qindex" href="annotated.html">Data Structures</a> | <a class="qindex" href="dirs.html">Directories</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="functions.html">Data Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related Pages</a></div>
+<!-- Generated by Doxygen 1.4.6 -->
+<div class="tabs">
+ <ul>
+ <li><a href="index.html"><span>Main Page</span></a></li>
+ <li><a href="modules.html"><span>Modules</span></a></li>
+ <li><a href="annotated.html"><span>Data Structures</span></a></li>
+ <li><a href="files.html"><span>Files</span></a></li>
+ <li><a href="pages.html"><span>Related Pages</span></a></li>
+ <li><a href="examples.html"><span>Examples</span></a></li>
+ </ul></div>
<h1>Apache2::Upload<br>
<small>
[<a class="el" href="group__apreq__xs.html">Perl</a>]</small>
@@ -110,7 +118,7 @@
<h1><a name="description">DESCRIPTION</a></h1>
<p>Apache2::Upload is a new module based on the original package included
-in Apache2::Request 1.X. Users requiring the upload API must now
+in Apache2::Request 1.X. Users requiring the upload API must now
<code>use Apache2::Upload</code>, which adds the <code>upload</code> method to Apache2::Request.
Apache2::Upload is largely backwards-compatible with the original 1.X API.
See the <a href="#porting_from_1_x">PORTING from 1.X</a> section below for a list of known issues.</p>
@@ -144,8 +152,8 @@
<pre>
$upload->filename()</pre>
-<p>The (client-side) filename as submitted in the HTML form. Note:
-some agents will submit the file's full pathname, while others
+<p>The (client-side) filename as submitted in the HTML form. Note:
+some agents will submit the file's full pathname, while others
may submit just the basename.</p>
<p>
@@ -169,22 +177,22 @@
<pre>
$upload->io()</pre>
-<p>Creates a tied IO handle. This method is a more efficient version
-of <code>fh</code>, but with <code>io</code> the handle ref returned is not seekable.
-It is tied to an APR::Request::Brigade object, so you may use the
-brigade API on the tied object if you want to manipulate the IO stream
+<p>Creates a tied IO handle. This method is a more efficient version
+of <code>fh</code>, but with <code>io</code> the handle ref returned is not seekable.
+It is tied to an APR::Request::Brigade object, so you may use the
+brigade API on the tied object if you want to manipulate the IO stream
(beyond simply reading from it).</p>
-<p>The returned reference is actually an object which has <code>read</code> and
-<code>readline</code> methods available. However these methods are just
-syntactic sugar for the underlying <code>READ</code> and <code>READLINE</code> methods from
+<p>The returned reference is actually an object which has <code>read</code> and
+<code>readline</code> methods available. However these methods are just
+syntactic sugar for the underlying <code>READ</code> and <code>READLINE</code> methods from
APR::Request::Brigade.</p>
<pre>
$io = $upload->io;
print while $io->read($_); # equivalent to: tied(*$io)->READ($_)</pre>
-<p>See <a href="#read">READ</a> and <a href="#readline">READLINE</a> below for additional notes
+<p>See <a href="#read">READ</a> and <a href="#readline">READLINE</a> below for additional notes
on their usage.</p>
<p>
@@ -220,7 +228,7 @@
$upload->info()
$upload->info($set)</pre>
-<p>Get/set the additional header information table for the
+<p>Get/set the additional header information table for the
uploaded file.
Returns a hash reference tied to the <em>APR::Table</em> class.
An optional <code>$table</code> argument can be passed to reassign
@@ -265,7 +273,7 @@
<pre>
$upload->link()</pre>
-<p>To avoid recopying the upload's internal tempfile brigade on a
+<p>To avoid recopying the upload's internal tempfile brigade on a
*nix-like system, <em>link</em> will create a hard link to it:</p>
<pre>
@@ -273,9 +281,9 @@
$upload->link("/path/to/newfile") or
die sprintf "link from '%s' failed: $!", $upload->tempname;</pre>
-<p>Typically the new name must lie on the same device and partition
+<p>Typically the new name must lie on the same device and partition
as the brigade's tempfile. If this or any other reason prevents
-the OS from linking the files, <code>link()</code> will instead
+the OS from linking the files, <code>link()</code> will instead
copy the temporary file to the specified location.</p>
<p>
@@ -316,9 +324,9 @@
<p>This class is derived from APR::Brigade, providing additional
methods for TIEHANDLE, READ and READLINE. To be memory efficient,
-these methods delete buckets from the brigade as soon as their
+these methods delete buckets from the brigade as soon as their
data is actually read, so you cannot <code>seek</code> on handles tied to
-this class. Such handles have semantics similar to that of a
+this class. Such handles have semantics similar to that of a
read-only socket.</p>
<p>
@@ -353,9 +361,9 @@
$bb->READ($contents, $length, $offset)</pre>
<p>Reads data from the brigade $bb into $contents. When omitted
-$length defaults to <code>-1</code>, which reads the first bucket into $contents.
-A positive $length will read in $length bytes, or the remainder of the
-brigade, whichever is greater. $offset represents the index in $context
+$length defaults to <code>-1</code>, which reads the first bucket into $contents.
+A positive $length will read in $length bytes, or the remainder of the
+brigade, whichever is greater. $offset represents the index in $context
to read the new data.</p>
<p>
@@ -381,27 +389,24 @@
<li>
<strong>
-<a name="item_next"><code>$upload->next()</code> is no longer available; please use the
+<a name="item_next"><code>$upload->next()</code> is no longer available; please use the
<code>APR::Request::Param::Table</code> API when iterating over upload entries.</a>
-</strong><br />
+</strong>
-</li>
<li>
<strong>
<a name="item_info"><code>info($header_name)</code> is replaced by <code>info($set)</code>.</a>
-</strong><br />
+</strong>
-</li>
<li>
<strong>
<a name="item_type"><code>type()</code> returns only the MIME-type portion of the Content-Type header.</a>
-</strong><br />
+</strong>
-</li>
</ul>
@@ -414,7 +419,7 @@
<h1><a name="see_also">SEE ALSO</a></h1>
-<p><a href="/APR/Request/Param/Table.html">the APR::Request::Param::Table manpage</a>, <a href="/APR/Request/Error.html">the APR::Request::Error manpage</a>, <a href="/Apache2/Request.html">the Apache2::Request manpage</a>,
+<p><a href="group__apreq__xs__apr__request.html">the APR::Request::Param::Table manpage</a>, <a href="group__apreq__xs__apr__request__error.html">the APR::Request::Error manpage</a>, <a href="group__apreq__xs__request.html">the Apache2::Request manpage</a>,
APR::Table(3)</p>
<p>
@@ -425,7 +430,7 @@
<h1><a name="copyright">COPYRIGHT</a></h1>
<pre>
- Copyright 2003-2005 The Apache Software Foundation</pre>
+ Copyright 2003-2006 The Apache Software Foundation</pre>
<pre>
Licensed under the Apache License, Version 2.0 (the "License");
@@ -443,13 +448,13 @@
limitations under the License.</pre>
-<div id="footer">
+ <div id="footer">
<p class="apache">
-Copyright © 2003-2005 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
+Copyright © 2003-2006 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
See <a href="apreq_license.html">LICENSE</a>.</p>
<p class="menu">
<span style="color:#aaa">page generated by <a href="http://www.doxygen.org/"><code>doxygen</code></a>
-version 1.4.3-20050530 on 19 Jul 2005</span>
+version 1.4.6 on 8 Aug 2006</span>
</p>
</div>
</body>