You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@httpd.apache.org by jo...@apache.org on 2005/07/20 18:09:24 UTC
svn commit: r219933 [13/18] - in /httpd/site/trunk:
docs/apreq/docs/libapreq2/ xdocs/apreq/docs/libapreq2/
Modified: httpd/site/trunk/xdocs/apreq/docs/libapreq2/apreq__module_8h.html
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/xdocs/apreq/docs/libapreq2/apreq__module_8h.html?rev=219933&r1=219932&r2=219933&view=diff
==============================================================================
--- httpd/site/trunk/xdocs/apreq/docs/libapreq2/apreq__module_8h.html (original)
+++ httpd/site/trunk/xdocs/apreq/docs/libapreq2/apreq__module_8h.html Wed Jul 20 09:09:19 2005
@@ -1,7 +1,7 @@
<html>
<head>
<link rel="stylesheet" type="text/css" href="dox.css" />
- <title>libapreq2-2.05-dev: libapreq2: include/apreq_module.h File Reference</title>
+ <title>libapreq2-2.06-dev: libapreq2: include/apreq_module.h File Reference</title>
</head>
<body>
<div id="page-header">
@@ -10,19 +10,25 @@
<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.2 -->
+<!-- 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>
<div class="nav">
<a class="el" href="dir_000000.html">include</a></div>
<h1>apreq_module.h File Reference</h1>Module API. <a href="#_details">More...</a>
<p>
-<code>#include "<a class="el" href="apreq__cookie_8h-source.html">apreq_cookie.h</a>"</code><br>
-<code>#include "<a class="el" href="apreq__parser_8h-source.html">apreq_parser.h</a>"</code><br>
-<code>#include "<a class="el" href="apreq__error_8h-source.html">apreq_error.h</a>"</code><br>
+<code>#include "<a class="el" href="apreq__cookie_8h-source.html">apreq_cookie.h</a>"</code><br>
+<code>#include "<a class="el" href="apreq__parser_8h-source.html">apreq_parser.h</a>"</code><br>
+<code>#include "<a class="el" href="apreq__error_8h-source.html">apreq_error.h</a>"</code><br>
<p>
<a href="apreq__module_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
+<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structapreq__module__t.html">apreq_module_t</a></td></tr>
+
+<tr><td class="mdescLeft"> </td><td class="mdescRight">Vtable describing the necessary environment functions. <a href="structapreq__module__t.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a0">APREQ_MODULE</a>(pre, mmn)</td></tr>
@@ -31,7 +37,7 @@
<tr><td colspan="2"><br><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">typedef <a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a2">apreq_handle_t</a></td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3" doxytag="apreq_module.h::apreq_module_t"></a>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a3"></a><!-- doxytag: member="apreq_module.h::apreq_module_t" ref="a3" args="" -->
typedef <a class="el" href="structapreq__module__t.html">apreq_module_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a3">apreq_module_t</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Vtable describing the necessary environment functions. <br></td></tr>
@@ -72,26 +78,18 @@
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a21">apreq_handle_custom</a> (<a class="elRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#gga0">apr_pool_t</a> *pool, const char *query_string, const char *cookie, <a class="el" href="structapreq__parser__t.html">apreq_parser_t</a> *parser, <a class="elRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#gga6">apr_uint64_t</a> read_limit, <a class="elRef" doxygen="apu.tag:http://apr.apache.org/docs/apr-util/" href="http://apr.apache.org/docs/apr-util/structapr__bucket__brigade.html">apr_bucket_brigade</a> *in)</td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__errno.html#gga0">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a22">apreq_cookie_bake</a> (const <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c, <a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req)</td></tr>
-
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__errno.html#gga0">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a23">apreq_cookie_bake2</a> (const <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *c, <a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req)</td></tr>
-
-<tr><td class="memItemLeft" nowrap align="right" valign="top">unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a24">apreq_ua_cookie_version</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req)</td></tr>
-
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structapreq__param__t.html">apreq_param_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a25">apreq_param</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, const char *key)</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structapreq__param__t.html">apreq_param_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a22">apreq_param</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, const char *key)</td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__tables.html#gga0">apr_table_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a26">apreq_params</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, <a class="elRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#gga0">apr_pool_t</a> *p)</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__tables.html#gga0">apr_table_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a23">apreq_params</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, <a class="elRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#gga0">apr_pool_t</a> *p)</td></tr>
-<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__tables.html#gga0">apr_table_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a27">apreq_cookies</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, <a class="elRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#gga0">apr_pool_t</a> *p)</td></tr>
-
-<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="elRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga11">APR_INLINE</a> <a class="elRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__errno.html#gga0">apr_status_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a28">apreq_parse</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req)</td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__tables.html#gga0">apr_table_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a24">apreq_cookies</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, <a class="elRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#gga0">apr_pool_t</a> *p)</td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Module API.
<p>
<hr><h2>Define Documentation</h2>
-<a class="anchor" name="a1" doxytag="apreq_module.h::apreq_cookie"></a><p>
+<a class="anchor" name="a1"></a><!-- doxytag: member="apreq_module.h::apreq_cookie" ref="a1" args="(req, name)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -123,14 +121,14 @@
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>req</em> </td><td>request handle. </td></tr>
- <tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>desired cookie name</td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>desired cookie name</td></tr>
</table>
</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>The first matching parameter (with args searched first) or NULL. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>The first matching parameter (with args searched first) or NULL.</dd></dl>
</td>
</tr>
</table>
-<a class="anchor" name="a0" doxytag="apreq_module.h::APREQ_MODULE"></a><p>
+<a class="anchor" name="a0"></a><!-- doxytag: member="apreq_module.h::APREQ_MODULE" ref="a0" args="(pre, mmn)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -171,14 +169,14 @@
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pre</em> </td><td>Prefix to define new environment. All attributes of the apreq_env_module_t struct are defined with this as their prefix. The generated struct is named by appending "_module" to the prefix. </td></tr>
- <tr><td valign="top"></td><td valign="top"><em>mmn</em> </td><td>Magic number (i.e. version number) of this environment. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>mmn</em> </td><td>Magic number (i.e. version number) of this environment.</td></tr>
</table>
</dl>
</td>
</tr>
</table>
<hr><h2>Typedef Documentation</h2>
-<a class="anchor" name="a2" doxytag="apreq_module.h::apreq_handle_t"></a><p>
+<a class="anchor" name="a2"></a><!-- doxytag: member="apreq_module.h::apreq_handle_t" ref="a2" args="" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -198,11 +196,11 @@
<td>
<p>
-An apreq handle associated with a module. The structure may have variable size, because the module may append its own data structures after it. </td>
+An apreq handle associated with a module. The structure may have variable size, because the module may append its own data structures after it. </td>
</tr>
</table>
<hr><h2>Function Documentation</h2>
-<a class="anchor" name="a6" doxytag="apreq_module.h::apreq_args"></a><p>
+<a class="anchor" name="a6"></a><!-- doxytag: member="apreq_module.h::apreq_args" ref="a6" args="(apreq_handle_t *req, const apr_table_t **t)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -243,11 +241,11 @@
<tr><td valign="top"></td><td valign="top"><em>t</em> </td><td>The resulting table, which will either be NULL or a valid table object on return.</td></tr>
</table>
</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or a module-specific error status code. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or a module-specific error status code.</dd></dl>
</td>
</tr>
</table>
-<a class="anchor" name="a9" doxytag="apreq_module.h::apreq_args_get"></a><p>
+<a class="anchor" name="a9"></a><!-- doxytag: member="apreq_module.h::apreq_args_get" ref="a9" args="(apreq_handle_t *req, const char *name)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -288,11 +286,11 @@
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Case-insensitive param name.</td></tr>
</table>
</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>First matching param, or NULL if none match. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>First matching param, or NULL if none match.</dd></dl>
</td>
</tr>
</table>
-<a class="anchor" name="a7" doxytag="apreq_module.h::apreq_body"></a><p>
+<a class="anchor" name="a7"></a><!-- doxytag: member="apreq_module.h::apreq_body" ref="a7" args="(apreq_handle_t *req, const apr_table_t **t)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -333,11 +331,11 @@
<tr><td valign="top"></td><td valign="top"><em>t</em> </td><td>The resulting table, which will either be NULL or a valid table object on return.</td></tr>
</table>
</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or a module-specific error status code. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or a module-specific error status code.</dd></dl>
</td>
</tr>
</table>
-<a class="anchor" name="a10" doxytag="apreq_module.h::apreq_body_get"></a><p>
+<a class="anchor" name="a10"></a><!-- doxytag: member="apreq_module.h::apreq_body_get" ref="a10" args="(apreq_handle_t *req, const char *name)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -378,11 +376,11 @@
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Case-insensitive cookie name.</td></tr>
</table>
</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>First matching param, or NULL if none match. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>First matching param, or NULL if none match.</dd></dl>
</td>
</tr>
</table>
-<a class="anchor" name="a15" doxytag="apreq_module.h::apreq_brigade_limit_get"></a><p>
+<a class="anchor" name="a15"></a><!-- doxytag: member="apreq_module.h::apreq_brigade_limit_get" ref="a15" args="(apreq_handle_t *req, apr_size_t *bytes)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -423,11 +421,11 @@
<tr><td valign="top"></td><td valign="top"><em>bytes</em> </td><td>Pointer to resulting (current) limit.</td></tr>
</table>
</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or a module-specific error, which may leave bytes undefined. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or a module-specific error, which may leave bytes undefined.</dd></dl>
</td>
</tr>
</table>
-<a class="anchor" name="a14" doxytag="apreq_module.h::apreq_brigade_limit_set"></a><p>
+<a class="anchor" name="a14"></a><!-- doxytag: member="apreq_module.h::apreq_brigade_limit_set" ref="a14" args="(apreq_handle_t *req, apr_size_t bytes)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -468,101 +466,11 @@
<tr><td valign="top"></td><td valign="top"><em>bytes</em> </td><td>New limit to use.</td></tr>
</table>
</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or module-specific error. </dd></dl>
- </td>
- </tr>
-</table>
-<a class="anchor" name="a22" doxytag="apreq_module.h::apreq_cookie_bake"></a><p>
-<table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"><a class="elRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__errno.html#gga0">apr_status_t</a> apreq_cookie_bake </td>
- <td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top">const <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> * </td>
- <td class="mdname" nowrap> <em>c</em>, </td>
- </tr>
- <tr>
- <td class="md" nowrap align="right"></td>
- <td class="md"></td>
- <td class="md" nowrap><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> * </td>
- <td class="mdname" nowrap> <em>req</em></td>
- </tr>
- <tr>
- <td class="md"></td>
- <td class="md">) </td>
- <td class="md" colspan="2"></td>
- </tr>
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
-
- </td>
- <td>
-
-<p>
-Add the cookie to the outgoing "Set-Cookie" headers.<p>
-<dl compact><dt><b>Parameters:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>The cookie. </td></tr>
- <tr><td valign="top"></td><td valign="top"><em>req</em> </td><td>The request handle which set the outgoing header.</td></tr>
- </table>
-</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or error. </dd></dl>
- </td>
- </tr>
-</table>
-<a class="anchor" name="a23" doxytag="apreq_module.h::apreq_cookie_bake2"></a><p>
-<table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top"><a class="elRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__errno.html#gga0">apr_status_t</a> apreq_cookie_bake2 </td>
- <td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top">const <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> * </td>
- <td class="mdname" nowrap> <em>c</em>, </td>
- </tr>
- <tr>
- <td class="md" nowrap align="right"></td>
- <td class="md"></td>
- <td class="md" nowrap><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> * </td>
- <td class="mdname" nowrap> <em>req</em></td>
- </tr>
- <tr>
- <td class="md"></td>
- <td class="md">) </td>
- <td class="md" colspan="2"></td>
- </tr>
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
-
- </td>
- <td>
-
-<p>
-Add the cookie to the outgoing "Set-Cookie2" headers.<p>
-<dl compact><dt><b>Parameters:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign="top"></td><td valign="top"><em>c</em> </td><td>cookie </td></tr>
- <tr><td valign="top"></td><td valign="top"><em>req</em> </td><td>request handle</td></tr>
- </table>
-</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or error. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or module-specific error.</dd></dl>
</td>
</tr>
</table>
-<a class="anchor" name="a27" doxytag="apreq_module.h::apreq_cookies"></a><p>
+<a class="anchor" name="a24"></a><!-- doxytag: member="apreq_module.h::apreq_cookies" ref="a24" args="(apreq_handle_t *req, apr_pool_t *p)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -600,13 +508,13 @@
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>req</em> </td><td>the apreq request handle </td></tr>
- <tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>Allocates the returned table. </td></tr>
+ <tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>Allocates the returned table.</td></tr>
</table>
</dl>
</td>
</tr>
</table>
-<a class="anchor" name="a20" doxytag="apreq_module.h::apreq_handle_cgi"></a><p>
+<a class="anchor" name="a20"></a><!-- doxytag: member="apreq_module.h::apreq_handle_cgi" ref="a20" args="(apr_pool_t *pool)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -638,11 +546,11 @@
</table>
</dl>
<dl compact><dt><b>Returns:</b></dt><dd>New handle; can only be NULL if the pool allocation failed.</dd></dl>
-<dl compact><dt><b>Remarks:</b></dt><dd>The handle gets cached in the pool's userdata, so subsequent calls will retrieve the original cached handle. </dd></dl>
+<dl compact><dt><b>Remarks:</b></dt><dd>The handle gets cached in the pool's userdata, so subsequent calls will retrieve the original cached handle.</dd></dl>
</td>
</tr>
</table>
-<a class="anchor" name="a21" doxytag="apreq_module.h::apreq_handle_custom"></a><p>
+<a class="anchor" nameFrom cvs-return-22411-apmail-httpd-cvs-archive=httpd.apache.org@httpd.apache.org Wed Jul 20 16:11:49 2005
Return-Path: <cv...@httpd.apache.org>
Delivered-To: apmail-httpd-cvs-archive@www.apache.org
Received: (qmail 12089 invoked from network); 20 Jul 2005 16:11:45 -0000
Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199)
by minotaur.apache.org with SMTP; 20 Jul 2005 16:11:45 -0000
Received: (qmail 45248 invoked by uid 500); 20 Jul 2005 16:10:56 -0000
Delivered-To: apmail-httpd-cvs-archive@httpd.apache.org
Received: (qmail 44225 invoked by uid 500); 20 Jul 2005 16:10:47 -0000
Mailing-List: contact cvs-help@httpd.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@httpd.apache.org
list-help: <ma...@httpd.apache.org>
list-unsubscribe: <ma...@httpd.apache.org>
List-Post: <ma...@httpd.apache.org>
List-Id: <cvs.httpd.apache.org>
Delivered-To: mailing list cvs@httpd.apache.org
Received: (qmail 43783 invok="a21"></a><!-- doxytag: member="apreq_module.h::apreq_handle_custom" ref="a21" args="(apr_pool_t *pool, const char *query_string, const char *cookie, apreq_parser_t *parser, apr_uint64_t read_limit, apr_bucket_brigade *in)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -711,11 +619,11 @@
<tr><td valign="top"></td><td valign="top"><em>in</em> </td><td>brigade containing the request body</td></tr>
</table>
</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>new handle; can only be NULL if the pool allocation failed. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>new handle; can only be NULL if the pool allocation failed.</dd></dl>
</td>
</tr>
</table>
-<a class="anchor" name="a13" doxytag="apreq_module.h::apreq_hook_add"></a><p>
+<a class="anchor" name="a13"></a><!-- doxytag: member="apreq_module.h::apreq_hook_add" ref="a13" args="(apreq_handle_t *req, apreq_hook_t *hook)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -756,11 +664,11 @@
<tr><td valign="top"></td><td valign="top"><em>hook</em> </td><td>Hook to add.</td></tr>
</table>
</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or module-specific error. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or module-specific error.</dd></dl>
</td>
</tr>
</table>
-<a class="anchor" name="a5" doxytag="apreq_module.h::apreq_jar"></a><p>
+<a class="anchor" name="a5"></a><!-- doxytag: member="apreq_module.h::apreq_jar" ref="a5" args="(apreq_handle_t *req, const apr_table_t **t)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -801,11 +709,11 @@
<tr><td valign="top"></td><td valign="top"><em>t</em> </td><td>The resulting table, which will either be NULL or a valid table object on return.</td></tr>
</table>
</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or a module-specific error status code. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or a module-specific error status code.</dd></dl>
</td>
</tr>
</table>
-<a class="anchor" name="a8" doxytag="apreq_module.h::apreq_jar_get"></a><p>
+<a class="anchor" name="a8"></a><!-- doxytag: member="apreq_module.h::apreq_jar_get" ref="a8" args="(apreq_handle_t *req, const char *name)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -846,11 +754,11 @@
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>Case-insensitive cookie name.</td></tr>
</table>
</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>First matching cookie, or NULL if none match. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>First matching cookie, or NULL if none match.</dd></dl>
</td>
</tr>
</table>
-<a class="anchor" name="a4" doxytag="apreq_module.h::apreq_module_status_is_error"></a><p>
+<a class="anchor" name="a4"></a><!-- doxytag: member="apreq_module.h::apreq_module_status_is_error" ref="a4" args="(apr_sed by uid 99); 20 Jul 2005 16:10:42 -0000
X-ASF-Spam-Status: No, hits=-9.8 required=10.0
tests=ALL_TRUSTED,NO_REAL_NAME
X-Spam-Check-By: apache.org
Received: from [209.237.227.194] (HELO minotaur.apache.org) (209.237.227.194)
by apache.org (qpsmtpd/0.29) with SMTP; Wed, 20 Jul 2005 09:09:59 -0700
Received: (qmail 5843 invoked by uid 65534); 20 Jul 2005 16:09:57 -0000
Message-ID: <20...@minotaur.apache.org>
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Subject: svn commit: r219933 [17/18] - in /httpd/site/trunk:
docs/apreq/docs/libapreq2/ xdocs/apreq/docs/libapreq2/
Date: Wed, 20 Jul 2005 16:09:24 -0000
To: cvs@httpd.apache.org
From: joes@apache.org
X-Mailer: svnmailer-1.0.2
X-Virus-Checked: Checked by ClamAV on apache.org
X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N
Modified: httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__lang.html
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__lang.html?rev=219933&r1=219932&r2=219933&view=diff
==============================================================================
--- httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__lang.html (original)
+++ httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__lang.html Wed Jul 20 09:09:19 2005
@@ -1,7 +1,7 @@
<html>
<head>
<link rel="stylesheet" type="text/css" href="dox.css" />
- <title>libapreq2-2.05-dev: libapreq2: Language Bindings</title>
+ <title>libapreq2-2.06-dev: libapreq2: Language Bindings</title>
</head>
<body>
<div id="page-header">
@@ -10,7 +10,7 @@
<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.2 -->
+<!-- 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.htmtatus_t s)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -881,11 +789,11 @@
<tr><td valign="top"></td><td valign="top"><em>s</em> </td><td>status code returned by an <a class="el" href="structapreq__module__t.html">apreq_module_t</a> method.</td></tr>
</table>
</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>1 if s is fatal, 0 otherwise. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>1 if s is fatal, 0 otherwise.</dd></dl>
</td>
</tr>
</table>
-<a class="anchor" name="a25" doxytag="apreq_module.h::apreq_param"></a><p>
+<a class="anchor" name="a22"></a><!-- doxytag: member="apreq_module.h::apreq_param" ref="a22" args="(apreq_handle_t *req, const char *key)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -926,11 +834,11 @@
<tr><td valign="top"></td><td valign="top"><em>key</em> </td><td>desired parameter name</td></tr>
</table>
</dl>
-<dl compact><dt><b>Returns:</b></l">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>
<h1>Language Bindings</h1>libapreq2 APIs for programming languages other than C
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
@@ -25,13 +25,13 @@
<hr><a name="_details"></a><h2>Detailed Description</h2>
libapreq2 APIs for programming languages other than C
<p>
-XXX <div id="footer">
+XXX<div id="footer">
<p class="apache">
Copyright © 2003-2005 <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.2 on 4 May 2005</span>
+version 1.4.3-20050530 on 19 Jul 2005</span>
</p>
</div>
</body>
Modified: httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__module.html
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__module.html?rev=219933&r1=219932&r2=219933&view=diff
==============================================================================
--- httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__module.html (original)
+++ httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__module.html Wed Jul 20 09:09:19 2005
@@ -1,7 +1,7 @@
<html>
<head>
<link rel="stylesheet" type="text/css" href="dox.css" />
- <title>libapreq2-2.05-dev: libapreq2: Modules</title>
+ <title>libapreq2-2.06-dev: libapreq2: Modules</title>
</head>
<body>
<div id="page-header">
@@ -10,9 +10,9 @@
<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.2 -->
+<!-- Generdt><dd>The first matching parameter (with args searched first) or NULL. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>The first matching parameter (with args searched first) or NULL.</dd></dl>
</td>
</tr>
</table>
-<a class="anchor" name="a26" doxytag="apreq_module.h::apreq_params"></a><p>
+<a class="anchor" name="a23"></a><!-- doxytag: member="apreq_module.h::apreq_params" ref="a23" args="(apreq_handle_t *req, apr_pool_t *p)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -971,46 +879,11 @@
<tr><td valign="top"></td><td valign="top"><em>p</em> </td><td>allocates the returned table.</td></tr>
</table>
</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>table representing all available params; is never NULL. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>table representing all available params; is never NULL.</dd></dl>
</td>
</tr>
</table>
-<a class="anchor" name="a28" doxytag="apreq_module.h::apreq_parse"></a><p>
-<table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top">static <a class="elRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga11">APR_INLINE</a> <a class="elRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__errno.html#gga0">apr_status_t</a> apreq_parse </td>
- <td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> * </td>
- <td class="mdname1" valign="top" nowrap> <em>req</em> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap><code> [static]</code></td>
- </tr>
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing="5" cellpadding="0" border="0ated 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>
-<h1>Modules</h1>apreq2 modules included in libapreq2-2.05-dev.
+<h1>Modules</h1>apreq2 modules included in libapreq2-2.06-dev.
<a href="#_details">More...</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Modules</h2></td></tr>
@@ -23,15 +23,15 @@
<p>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
-apreq2 modules included in libapreq2-2.05-dev.
+apreq2 modules included in libapreq2-2.06-dev.
<p>
-XXX <div id="footer">
+XXX<div id="footer">
<p class="apache">
Copyright © 2003-2005 <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.2 on 4 May 2005</span>
+version 1.4.3-20050530 on 19 Jul 2005</span>
</p>
</div>
</body>
Modified: httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs.html
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs.html?rev=219933&r1=219932&r2=219933&view=diff
==============================================================================
--- httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs.html (original)
+++ httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs.html Wed Jul 20 09:09:19 2005
@@ -1,7 +1,7 @@
<html>
<head>
<link rel="stylesheet" type="text/css" href="dox.css" />
- <title>libapreq2-2.05-dev: libapreq2: Perl</title>
+ <title>libapreq2-2.06-dev: libapreq2: Perl</title>
</head>
<body>
<div id="page-header">
@@ -10,7 +10,7 @@
<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.2 -->
+<!-- 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>
<h1>Perl<br>
<small>
@@ -25,17 +25,29 @@
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apreq__xs__cookie.html">Apache2::Cookie</a></td></tr>
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apreq__xs__apr__request.html">APR::Request</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apreq__xs__apr__request__cookie.html">APR::Request::Cookie</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apreq__xs__apr__request__param.html">APR::Request::Param</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apreq__xs__apr__request__error.html">APR::Request::Error</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apreq__xs__apr__request__cgi.html">APR::Request::CGI</a></td></tr>
+
+<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__apreq__xs__apr__request__apache2.html">APR::Request::Apache2</a></td></tr>
+
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
XS Modules.
<p>
- <div id="footer">
+<div id="footer">
<p class="apache">
Copyright © 2003-2005 <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.2 on 4 May 2005</span>
+version 1.4.3-20050530 on 19 Jul 2005</span>
</p>
</div>
</body>
Added: httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request.html
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request.html?rev=219933&view=auto
==============================================================================
--- httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request.html (added)
+++ httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request.html Wed Jul 20 09:09:19 2005
@@ -0,0 +1,488 @@
+<html>
+<head>
+ <link rel="stylesheet" type="text/css" href="dox.css" />
+ <title>libapreq2-2.06-dev: libapreq2: APR::Request</title>
+</head>
+<body>
+<div id="page-header">
+<p class="menu">
+ <a href="http://www.apache.org/">Apache Software Foundation</a> > <a href="http://httpd.apache.org">HTTP Server Project</a> >
+<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>
+<h1>APR::Request<br>
+<small>
+[<a class="el" href="group__apreq__xs.html">Perl</a>]</small>
+</h1><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+</table>
+
+
+
+<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="#methods">METHODS</a></li>
+ <ul>
+
+ <li><a href="#handle">handle</a></li>
+ </ul>
+
+ <li><a href="#methods">METHODS</a></li>
+ <ul>
+
+ <li><a href="#pool">pool</a></li>
+ <li><a href="#bucket_alloc">bucket_alloc</a></li>
+ <li><a href="#jar_status">jar_status</a></li>
+ <li><a href="#args_status">args_status</a></li>
+ <li><a href="#body_status">body_status</a></li>
+ <li><a href="#param_status">param_status</a></li>
+ <li><a href="#parse">parse</a></li>
+ <li><a href="#jar">jar</a></li>
+ <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="#read_limit">read_limit</a></li>
+ <li><a href="#brigade_limit">brigade_limit</a></li>
+ <li><a href="#temp_dir">temp_dir</a></li>
+ <li><a href="#disable_uploads">disable_uploads</a></li>
+ <li><a href="#upload_hook">upload_hook</a></li>
+ <li><a href="#import">import</a></li>
+ </ul>
+
+ <li><a href="#subroutines">SUBROUTINES</a></li>
+ <ul>
+
+ <li><a href="#encode">encode</a></li>
+ <li><a href="#decode">decode</a></li>
+ </ul>
+
+ <li><a href="#subclassing">SUBCLASSING</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>APR::Request - wrapper for libapreq2's module/handle API.</p>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+
+<pre>
+ use APR::Request;</pre>
+
+<pre>
+ $req = APR::Request::Custom->handle($pool,
+ "foo=arg1&bar=arg2",
+ "cookie=apache",
+ $parser, 1e6, $bb);
+ $param = $req->param("foo");
+ $cookie = $req->jar("cookie");</pre>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="description">DESCRIPTION</a></h1>
+
+<p>The <code>APR::Request</code> module provides the base methods
+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>
+
+</p>
+<hr />
+
+<h1><a name="methods">METHODS</a></h1>
+
+<p>APR::Request::Custom - derived from APR::Request.</p>
+
+<p>
+
+</p>
+
+<h2><a name="handle">handle</a></h2>
+
+<pre>
+ APR::Request::Custom->handle($pool,
+ $query_string,
+ $cookie_header,
+ $parser,
+ $read_limit,
+ $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
+<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
+may feed into the parser.</p>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="methods">METHODS</a></h1>
+
+<p>APR::Request</p>
+
+<p>
+
+</p>
+
+<h2><a name="pool">pool</a></h2>
+
+<pre>
+ $req->pool()</pre>
+
+<p>Returns the APR::Pool object associated to this handle.</p>
+
+<p>
+
+</p>
+
+<h2><a name="bucket_alloc">bucket_alloc</a></h2>
+
+<pre>
+ $req->bucket_alloc()</pre>
+
+<p>Returns the APR::BucketAlloc object associated to this handle.</p>
+
+<p>
+
+</p>
+
+<h2><a name="jar_status">jar_status</a></h2>
+
+<pre>
+ $req->jar_status()</pre>
+
+<p>Returns the final status code of the handle's cookie header parser.</p>
+
+<p>
+
+</p>
+
+<h2><a name="args_status">args_status</a></h2>
+
+<pre>
+ $req->args_status()</pre>
+
+<p>Returns the final status code of the handle's query-string parser.</p>
+
+<p>
+
+</p>
+
+<h2><a name="body_status">body_status</a></h2>
+
+<pre>
+ $req->body_status()</pre>
+
+<p>Returns the final status code of the handle's body parser.</p>
+
+<p>
+
+</p>
+
+<h2><a name="param_status">param_status</a></h2>
+
+<pre>
+ $req->param_status()</pre>
+
+<p>Returns <code>($req->args_status, $req->body_status)</code> in list
+context; otherwise returns <code>$req->args_status || $req->body_status</code>.</p>
+
+<p>
+
+</p>
+
+<h2><a name="parse">parse</a></h2>
+
+<pre>
+ $req->parse()</pre>
+
+<p>Parses the jar, args, and body tables. Returns
+<code>$req->jar_status, $req->args_status, $req->body_status</code>.</p>
+
+<p>
+
+</p>
+
+<h2><a name="jar">jar</a></h2>
+
+<pre>
+ $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 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>
+
+</p>
+
+<h2><a name="args">args</a></h2>
+
+<pre>
+ $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 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>
+
+</p>
+
+<h2><a name="body">body</a></h2>
+
+<pre>
+ $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 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>
+
+</p>
+
+<h2><a name="param">param</a></h2>
+
+<pre>
+ $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 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>
+
+</p>
+
+<h2><a name="uploads__apr__request__param__table_">uploads (APR::Request::Param::Table???)</a></h2>
+
+<pre>
+ $req->uploads()
+ $req->uploads($key)</pre>
+
+<p>
+
+</p>
+
+<h2><a name="read_limit">read_limit</a></h2>
+
+<pre>
+ $req->read_limit()
+ $req->read_limit($set)</pre>
+
+<p>
+
+</p>
+
+<h2><a name="brigade_limit">brigade_limit</a></h2>
+
+<pre>
+ $req->brigade_limit()
+ $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
+spool into main memory. Uploads exceeding this limit are written
+directly to disk.</p>
+
+<p>
+
+</p>
+
+<h2><a name="temp_dir">temp_dir</a></h2>
+
+<pre>
+ $req->temp_dir()
+ $req->temp_dir($set)</pre>
+
+<p>Get/set the spool directory for uploads which exceed the configured
+brigade_limit.</p>
+
+<p>
+
+</p>
+
+<h2><a name="disable_uploads">disable_uploads</a></h2>
+
+<pre>
+ $req->disable_uploads()</pre>
+
+<p>Engage the disable_uploads hook for this request.</p>
+
+<p>
+
+</p>
+
+<h2><a name="upload_hook">upload_hook</a></h2>
+
+<pre>
+ $req->upload_hook($callback)</pre>
+
+<p>Add an upload hook callback for this request. The
+arguments to the $callback sub are ($upload, $new_data).</p>
+
+<p>
+
+</p>
+
+<h2><a name="import">import</a></h2>
+
+<p>Exports a list of subs into the caller's package.</p>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="subroutines">SUBROUTINES</a></h1>
+
+<p>APR::Request</p>
+
+<p>
+
+</p>
+
+<h2><a name="encode">encode</a></h2>
+
+<pre>
+ encode($string)</pre>
+
+<p>Exportable sub which returns the url-encoded form of <code>$string</code>.</p>
+
+<p>
+
+</p>
+
+<h2><a name="decode">decode</a></h2>
+
+<pre>
+ decode($string)</pre>
+
+<p>Exportable sub which returns the url-decoded form of <code>$string</code>.</p>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="subclassing">SUBCLASSING</a></h1>
+
+<p>APR::Request</p>
+
+<p>If the instances of your subclass are hash references then you can actually
+inherit from APR::Request as long as the APR::Request object is stored in
+an attribute called ``r'' or ``_r''. (The APR::Request class effectively does the
+delegation for you automagically, as long as it knows where to find the
+APR::Request object to delegate to.) For example:</p>
+
+<pre>
+ package MySubClass;
+ use APR::Request::Custom;
+ our @ISA = qw(APR::Request);
+ sub new {
+ my($class, @args) = @_;
+ return bless { r => APR::Request::Custom->handle(@args) }, $class;
+ }</pre>
+
+<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>
+
+</p>
+<hr />
+
+<h1><a name="copyright">COPYRIGHT</a></h1>
+
+<pre>
+ Copyright 2003-2005 The Apache Software Foundation</pre>
+
+<pre>
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at</pre>
+
+<pre>
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></pre>
+
+<pre>
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.</pre>
+
+
+<div id="footer">
+<p class="apache">
+Copyright © 2003-2005 <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>
+</p>
+</div>
+</body>
+</html>
Propchange: httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__apache2.html
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__apache2.html?rev=219933&view=auto
==============================================================================
--- httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__apache2.html (added)
+++ httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__apache2.html Wed Jul 20 09:09:19 2005
@@ -0,0 +1,146 @@
+<html>
+<head>
+ <link rel="stylesheet" type="text/css" href="dox.css" />
+ <title>libapreq2-2.06-dev: libapreq2: APR::Request::Apache2</title>
+</head>
+<body>
+<div id="page-header">
+<p class="menu">
+ <a href="http://www.apache.org/">Apache Software Foundation</a> > <a href="http://httpd.apache.org">HTTP Server Project</a> >
+<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>
+<h1>APR::Request::Apache2<br>
+<small>
+[<a class="el" href="group__apreq__xs.html">Perl</a>]</small>
+</h1><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+</table>
+
+
+
+<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="#methods">METHODS</a></li>
+ <ul>
+
+ <li><a href="#handle">handle</a></li>
+ </ul>
+
+ <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>APR::Request::Apache2 - wrapper for a mod_apreq2 handle.</p>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+
+<pre>
+ use APR::Request::Apache2;
+ my $req = APR::Request::Apache2->handle($r);</pre>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="description">DESCRIPTION</a></h1>
+
+<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>
+
+</p>
+<hr />
+
+<h1><a name="methods">METHODS</a></h1>
+
+<p>APR::Request::Apache2 - derived from <code>APR::Request</code>.</p>
+
+<p>
+
+</p>
+
+<h2><a name="handle">handle</a></h2>
+
+<pre>
+ APR::Request::Apache2->handle($r)</pre>
+
+<p>Creates an APR::Request::Apache2 object. The argument <code>$r</code>
+is an Apache2::RequestRec object (from mod_perl2).</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="/Apache2/RequestRec.html">the Apache2::RequestRec manpage</a>.</p>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="copyright">COPYRIGHT</a></h1>
+
+<pre>
+ Copyright 2003-2005 The Apache Software Foundation</pre>
+
+<pre>
+ Licensed under the Apache License, Version 2.0 (the &quo">
- <tr>
- <td>
-
- </td>
- <td>
-
-<p>
-Force a complete parse of everything.<p>
-<dl compact><dt><b>Parameters:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign="top"></td><td valign="top"><em>req</em> </td><td>The request handle</td></tr>
- </table>
-</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS on an error-free parse of the request data. Any other status code indicates a potential problem somewhere. </dd></dl>
- </td>
- </tr>
-</table>
-<a class="anchor" name="a11" doxytag="apreq_module.h::apreq_parser_get"></a><p>
+<a class="anchor" name="a11"></a><!-- doxytag: member="apreq_module.h::apreq_parser_get" ref="a11" args="(apreq_handle_t *req, const apreq_parser_t **parser)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -1051,11 +924,11 @@
<tr><td valign="top"></td><td valign="top"><em>parser</em> </td><td>Points to the active parser on return.</td></tr>
</tablt;License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at</pre>
+
+<pre>
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></pre>
+
+<pre>
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.</pre>
+
+
+<div id="footer">
+<p class="apache">
+Copyright © 2003-2005 <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>
+</p>
+</div>
+</body>
+</html>
Propchange: httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__apache2.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__cgi.html
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__cgi.html?rev=219933&view=auto
==============================================================================
--- httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__cgi.html (added)
+++ httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__cgi.html Wed Jul 20 09:09:19 2005
@@ -0,0 +1,146 @@
+<html>
+<head>
+ <link rel="stylesheet" type="text/css" href="dox.css" />
+ <title>libapreq2-2.06-dev: libapreq2: APR::Request::CGI</title>
+</head>
+<body>
+<div id="page-header">
+<p class="menu">
+ <a href="http://www.apache.org/">Apache Software Foundation</a> > <a href="http://httpd.apae>
</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or module-specific error. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or module-specific error.</dd></dl>
</td>
</tr>
</table>
-<a class="anchor" name="a12" doxytag="apreq_module.h::apreq_parser_set"></a><p>
+<a class="anchor" name="a12"></a><!-- doxytag: member="apreq_module.h::apreq_parser_set" ref="a12" args="(apreq_handle_t *req, apreq_parser_t *parser)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -1096,11 +969,11 @@
<tr><td valign="top"></td><td valign="top"><em>parser</em> </td><td>New parser to use.</td></tr>
</table>
</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or module-specific error. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or module-specific error.</dd></dl>
</td>
</tr>
</table>
-<a class="anchor" name="a17" doxytag="apreq_module.h::apreq_read_limit_get"></a><p>
+<a class="anchor" name="a17"></a><!-- doxytag: member="apreq_module.h::apreq_read_limit_get" ref="a17" args="(apreq_handle_t *req, apr_uint64_t *bytes)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -1141,11 +1014,11 @@
<tr><td valign="top"></td><td valign="top"><em>bytes</em> </td><td>Pointer to resulting (current) limit.</td></tr>
</table>
</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or a module-specific error, which may leave bytes undefined. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or a module-specific error, which may leave bytes undefined.</dd></dl>
</td>
</tr>
</table>
-<a class="anchor" name="a16" doxytag="apreq_module.h::apreq_read_limit_set"></a><p>
+<a class="anchor" name="a16"></a><!-- doxytag: member="apreq_module.h::apreq_read_limit_set" ref="a16" args="(apreq_handle_t *req, apr_uint64_t bytes)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -1186,11 +1059,11 @@
<tr><td valign="top"></td><td valign="top"><em>bytes</em> </td><td>New limit to use.</td></tr>
</table>
</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or a module-specific error. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or a module-specific error.</dd></dl>
</td>
</tr>
</table>
-<a class="anchor" name="a19" doxytag="apreq_module.h::apreq_temp_dir_get"></a><p>
+<a class="anchor" name="a19"></a><!-- doxytag: member="apreq_module.h::apreq_temp_dir_get" ref="a19" args="(apreq_handle_t *req, const char **path)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -1231,11 +1104,11 @@
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>Resulting path to temp dir.</td></tr>
</table>
</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS implies path is valid, but may also be NULL. Any other return value is module-specific, and may leave path undefined. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS implies path is valid, but may also be NULL. Any other return value is module-specific, and may leave path undefined.</dd></dl>
</td>
</tr>
</table>
-<a class="anchor" name="a18" doxytag="apreq_module.h::apreq_temp_dir_set"></a><p>
+<a class="anchor" name="a18"></a><!-- doxytag: member="apreq_module.h::apreq_temp_dir_set" ref="a18" args="(apreq_handle_t *req, const char *path)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
<tr>
<td class="mdRow">
@@ -1276,42 +1149,7 @@
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>New path to use; may be NULL.</td></tr>
</table>
</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or a module-specific error . </dd></dl>
- </td>
- </tr>
-</table>
-<a class="anchor" name="a24" doxytag="apreq_module.h::apreq_ua_cookie_version"></a><p>
-<table class="mdTable" cellpadding="2" cellspacing="0">
- <tr>
- <td class="mdRow">
- <table cellpadding="0" cellspacing="0" border="0">
- <tr>
- <td class="md" nowrap valign="top">unsigned apreq_ua_cookie_version </td>
- <td class="md" valign="top">( </td>
- <td class="md" nowrap valign="top"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> * </td>
- <td class="mdname1" valign="top" nowrap> <em>req</em> </td>
- <td class="md" valign="top"> ) </td>
- <td class="md" nowrap></td>
- </tr>
- </table>
- </td>
- </tr>
-</table>
-<table cellspacing="5" cellpadding="0" border="0">
- <tr>
- <td>
-
- </td>
- <td>
-
-<p>
-Looks for the presence of a "Cookie2" header to determine whether or not the current User-Agent responsible for this request supports rfc2965.<p>
-<dl compact><dt><b>Parameters:</b></dt><dd>
- <table border="0" cellspacing="2" cellpadding="0">
- <tr><td valign="top"></td><td valign="top"><em>req</em> </td><td>the apreq request handle</td></tr>
- </table>
-</dl>
-<dl compact><dt><b>Returns:</b></dt><dd>::APREQ_COOKIE_VERSION_RFC if rfc2965 is supported by the user-agent, ::APREQ_COOKIE_VERSION_NETSCAPE otherwise. </dd></dl>
+<dl compact><dt><b>Returns:</b></dt><dd>APR_SUCCESS or a module-specific error .</dd></dl>
</td>
</tr>
</table>
@@ -1321,7 +1159,7 @@
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.2 on 4 May 2005</span>
+version 1.4.3-20050530 on 19 Jul 2005</span>
</p>
</div>
</body>
Modified: httpd/site/trunk/xdocs/apreq/docs/libapreq2/apreq__module__apache2_8h-source.html
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/xdocs/apreq/docs/libapreq2/apreq__module__apache2_8h-source.html?rev=219933&r1=219932&r2=219933&view=diff
==============================================================================
--- httpd/site/trunk/xdocs/apreq/docs/libapreq2/apreq__module__apache2_8h-source.html (original)
+++ httpd/site/trunk/xdocs/apreq/docs/libapreq2/apreq__module__apache2_8h-source.html Wed Jul 20 09:09:19 2005
@@ -1,7 +1,7 @@
<html>
<head>
<link rel="stylesheet" type="text/css" href="dox.css" />
- <title>libapreq2-2.05-dev: libapreq2: module/apache2/apreq_module_apache2.h Source File</title>
+ <title>libapreq2-2.06-dev: libapreq2: module/apache2/apreq_module_apache2.h Source File</title>
</head>
<body>
<div id="page-header">
@@ -10,51 +10,54 @@
<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.2 -->
+<!-- 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>
<div class="nav">
-<a class="el" href="dir_000001.html">module</a> / <a class="el" href="dir_000003.html">apache2</a></div>
-<h1>apreq_module_apache2.h</h1><div class="fragment"><pre class="fragment">00001 <span class="comment">/*</span>
-00002 <span class="comment">** Copyright 2003-2005 The Apache Software Foundation</span>
-00003 <span class="comment">**</span>
-00004 <span class="comment">** Licensed under the Apache License, Version 2.0 (the "License");</span>
-00005 <span class="comment">** you may not use this file except in compliance with the License.</span>
-00006 <span class="comment">** You may obtain a copy of the License at</span>
-00007 <span class="comment">**</span>
-00008 <span class="comment">** http://www.apache.org/licenses/LICENSE-2.0</span>
-00009 <span class="comment">**</span>
-00010 <span class="comment">** Unless required by applicable law or agreed to in writing, software</span>
-00011 <span class="comment">** distributed under the License is distributed on an "AS IS" BASIS,</span>
-00012 <span class="comment">** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
-00013 <span class="comment">** See the License for the specific language governing permissions and</span>
-00014 <span class="comment">** limitations under the License.</span>
-00015 <span class="comment">*/</span>
-00016
-00017 <span class="preprocessor">#ifndef APREQ_APACHE2_H</span>
-00018 <span class="preprocessor"></span><span class="preprocessor">#define APREQ_APACHE2_H</span>
-00019 <span class="preprocessor"></span>
-00020 <span class="preprocessor">#include "<a class="code" href="apreq__module_8h.html">apreq_module.h</a>"</span>
-00021 <span class="preprocessor">#include <httpd.h></span>
-00022
-00023 <span class="preprocessor">#ifdef __cplusplus</span>
-00024 <span class="preprocessor"></span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
-00025 <span class="preprocessor">#endif</span>
-00026 <span class="preprocessor"></span>
-00027
-00140 APREQ_DECLARE(<a class="code" href="structapreq__handle__t.html">apreq_handle_t</a>*) <a class="code" href="group__mod__apreq2.html#ga0">apreq_handle_apache2</a>(request_rec *r);
-00141
-00144 #ifdef __cplusplus
-00145 }
-00146 #endif
-00147
-00148 #endif
+<a class="el" href="dir_000001.html">module</a> » <a class="el" href="dir_000003.html">apache2</a></div>
+<h1>apreq_module_apache2.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
+<a name="l00002"></a>00002 <span class="comment">** Copyright 2003-2005 The Apache Software Foundation</span>
+<a name="l00003"></a>00003 <span class="comment">**</span>
+<a name="l00004"></a>00004 <span class="comment">** Licensed under the Apache License, Version 2.0 (the "License");</span>
+<a name="l00005"></a>00005 <span class="comment">** you may not use this file except in compliance with the License.</span>
+<a name="l00006"></a>00006 <span class="comment">** You may obtain a copy of the License at</span>
+<a name="l00007"></a>00007 <span class="comment">**</span>
+<a name="l00008"></a>00008 <span class="comment">** http://www.apache.org/licenses/LICENSE-2.0</span>
+<a name="l00009"></a>00009 <span class="comment">**</span>
+<a name="l00010"></a>00010 <span class="comment">** Unless required by applicable law or agreed to in writing, software</span>
+<a name="l00011"></a>00011 <span class="comment">** distributed under the License is distributed on an "AS IS" BASIS,</span>
+<a name="l00012"></a>00012 <span class="comment">** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
+<a name="l00013"></a>00013 <span class="comment">** See the License for the specific language governing permissions and</span>
+<a name="l00014"></a>00014 <span class="comment">** limitations uche.org">HTTP Server Project</a> >
+<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>
+<h1>APR::Request::CGI<br>
+<small>
+[<a class="el" href="group__apreq__xs.html">Perl</a>]</small>
+</h1><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+</table>
+
+
+
+<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="#methods">METHODS</a></li>
+ <ul>
+
+ <li><a href="#handle">handle</a></li>
+ </ul>
+
+ <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>APR::Request::CGI - wrapper for libapreq2's CGI handle.</p>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+
+<pre>
+ use APR::Request::CGI;
+ my $req = APR::Request::CGI->handle($pool);</pre>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="description">DESCRIPTION</a></h1>
+
+<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>
+
+</p>
+<hr />
+
+<h1><a name="methods">METHODS</a></h1>
+
+<p>APR::Request::CGI - derived from <code>APR::Request</code>.</p>
+
+<p>
+
+</p>
+
+<h2><a name="handle">handle</a></h2>
+
+<pre>
+ APR::Request::CGI->handle($pool)</pre>
+
+<p>Creates an APR::Request::CGI object. The argument <code>$pool</code>
+is an APR::Pool object.</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/Pool.html">the APR::Pool manpage</a>.</p>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="copyright">COPYRIGHT</a></h1>
+
+<pre>
+ Copyright 2003-2005 The Apache Software Foundation</pre>
+
+<pre>
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at</pre>
+
+<pre>
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></pre>
+
+<pre>
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.</pre>
+
+
+<div id="footer">
+<p class="apache">
+Copyright © 2003-2005 <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>
+</p>
+</div>
+</body>
+</html>
Propchange: httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__cgi.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__cookie.html
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__cookie.html?rev=219933&view=aunder the License.</span>
+<a name="l00015"></a>00015 <span class="comment">*/</span>
+<a name="l00016"></a>00016
+<a name="l00017"></a>00017 <span class="preprocessor">#ifndef APREQ_APACHE2_H</span>
+<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define APREQ_APACHE2_H</span>
+<a name="l00019"></a>00019 <span class="preprocessor"></span>
+<a name="l00020"></a>00020 <span class="preprocessor">#include "<a class="code" href="apreq__module_8h.html">apreq_module.h</a>"</span>
+<a name="l00021"></a>00021 <span class="preprocessor">#include <httpd.h></span>
+<a name="l00022"></a>00022
+<a name="l00023"></a>00023 <span class="preprocessor">#ifdef __cplusplus</span>
+<a name="l00024"></a>00024 <span class="preprocessor"></span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
+<a name="l00025"></a>00025 <span class="preprocessor">#endif</span>
+<a name="l00026"></a>00026 <span class="preprocessor"></span>
+<a name="l00027"></a>00027
+<a name="l00140"></a>00140 APREQ_DECLARE(<a class="code" href="structapreq__handle__t.html">apreq_handle_t</a> *) <a class="code" href="group__mod__apreq2.html#ga0">apreq_handle_apache2</a>(request_rec *r);
+<a name="l00141"></a>00141
+<a name="l00142"></a>00142 #define APREQ_FILTER_NAME "apreq2"
+<a name="l00143"></a>00143 #define APREQ_APACHE2_MMN 20050712
+<a name="l00144"></a>00144
+<a name="l00147"></a>00147 #ifdef __cplusplus
+<a name="l00148"></a>00148 }
+<a name="l00149"></a>00149 #endif
+<a name="l00150"></a>00150
+<a name="l00151"></a>00151 #endif
</pre></div><div id="footer">
<p class="apache">
Copyright © 2003-2005 <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.2 on 4 May 2005</span>
+version 1.4.3-20050530 on 19 Jul 2005</span>
</p>
</div>
</body>
Modified: httpd/site/trunk/xdoto
==============================================================================
--- httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__cookie.html (added)
+++ httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__cookie.html Wed Jul 20 09:09:19 2005
@@ -0,0 +1,618 @@
+<html>
+<head>
+ <link rel="stylesheet" type="text/css" href="dox.css" />
+ <title>libapreq2-2.06-dev: libapreq2: APR::Request::Cookie</title>
+</head>
+<body>
+<div id="page-header">
+<p class="menu">
+ <a href="http://www.apache.org/">Apache Software Foundation</a> > <a href="http://httpd.apache.org">HTTP Server Project</a> >
+<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="qindcs/apreq/docs/libapreq2/apreq__module__apache_8h-source.html
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/xdocs/apreq/docs/libapreq2/apreq__module__apache_8h-source.html?rev=219933&r1=219932&r2=219933&view=diff
==============================================================================
--- httpd/site/trunk/xdocs/apreq/docs/libapreq2/apreq__module__apache_8h-source.html (original)
+++ httpd/site/trunk/xdocs/apreq/docs/libapreq2/apreq__module__apache_8h-source.html Wed Jul 20 09:09:19 2005
@@ -1,7 +1,7 @@
<html>
<head>
<link rel="stylesheet" type="text/css" href="dox.css" />
- <title>libapreq2-2.05-dev: libapreq2: module/apache/apreq_module_apache.h Source File</title>
+ <title>libapreq2-2.06-dev: libapreq2: module/apache/apreq_module_apache.h Source File</title>
</head>
<body>
<div id="page-header">
@@ -10,56 +10,58 @@
<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.2 -->
+<!-- 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>
<div class="nav">
-<a class="el" href="dir_000001.html">module</a> / <a class="el" href="dir_000002.html">apache</a></div>
-<h1>apreq_module_apache.h</h1><div class="fragment"><pre class="fragment">00001 <span class="comment">/*</span>
-00002 <span class="comment">** Copyright 2003-2005 The Apache Software Foundation</span>
-00003 <span class="comment">**</span>
-00004 <span class="comment">** Licensed under the Apache License, Version 2.0 (the "License");</span>
-00005 <span class="comment">** you may not use this file except in compliance with the License.</span>
-00006 <span class="comment">** You may obtain a copy of the License at</span>
-00007 <span class="comment">**</span>
-00008 <span class="comment">** http://www.apache.org/licenses/LICENSE-2.0</span>
-00009 <span class="comment">**</span>
-00010 <span class="comment">** Unless required by applicable law or agreed to in writing, software</span>
-00011 <span class="comment">** distributed under the License is distributed on an "AS IS" BASIS,</span>
-00012 <span class="comment">** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
-00013 <span class="comment">** See the License for the specific language governing permissions and</span>
-00014 <span class="comment">** limitations under the License.</span>
-00015 <span class="comment">*/</span>
-00016
-00017 <span class="preprocessor">#ifndef APREQ_APACHE_H</span>
-00018 <span class="preproex" 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>
+<h1>APR::Request::Cookie<br>
+<small>
+[<a class="el" href="group__apreq__xs.html">Perl</a>]</small>
+</h1><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+</table>
+
+
+
+<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="#overloads">OVERLOADS</a></li>
+ <ul>
+
+ <li><a href="#">``''</a></li>
+ </ul>
+
+ <li><a href="#methods">METHODS</a></li>
+ <ul>
+
+ <li><a href="#new">new</a></li>
+ <li><a href="#freeze">freeze</a></li>
+ <li><a href="#thaw">thaw</a></li>
+ <li><a href="#name">name</a></li>
+ <li><a href="#value">value</a></li>
+ <li><a href="#secure">secure</a></li>
+ <li><a href="#version">version</a></li>
+ <li><a href="#path">path</a></li>
+ <li><a href="#domain">domain</a></li>
+ <li><a href="#port">port</a></li>
+ <li><a href="#comment">comment</a></li>
+ <li><a href="#commenturl">commentURL</a></li>
+ <li><a href="#is_tainted">is_tainted</a></li>
+ <li><a href="#make">make</a></li>
+ <li><a href="#as_string">as_string</a></li>
+ </ul>
+
+ <li><a href="#subroutines">SUBROUTINES</a></li>
+ <ul>
+
+ <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">COPYRIcessor"></span><span class="preprocessor">#define APREQ_APACHE_H</span>
-00019 <span class="preprocessor"></span>
-00020 <span class="preprocessor">#include "<a class="code" href="apreq__module_8h.html">apreq_module.h</a>"</span>
-00021 <span class="preprocessor">#include <httpd.h></span>
-00022
-00023 <span class="preprocessor">#ifdef __cplusplus</span>
-00024 <span class="preprocessor"></span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
-00025 <span class="preprocessor">#endif</span>
-00026 <span class="preprocessor"></span>
-00031 APREQ_DECLARE(<a class="code" href="structapreq__handle__t.html">apreq_handle_t</a>*) apreq_handle_apache(request_rec *r);
-00032
-00033
-00034 APREQ_DECLARE(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a> *) apreq_handle_apache_pool(<a class="code" href="structapreq__handle__t.html">apreq_handle_t</a> *req);
-00035
-00036 APREQ_DECLARE(<a class="codeRef" doxygen="apu.tag:http://apr.apache.org/docs/apr-util/" href="http://apr.apache.org/docs/apr-util/group___a_p_r___util___bucket___brigades.html#ga2">apr_bucket_alloc_t</a> *)
-00037 apreq_handle_apache_bucket_alloc(<a class="code" href="structapreq__handle__t.html">apreq_handle_t</a> *req);
-00038
-00039 #ifdef __cplusplus
-00040 }
-00041 #endif
-00042
-00043 #endif
+<a class="el" href="dir_000001.html">module</a> » <a class="el" href="dir_000002.html">apache</a></div>
+<h1>apreq_module_apache.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
+<a name="l00002"></a>00002 <span class="comment">** Copyright 2003-2005 The Apache Software Foundation</span>
+<a name="l00003"></a>00003 <span class="comment">**</span>
+<a name="l00004"></a>00004 <span class="comment">** Licensed under the Apache License, Version 2.0 (the "License");</span>
+<a name="l00005"></a>00005 <span class="comment">** you may not use this filGHT</a></li>
+</ul>
+
+<!-- INDEX END -->
+
+
+<hr />
+
+<p>
+
+</p>
+
+<h1><a name="name">NAME</a></h1>
+
+<p>APR::Request::Cookie - wrapper for libapreq2's cookie API.</p>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+
+<pre>
+ use APR::Request::Cookie;</pre>
+
+<pre>
+ # fetch inbound cookie
+ $jar = $req->jar;
+ $cookie1 = $jar->get("cookie1");</pre>
+
+<pre>
+ # generate new cookie
+ $cookie = APR::Request::Cookie->new($req->pool,
+ name => "foo",
+ value => "bar",
+ domain => "capricorn.com");
+ print "$cookie"; # prints "bar"</pre>
+
+<pre>
+ $cookie->domain("example.com"); # change domains
+ $cookie->version(1); # upgrade it to conform with RFC 2109/2965.</pre>
+
+<pre>
+ # send a response header
+ print sprintf "Set-Cookie: %s\n", $cookie->as_string;</pre>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="description">DESCRIPTION</a></h1>
+
+<p>The APR::Request::Cookie module provides base methods
+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>
+
+</p>
+<hr />
+
+<h1><a name="overloads">OVERLOADS</a></h1>
+
+<p>APR::Request::Cookie</p>
+
+<p>
+
+</p>
+
+<h2><a name="">``''</a></h2>
+
+<pre>
+ "$cookie"</pre>
+
+<p>The double-quote interpolation operator maps to
+<code>APR::Request::Cookie::value()</code>.</p>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="methods">METHODS</a></h1>
+
+<p>APR::Request::Cookie</p>
+
+<p>
+
+</p>
+
+<h2><a name="new">new</a></h2>
+
+<pre>
+ 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.
+The remaining arguments are optional:</p>
+
+<dl>
+
+<dt>
+<strong>
+<a name="item__2dsecure">-secure</a>
+</strong><br />
+
+</dt>
+
+
+<dt>
+<strong>
+<a name="item__2dversion">-version</a>
+</strong><br />
+
+</dt>
+
+
+<dt>
+<strong>
+<a name="item__2dpath">-path</a>
+</strong><br />
+
+</dt>
+
+
+<dt>
+<strong>
+<a name="item__2ddomain">-domain</a>
+</strong><br />
+
+</dt>
+
+
+<dt>
+<strong>
+<a name="item__2dport">-port</a>
+</strong><br />
+
+</dt>
+
+
+<dt>
+<strong>
+<a name="item__2dexpires">-expires</a>
+</strong><br />
+
+</dt>
+
+
+<dt>
+<strong>
+<a name="item__2dcomment">-comment</a>
+</strong><br />
+
+</dt>
+
+
+<dt>
+<strong>
+<a name="item__2dcommenturl">-commentURL</a>
+</strong><br />
+
+</dt>
+
+
+</dl>
+
+
+<p>For details on these arguments, please consult
+the corresponding method's documee except in compliance with the License.</span>
+<a name="l00006"></a>00006 <span class="comment">** You may obtain a copy of the License at</span>
+<a name="l00007"></a>00007 <span class="comment">**</span>
+<a name="l00008"></a>00008 <span class="comment">** http://www.apache.org/licenses/LICENSE-2.0</span>
+<a name="l00009"></a>00009 <span class="comment">**</span>
+<a name="l00010"></a>00010 <span class="comment">** Unless required by applicable law or agreed to in writing, software</span>
+<a name="l00011"></a>00011 <span class="comment">** distributed under the License is distributed on an "AS IS" BASIS,</span>
+<a name="l00012"></a>00012 <span class="comment">** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
+<a name="l00013"></a>00013 <span class="comment">** See the License for the specific language governing permissions and</span>
+<a name="l00014"></a>00014 <span class="comment">** limitations under the License.</span>
+<a name="l00015"></a>00015 <span clntation.</p>
+
+<p>
+
+</p>
+
+<h2><a name="freeze">freeze</a></h2>
+
+<pre>
+ APR::Request::Cookie->freeze($value)</pre>
+
+<p>Class method representing the default serializer;
+here it returns $value unmodified.</p>
+
+<p>
+
+</p>
+
+<h2><a name="thaw">thaw</a></h2>
+
+<pre>
+ APR::Request::Cookie->thaw($value)</pre>
+
+<p>Class method that reverses <code>freeze()</code>;
+here it returns $value unmodified.</p>
+
+<p>
+
+</p>
+
+<h2><a name="name">name</a></h2>
+
+<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
+cookie's name.</p>
+
+<p>
+
+</p>
+
+<h2><a name="value">value</a></h2>
+
+<pre>
+ $cookie->value()</pre>
+
+<p>Fetch the cookie's raw (frozen) value.
+This attribute cannot be modified.</p>
+
+<p>
+
+</p>
+
+<h2><a name="secure">secure</a></h2>
+
+<pre>
+ $cookie->secure()
+ $cookie->secure($set)</pre>
+
+<p>Get/set the ass="comment">*/</span>
+<a name="l00016"></a>00016
+<a name="l00017"></a>00017 <span class="preprocessor">#ifndef APREQ_APACHE_H</span>
+<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define APREQ_APACHE_H</span>
+<a name="l00019"></a>00019 <span class="preprocessor"></span>
+<a name="l00020"></a>00020 <span class="preprocessor">#include "<a class="code" href="apreq__module_8h.html">apreq_module.h</a>"</span>
+<a name="l00021"></a>00021 <span class="preprocessor">#include <httpd.h></span>
+<a name="l00022"></a>00022
+<a name="l00023"></a>00023 <span class="preprocessor">#ifdef __cplusplus</span>
+<a name="l00024"></a>00024 <span class="preprocessor"></span> <span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
+<a name="l00025"></a>00025 <span class="preprocessor">#endif</span>
+<a name="l00026"></a>00026 <span class="preprocessor"></span>
+<a name="l00031"></a>00031 APREQ_DECLARE(<a class="code" href="structapreq__handle__t.html">apreq_handle_t</a>*) apreq_handle_apache(request_rec *r);
+<a name="l00032"></a>00032
+<a name="l00033"></a>00033
+<a name="l00034"></a>00034 APREQ_DECLARE(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a> *) apreq_handle_apache_pool(<a class="code" href="structapreq__handle__t.html">apreq_handle_t</a> *req);
+<a name="l00035"></a>00035
+<a name="l00036"></a>00036 APREQ_DECLARE(<a class="codeRef" doxygen="apu.tag:http://apr.apache.org/docs/apr-util/" href="http://apr.apache.org/docs/apr-util/group___a_p_r___util___bucket___brigades.html#ga2">apr_bucket_alloc_t</a> *)
+<a name="l00037"></a>00037 apreq_handle_apache_bucket_alloc(<a class="code" href="structapreq__handle__t.html">apreq_handle_t</a> *req);
+<a name="l00038"></a>00038
+<a name="l00039"></a>00039 #define APREQ_APACHE_MMN 20050712
+<a name="l00040"></a>00040
+<a name="l00041"></a>00041 #ifdef __cplusplus
+<a name="l00042"></a>00042 }
+<a name="l00043"></a>00043 #endif
+<a name="l00044"></a>00044
+<a name="l00045"></a>00045 #endif
</pre></div><div id="footer">
<p class="apache">
Copyright © 2003-2005 <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.2 on 4 May 2005</span>
+version 1.4.3-20050530 on 19 Jul 2005</span>
</p>
</div>
</body>
Modified: httpd/site/trunk/xdocs/apreq/docs/libapreq2/apreq__param_8h-source.html
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/xdocs/apreq/docs/libapreq2/apreq__param_8h-source.html?rev=219933&r1=219932&r2=219933&view=diff
==============================================================================
--- httpd/site/trunk/xdocs/apreq/docs/libapreq2/apreq__param_8h-source.html (original)
+++ httpd/site/trunk/xdocs/apreq/docs/libapreq2/apreq__param_8h-source.html Wed Jul 20 09:09:19 2005
@@ -1,7 +1,7 @@
<html>
<head>
<link rel="stylesheet" type="text/css" href="dox.css" />
- <title>libapreq2-2.05-dev: libapreq2: include/apreq_param.h Source File</title>
+ <title>libapreq2-2.06-dev: libapreq2: include/apreq_param.h Source File</title>
</head>
<body>
<div id="page-header">
@@ -10,136 +10,136 @@
<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.2 -->
+<!-- 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>
<div class="nav">
<a class="el" href="dir_000000.html">include</a></div>
-<h1>apreq_param.h</h1><a href="apreq__param_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment">00001 <span class="comment">/*</span>
-00002 <span class="comment">** Copyright 2003-2005 The Apache Software Foundation</span>
-00003 <span class="comment">**</span>
-00004 <span class="comment">** Licensed under the Apache License, Version 2.0 (the "License");</span>
-00005 <span class="comment">** you may not use this file except in compliance with the License.</span>
-00006 <span class="comment">** You may obtain a copy of the License at</span>
-00007 <span class="comment">**</span>
-00008 <span class="comment">** http://www.apache.org/licenses/LICENSE-2.0</span>
-00009 <span class="comment">**</span>
-00010 <span class="comment">** Unless required by applicable law or agreed to in writing, software</span>
-00011 <span class="comment">** distributed under the License is distributed on an "AS IS" BASIS,</span>
-00012 <span class="comment">** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
-00013 <span class="comment">** See the License for the specific language governing permissions and</span>
-00014 <span class="comment">** limitations under the License.</span>
-00015 <span class="comment">*/</span>
-00016
-00017 <span class="preprocessor">#ifndef APREQ_PARAM_H</span>
-00018 <span class="preprocessor"></span><span class="preprocessor">#define APREQ_PARAM_H</span>
-00019 <span class="preprocessor"></span>
-00020 <span class="preprocessor">#include "<a class="code" href="apreq_8h.html">apreq.h</a>"</span>
-00021 <span class="preprocessor">#include "<a class="codeRef" doxygen="apu.tag:http://apr.apache.org/docs/apr-util/" href="http://apr.apache.org/docs/apr-util/apr__buckets_8h.html">apr_buckets.h</a>"</span>
-00022
-00023 <span class="preprocessor">#ifdef __cplusplus</span>
-00024 <span class="preprocessor"></span><spacookie's secure flag.</p>
+
+<p>
+
+</p>
+
+<h2><a name="version">version</a></h2>
+
+<pre>
+ $cookie->version()
+ $cookie->version($set)</pre>
+
+<p>Get/set the cookie's version number.
+Version 0 cookies conform to the Netscape
+spec; Version 1 cookies conform to either
+RFC 2109 or RFC 2965.</p>
+
+<p>
+
+</p>
+
+<h2><a name="path">path</a></h2>
+
+<pre>
+ $cookie->path()
+ $cookie->path($set)</pre>
+
+<p>Get/set the cookie's path string.</p>
+
+<p>
+
+</p>
+
+<h2><a name="domain">domain</a></h2>
+
+<pre>
+ $cookie->domain()
+ $cookie->domain($set)</pre>
+
+<p>Get/set the cookie's domain string.</p>
+
+<p>
+
+</p>
+
+<h2><a name="port">port</a></h2>
+
+<pre>
+ $cookie->port()
+ $cookie->port($set)</pre>
+
+<p>Get/set the cookie's port string.
+Only valid for Version 1 cookies.</p>
+
+<p>
+
+</p>
+
+<h2><a name="comment">comment</a></h2>
+
+<pre>
+ $cookie->comment()
+ $cookie->comment($set)</pre>
+
+<p>Get/set the cookie's comment string.
+Only valid for Version 1 cookies.</p>
+
+<p>
+
+</p>
+
+<h2><a name="commenturl">commentURL</a></h2>
+
+<pre>
+ $cookie->commentURL()
+ $cookie->commentURL($set)</pre>
+
+<p>Get/set the cookie's commentURL string.
+Only valid for Version 1 cookies.</p>
+
+<p>
+
+</p>
+
+<h2><a name="is_tainted">is_tainted</a></h2>
+
+<pre>
+ $cookie->is_tainted()
+ $cookie->is_tainted($set)</pre>
+
+<p>Get/set the cookie's internal tainted flag.</p>
+
+<p>
+
+</p>
+
+<h2><a name="make">make</a></h2>
+
+<pre>
+ APR::Request::Cookie->make($pool, $name, $value)</pre>
+
+<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>
+
+<p>
+
+</p>
+
+<h2><a name="as_string">as_string</a></h2>
+
+<pre>
+ $cookie->as_string()</pre>
+
+<p>String representation of the cookie, suitable for inclusion
+in a ``Set-Cookie'' header.</p>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="subroutines">SUBROUTINES</a></h1>
+
+<pre>
+ APR::Request::Cookie</pre>
+
+<p>
+
+</p>
+
+<h2><a name="expires">expires</a></h2>
+
+<pre>
+ expires($date_string)</pre>
+
+<p>
+
+</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>
+
+</p>
+<hr />
+
+<h1><a name="copyright">COPYRIGHT</a></h1>
+
+<pre>
+ Copyright 2003-2005 The Apache Software Foundation</pre>
+
+<pre>
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at</pre>
+
+<pre>
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></pre>
+
+<pre>
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.</pre>
+
+
+<div id="footer">
+<p class="apache">
+Copyright © 2003-2005 <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>
+</p>
+</div>
+</body>
+</html>
Propchange: httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__cookie.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__error.html
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__error.html?rev=219933&view=auto
==============================================================================
--- httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__error.html (added)
+++ httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__error.html Wed Jul 20 09:09:19 2005
@@ -0,0 +1,141 @@
+<html>
+<head>
+ <link rel="stylesheet" type="text/css" href="dox.css" />
+ <title>libapreq2-2.06-dev: libapreq2: APR::Request::Error</title>
+</head>
+<body>
+<div id="pagen class="keyword">extern</span> <span class="stringliteral">"C"</span> {
-00025 <span class="preprocessor">#endif</span>
-00026 <span class="preprocessor"></span>
-00027
+<h1>apreq_param.h</h1><a href="apreq__param_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
+<a name="l00002"></a>00002 <span class="comment">** Copyright 2003-2005 The Apache Software Foundation</span>
+<a name="l00003"></a>00003 <span class="comment">**</span>
+<a name="l00004"></a>00004 <span class="comment">** Licensed under the Apache License, Version 2.0 (the "License");</span>
+<a name="l00005"></a>00005 <span class="comment">** you may not use this file except in compliance with the License.</span>
+<a name="l00006"></a>00006 <span class="comment">** You may obtain a copy of the License at</span>
+<a name="l00007"></a>00007 <span class="comment">**</span>
+<a name="l00008"></a>00008 <span class="comment">** http://www.apache.org/licenses/LICENSE-2.0</span>
+<a name="l00009"></a>00009 <span class="comment">**</span>
+<a name="l00010"></a>00010 <span class="comment">** Unless required by applicable law or agreed to in writing, software</span>
+<a name="l00011"></a>00011 <span class="comment">** distributed under the License is distributed on an "AS IS" BASIS,</span>
+<a name="l00012"></a>00012 <span class="comment">** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span>
+<a name="l00013"></a>00013 <span class="comment">** See the License for the specific language governing permissions and</span>
+<a name="l00014"></a>00014 <span class="comment">** limitations under the License.</span>
+<a name="l00015"></a>00015 <span class="comment">*/</span>
+<a name="l00016"></a>00016
+<a name="l00017"></a>00017 <span class="preprocessor">#ifndef APREQ_PARAM_H</span>
+<a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define APREQ_PARAM_H</span>
+<a name="l00019"></a>00019 <span class="preprocessor"></span>
+<a name="l00020"></a>00020 <span class="preprocessor">#include "<a class="code" href="apreq_8h.html">apreq.h</a>"</span>
+<a name="l00021"></a>00021 <span class="preprocessor">#include "<a class="codeRef" doxygen="apu.tag:http://apr.apache.org/docs/apr-util/" href="http://apr.apache.org/docs/apr-util/apr__buckets_8h.html">apr_buckets.h</a>"</span>
+<a name="l00022"></a>00022
+<a name="l00023"></a>00023 <span class="preprocessor">#ifdef __cplusplus</span>
+<a name="l00024"></a>00024 <span class="preprocessor"></span><span class="keyword">extern</span> <span class="stringliteral">"C"</span> {
+<a name="l00025"></a>00025 <span class="preprocessor">#endif</span>
+<a name="l00026"></a>00026 <span class="preprocessor"></span>
+<a name="l00027"></a>00027
<a name="l00036"></a><a class="code" href="structapreq__param__t.html">00036</a> <span class="keyword">typedef</span> <span class="keyword">struct </span><a class="code" href="structapreq__param__t.html">apreq_param_t</a> {-header">
+<p class="menu">
+ <a href="http://www.apache.org/">Apache Software Foundation</a> > <a href="http://httpd.apache.org">HTTP Server Project</a> >
+<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>
+<h1>APR::Request::Error<br>
+<small>
+[<a class="el" href="group__apreq__xs.html">Perl</a>]</small>
+</h1><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+</table>
+
+
+
+<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="#subroutines">SUBROUTINES</a></li>
+ <ul>
+
+ <li><a href="#strerror">strerror</a></li>
+ </ul>
+
+ <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>APR::Request::Error - wrapper for libapreq2's error API.</p>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+
+<pre>
+ use APR::Request::Error;</pre>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="description">DESCRIPTION</a></h1>
+
+<p>This manpage documents the APR::Request::Error package.</p>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="subroutines">SUBROUTINES</a></h1>
+
+<p>APR::Request::Error - derived from <code>APR::Request</code> and <code>APR::Error</code>.</p>
+
+<p>
+
+</p>
+
+<h2><a name="strerror">strerror</a></h2>
+
+<pre>
+ strerror($status)</pre>
+
+<p>Returns the apreq error string associated with a numeric <code>$status</code> code.</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>
+
+</p>
+<hr />
+
+<h1><a name="copyright">COPYRIGHT</a></h1>
+
+<pre>
+ Copyright 2003-2005 The Apache Software Foundation</pre>
+
+<pre>
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at</pre>
+
+<pre>
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></pre>
+
+<pre>
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.</pre>
+
+
+<div id="footer">
+<p class="apache">
+Copyright © 2003-2005 <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>
+</p>
+</div>
+</body>
+</html>
Propchange: httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__error.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__param.html
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__param.html?rev=219933&view=auto
===================
<a name="l00037"></a><a class="code" href="structapreq__param__t.html#o0">00037</a> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__tables.html#ga0">apr_table_t</a> *<a class="code" href="structapreq__param__t.html#o0">info</a>;
<a name="l00038"></a><a class="code" href="structapreq__param__t.html#o1">00038</a> <a class="codeRef" doxygen="apu.tag:http://apr.apache.org/docs/apr-util/" href="http://apr.apache.org/docs/apr-util/structapr__bucket__brigade.html">apr_bucket_brigade</a> *<a class="code" href="structapreq__param__t.html#o1">upload</a>;
<a name="l00039"></a><a class="code" href="structapreq__param__t.html#o2">00039</a> <span class="keywordtype">unsigned</span> <a class="code" href="structapreq__param__t.html#o2">flags</a>;
<a name="l00040"></a><a class="code" href="structapreq__param__t.html#o3">00040</a> <span class="keyword">const</span> <a class="code" href="structapreq__value__t.html">apreq_value_t</a> <a class="code" href="structapreq__param__t.html#o3">v</a>;
-00041 } <a class="code" href="structapreq__param__t.html">apreq_param_t</a>;
-00042
-00043
-00045 <span class="keyword">static</span> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga11">APR_INLINE</a>
+<a name="l00041"></a>00041 } <a class="code" href="structapreq__param__t.html">apreq_param_t</a>;
+<a name="l00042"></a>00042
+<a name="l00043"></a>00043
+<a name="l00045"></a>00045 <span class="keyword">static</span> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga11">APR_INLINE</a>
<a name="l00046"></a><a class="code" href="apreq__param_8h.html#a1">00046</a> <span class="keywordtype">unsigned</span> <a class="code" href="apreq__param_8h.html#a1">apreq_param_is_tainted</a>(<span class="keyword">const</span> <a class="code" href="structapreq__param__t.html">apreq_param_t</a> *p) {
-00047 <span class="keywordflow">return</span> APREQ_FLAGS_GET(p-><a class="code" href="structapreq__param__t.html#o2">flags</a>, APREQ_TAINTED);
-00048 }
-00049
-00051 <span class="keyword">static</span> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga11">APR_INLINE</a>
+<a name="l00047"></a>00047 <span class="keywordflow">return</span> APREQ_FLAGS_GET(p-><a class="code" href="structapreq__param__t.html#o2">flags</a>, APREQ_TAINTED);
+<a name="l00048"></a>00048 }
+<a name="l00049"></a>00049
+<a name="l00051"></a>00051 <span class="keyword">static</span> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga11">APR_INLINE</a>
<a name="l00052"></a><a class="code" href="apreq__param_8h.html#a2">00052</a> <span class="keywordtype">void</span> <a class="code" href="apreq__param_8h.html#a2">apreq_param===========================================================
--- httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__param.html (added)
+++ httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__param.html Wed Jul 20 09:09:19 2005
@@ -0,0 +1,623 @@
+<html>
+<head>
+ <link rel="stylesheet" type="text/css" href="dox.css" />
+ <title>libapreq2-2.06-dev: libapreq2: APR::Request::Param</title>
+</head>
+<body>
+<div id="page-header">
+<p class="menu">
+ <a href="http://www.apache.org/">Apache Software Foundation</a> > <a href="http://httpd.apache.org">HTTP Server Project</a> >
+<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>
+<h1>APR::Request::Param<br>
+<small>
+[<a class="el" href="group__apreq__xs.html">Perl</a>]</small>
+</h1><table border="0" cellpadding="0" cellspacing="0">
+<tr><td></td></tr>
+</table>
+
+
+
+<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="#overloads">OVERLOADS</a></li>
+ <ul>
+
+ <li><a href="#">``''</a></li>
+ </ul>
+
+ <li><a href="#methods">METHODS</a></li>
+ <ul>
+
+ <li><a href="#name">name</a></li>
+ <li><a href="#value">value</a></li>
+ <li><a href="#is_tainted">is_tainted</a></li>
+ <li><a href="#charset">charset</a></li>
+ <li><a href="#make">make</a></li>
+ <li><a href="#info">info</a></li>
+ <li><a href="#upload">upload</a></li>
+ <li><a href="#upload_filename">upload_filename</a></li>
+ <li><a href="#upload_link">upload_link</a></li>
+ <li><a href="#upload_slurp">upload_slurp</a></li>
+ <li><a href="#upload_size">upload_size</a></li>
+ <li><a href="#upload_type">upload_type</a></li>
+ <li><a href="#upload_tempname">upload_tempname</a></li>
+ <li><a href="#upload_io">upload_io</a></li>
+ <li><a href="#upload_fh">upload_fh</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="#methods">METHODS</a></li>
+ <ul>
+
+ <li><a href="#new__tiehandle">new, TIEHANDLE</a></li>
+ <li><a href="#read_tainted_on</a>(<a class="code" href="structapreq__param__t.html">apreq_param_t</a> *p) {
-00053 APREQ_FLAGS_ON(p-><a class="code" href="structapreq__param__t.html#o2">flags</a>, APREQ_TAINTED);
-00054 }
-00055
-00057 <span class="keyword">static</span> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga11">APR_INLINE</a>
+<a name="l00053"></a>00053 APREQ_FLAGS_ON(p-><a class="code" href="structapreq__param__t.html#o2">flags</a>, APREQ_TAINTED);
+<a name="l00054"></a>00054 }
+<a name="l00055"></a>00055
+<a name="l00057"></a>00057 <span class="keyword">static</span> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga11">APR_INLINE</a>
<a name="l00058"></a><a class="code" href="apreq__param_8h.html#a3">00058</a> <span class="keywordtype">void</span> <a class="code" href="apreq__param_8h.html#a3">apreq_param_tainted_off</a>(<a class="code" href="structapreq__param__t.html">apreq_param_t</a> *p) {
-00059 APREQ_FLAGS_OFF(p-><a class="code" href="structapreq__param__t.html#o2">flags</a>, APREQ_TAINTED);
-00060 }
-00061
-00063 <span class="keyword">static</span> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga11">APR_INLINE</a>
+<a name="l00059"></a>00059 APREQ_FLAGS_OFF(p-><a class="code" href="structapreq__param__t.html#o2">flags</a>, APREQ_TAINTED);
+<a name="l00060"></a>00060 }
+<a name="l00061"></a>00061
+<a name="l00063"></a>00063 <span class="keyword">static</span> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga11">APR_INLINE</a>
<a name="l00064"></a><a class="code" href="apreq__param_8h.html#a4">00064</a> <a class="code" href="apreq_8h.html#a37">apreq_charset_t</a> <a class="code" href="apreq__param_8h.html#a4">apreq_param_charset_set</a>(<a class="code" href="structapreq__param__t.html">apreq_param_t</a> *p, <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> c) {
-00065 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> old = APREQ_FLAGS_GET(p-><a class="code" href="structapreq__param__t.html#o2">flags</a>, APREQ_CHARSET);
-00066 APREQ_FLAGS_SET(p-><a class="code" href="structapreq__param__t.html#o2">flags</a>, APREQ_CHARSET, c);
-00067 <span class="keywordflow">return</span> old;
-00068 }
-00069
-00071 <span class="keyword">static</span> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga11">APR_INLINE</a>
+<a name="l00065"></a>00065 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> old = APREQ_FLAGS_GET(p-><a class="code" href="structapreq__param__t.html#o2">flags</a>, APREQ_CHARSET);
+<a name="l00066"></a>00066 APREQ_FLAGS_SET(p-><a class="code" href="structapreq__param__t.html#o2">flags</a>, APREQ_CHARSET, c);
+<a name="l00067"></a>00067 <span class="keywordflow">return</span> old;
+<a name="l00068"></a>00068 }
+<a name="l00069"></a>00069
+<a name="l00071"></a>00071 <span class="keyword">static</span> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga11">APR_INLINE</a>
<a name="l00072"></a><a class="code" href="apreq__param_8h.html#a5">00072</a> <a class="code" href="apreq_8h.html#a37">apreq_charset_t</a> <a class="code" href="apreq__param_8h.html#a5">apreq_param_charset_get</a>(<a class="code" href="structapreq__param__t.html">apreq_param_t</a> *p) {
-00073 <span class="keywordflow">return</span> APREQ_FLAGS_GET(p-><a class="code" href="structapreq__param__t.html#o2">flags</a>, APREQ_CHARSET);
-00074 }
-00075
-00076
-00078 <span class="keyword">static</span> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga11">APR_INLINE</a>
+<a name="l00073"></a>00073 <span class="keywordflow">return</span> APREQ_FLAGS_GET(p-><a class="code" href="structapreq__param__t.html#o2">flags</a>, APREQ_CHARSET);
+<a name="l00074"></a>00074 }
+<a name="l00075"></a>00075
+<a name="l00076"></a>00076
+<a name="l00078"></a>00078 <span class="keyword">static</span> <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga11">APR_INLINE</a>
<a name="l00079"></a><a class="code" href="apreq__param_8h.html#a6">00079</a> <a class="code" href="structapreq__param__t.html">apreq_param_t</a> *<a class="code" href="apreq__param_8h.html#a6">apreq_value_to_param</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *val)
-00080 {
-00081 <span class="keyword">union </span>{ <span class="keyword">const</span> <span class="keywordtype">char</span> *in; <span class="keywordtype">char</span> *out; } decons">READ</a></li>
+ <li><a href="#readline">READLINE</a></li>
+ </ul>
+
+ <li><a href="#methods">METHODS</a></li>
+ <ul>
+
+ <li><a href="#read">read</a></li>
+ <li><a href="#readline">readline</a></li>
+ </ul>
+
+ <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>APR::Request::Param - wrapper for libapreq2's param API.</p>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+
+<pre>
+ use APR::Request::Param;</pre>
+
+<pre>
+ $arg1 = $req->args('alpha');
+ $body = $req->body;
+ $body->param_class("APR::Request::Param");
+ ok $_->isa("APR::Request::Param") for values %$body;</pre>
+
+<pre>
+ @uploads = grep {$_->upload} values %$body;</pre>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="description">DESCRIPTION</a></h1>
+
+<p>The <code>APR::Request::Param</code> module provides base methods
+for interfacing with libapreq2's param API. It also provides
+a few utility functions and constants.</p>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="overloads">OVERLOADS</a></h1>
+
+<p>APR::Request::Param</p>
+
+<p>
+
+</p>
+
+<h2><a name="">``''</a></h2>
+
+<pre>
+ "$param"</pre>
+
+<p>The double-quote interpolation operator maps to
+<code>APR::Request::Param::value()</code>.</p>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="methods">METHODS</a></h1>
+
+<p>APR::Request::Param</p>
+
+<p>
+
+</p>
+
+<h2><a name="name">name</a></h2>
+
+<pre>
+ $param->name()</pre>
+
+<p>Returns the param's name.
+This attribute cannot be modified.</p>
+
+<p>
+
+</p>
+
+<h2><a name="value">value</a></h2>
+
+<pre>
+ $param->value()</pre>
+
+<p>Returns the param's value.
+This attribute cannot be modified.</p>
+
+<p>
+
+</p>
+
+<h2><a name="is_tainted">is_tainted</a></h2>
+
+<pre>
+ $param->is_tainted()
+ $param->is_tainted($set)</pre>
+
+<p>Get/set the param's internal tainted flag.
+Note: if the param's charset is APREQ_CHARSET_UTF8 (8),
+this also activates the SvUTF8_on flag during calls
+to <code>name()</code> and/or value().</p>
+
+<p>
+
+</p>
+
+<h2><a name="charset">charset</a></h2>
+
+<pre>
+ $param->charset()
+ $param->charset($set)</pre>
+
+<p>Get/set the param's internal charset. The charset
+is a number between 0 and 255; the current recognized
+values are</p>
+
+<ol>
+
+<li>
+<strong>
+<a name="item_apreq_charset_ascii">APREQ_CHARSET_ASCII (7-bit us-ascii)</a>
+</strong><br />
+
+</li>
+
+
+<li>
+<strong>
+<a name="item_apreq_charset_latin1">APREQ_CHARSET_LATIN1 (8-bit iso-8859-1)</a>
+</strong><br />
+
+</li>
+
+
+<li>
+<strong>
+<a name="item_apreq_charset_cp1252">APREQ_CHARSET_CP1252 (8-bit Windows-1252)</a>
+</strong><br />
+
+</li>
+
+
+<li>
+<strong>
+<a name="item_apreq_charset_utf8">APREQ_CHARSET_UTF8 (utf8 encoded Unicode)</a>
+</strong><br />
+
+</li>
+
+
+</ol>
+
+
+<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>
+
+<p>
+
+</p>
+
+<h2><a name="make">make</a></h2>
+
+<pre>
+ APR::Request::Param->make($pool, $name, $value)</pre>
+
+<p>Fast XS param constructor.</p>
+
+<p>
+
+</p>
+
+<h2><a name="info">info</a></h2>
+
+<pre>
+ $param->info()
+ $param->info($set)</pre>
+
+<p>Get/set the APR::Table headers for this param.</p>
+
+<p>
+
+</p>
+
+<h2><a name="upload">upload</a></h2>
+
+<pre>
+ $param->upload()
+ $param->upload($set)</pre>
+
+<p>Get/set the APR::Brigade file-upload content for this param.</p>
+
+<p>
+
+</p>
+
+<h2><a name="upload_filename">upload_filename</a></h2>
+
+<pre>
+ $param->upload_filename()</pre>
+
+<p>Returns the client-side filename associated with this param.</p>
+
+<p>
+
+</p>
+
+<h2><a name="upload_link">upload_link</a></h2>
+
+<pre>
+ $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>)
+temporary directory is on the same device as <code>$path</code>;
+otherwise this writes a copy.</p>
+
+<p>
+
+</p>
+
+<h2><a name="upload_slurp">upload_slurp</a></h2>
+
+<pre>
+ $param->upload_slurp($data)</pre>
+
+<p>Reads the entire file-upload content into <code>$data</code>.</p>
+
+<p>
+
+</p>
+
+<h2><a name="upload_size">upload_size</a></h2>
+
+<pre>
+ $param->upload_size()</pre>
+
+<p>Returns the size of the param's file-upload content.</p>
+
+<p>
+
+</p>
+
+<h2><a name="upload_type">upload_type</a></h2>
+
+<pre>
+ $param->upload_type()</pre>
+
+<p>Returns the MIME-type of the param's file-upload content.</p>
+
+<p>
+
+</p>
+
+<h2><a name="upload_tempname">upload_tempname</a></h2>
+
+<pre>
+ $param->upload_tempname()</pre>
+
+<p>Returns the name of the local spoolfile for this param.</p>
+
+<p>
+
+</p>
+
+<h2><a name="upload_io">upload_io</a></h2>
+
+<pre>
+ $param->upload_io()</pre>
+
+<p>Returns an <a href="/APR/Request/Brigade/IO.html">the APR::Request::Brigade::IO mt;
-00082
-00083 deconst.in = val;
-00084 <span class="keywordflow">return</span> apreq_attr_to_type(<a class="code" href="structapreq__param__t.html">apreq_param_t</a>, v,
-00085 apreq_attr_to_type(<a class="code" href="structapreq__value__t.html">apreq_value_t</a>, data, deconst.out));
-00086 }
-00087
-00088
-00089
-00091 APREQ_DECLARE(<a class="code" href="structapreq__param__t.html">apreq_param_t</a> *) <a class="code" href="apreq__param_8h.html#a7">apreq_param_make</a>(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a> *p,
-00092 const <span class="keywordtype">char</span> *name,
-00093 const <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga7">apr_size_t</a> nlen,
-00094 const <span class="keywordtype">char</span> *val,
-00095 const <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga7">apr_size_t</a> vlen);
-00096
-00113 APREQ_DECLARE(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__errno.html#ga0">apr_status_t</a>) <a class="code" href="apreq__param_8h.html#a8">apreq_param_decode</a>(<a class="code" href="structapreq__param__t.html">apreq_param_t</a> **param,
-00114 <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a> *pool,
-00115 const <span class="keywordtype">char</span> *word,
-00116 <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga7">apr_size_t</a> nlen,
-00117 <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga7">apr_size_t</a> vlen);
-00118
-00125 APREQ_DECLARE(<span class="keywordtype">char</span> *) <a class="code" href="apreq__param_8h.html#a9">apreq_param_encode</a>(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a> *pool,
-00126 const <a class="code" href="structapreq__param__t.html">apreq_param_t</a> *param);
-00127
-00139 APREQ_DECLARE(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__errno.html#ga0">apr_status_t</a>) <a class="code" href="apreq__param_8h.html#a10">apreq_parse_query_string</a>(<a class="codeanpage</a> object, which can
+be treated as a non-seekable IO stream.</p>
+
+<p>
+
+</p>
+
+<h2><a name="upload_fh">upload_fh</a></h2>
+
+<pre>
+ $param->upload_fh</pre>
+
+<p>Returns a seekable filehandle representing the file-upload content.</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
+<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
+methods for TIEHANDLE, READ and READLINE. To be memory efficient,
+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
+read-only socket.</p>
+
+<p>
+
+</p>
+
+<h2><a name="new__tiehandle">new, TIEHANDLE</a></h2>
+
+<pre>
+ APR::Request::Brigade->TIEHANDLE($bb)</pre>
+
+<p>Creates a copy Ref" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a> *pool,
-00140 <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__tables.html#ga0">apr_table_t</a> *t,
-00141 const <span class="keywordtype">char</span> *qs);
-00142
-00143
-00155 APREQ_DECLARE(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/structapr__array__header__t.html">apr_array_header_t</a> *) <a class="code" href="apreq__param_8h.html#a11">apreq_params_as_array</a>(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a> *p,
-00156 const <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__tables.html#ga0">apr_table_t</a> *t,
-00157 const <span class="keywordtype">char</span> *key);
-00158
-00173 APREQ_DECLARE(const <span class="keywordtype">char</span> *) <a class="code" href="apreq__param_8h.html#a12">apreq_params_as_string</a>(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a> *p,
-00174 const <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__tables.html#ga0">apr_table_t</a> *t,
-00175 const <span class="keywordtype">char</span> *key,
-00176 <a class="code" href="apreq_8h.html#a38">apreq_join_t</a> mode);
-00177
-00185 APREQ_DECLARE(const <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__tables.html#ga0">apr_table_t</a> *) <a class="code" href="apreq__param_8h.html#a13">apreq_uploads</a>(const <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__tables.html#ga0">apr_table_t</a> *body,
-00186 <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a> *pool);
-00187
-00196 APREQ_DECLARE(const <a class="code" href="structapreq__param__t.html">apreq_param_t</a> *) <a class="code" href="apreq__param_8h.html#a14">apreq_upload</a>(const <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__tables.html#ga0">apr_table_t</a> *body,
-00197 const <span class="keywordtype">char</span> *name);
-00198
-00199
-00200 #ifdef __cplusplus
-00201 }
-00202 #endif
-00203
-00204 #endif <span class="comment">/* APREQ_PARAM_H */</span>
-00205
-00206
-00207
+<a name="l00080"></a>00080 {
+<a name="l00081"></a>00081 <span class="keyword">union </span>{ <span class="keyword">const</span> <span class="keywordtype">char</span> *in; <span class="keywordtype">char</span> *out; } deconst;
+<a name="l00082"></a>00082
+<a name="l00083"></a>00083 deconst.in = val;
+<a name="l00084"></a>00084 <span class="keywordflow">return</span> apreq_attr_to_type(<a class="code" href="structapreq__param__t.html">apreq_param_t</a>, v,
+<a name="l00085"></a>00085 apreq_attr_to_type(<a class="code" href="structapreq__value__t.html">apreq_value_t</a>, data, deconst.out));
+<a name="l00086"></a>00086 }
+<a name="l00087"></a>00087
+<a name="l00088"></a>00088
+<a name="l00089"></a>00089
+<a name="l00091"></a>00091 APREQ_DECLARE(<a class="code" href="structapreq__param__t.html">apreq_param_t</a> *) <a class="code" href="apreq__param_8h.html#a7">apreq_param_make</a>(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a> *p,
+<a name="l00092"></a>00092 const <span class="keywordtype">char</span> *name,
+<a name="l00093"></a>00093 const <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga7">apr_size_t</a> nlen,
+<a name="l00094"></a>00094 const <span class="keywordtype">char</span> *val,
+<a name="l00095"></a>00095 const <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga7">apr_size_t</a> vlen);
+<a name="l00096"></a>00096
+<a name="l00113"></a>00113 APREQ_DECLARE(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__errno.html#ga0">apr_status_t</a>) <a class="code" href="apreq__param_8h.html#a8">apreq_param_decode</a>(<a class="code" href="structapreq__param__t.html">apreq_param_t</a> **param,
+<a name="l00114"></a>00114 <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a> *pool,
+<a name="l00115"></a>00115 const <span class="keywordtype">char</span> *word,
+<a name="l00116"></a>00116 <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga7">apr_size_t</a> nlen,
+<a name="l00117"></a>00117 <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__platform.html#ga7">apr_size_t</a> vlen);
+<a name="l00118"></a>00118
+<a name="l00125"></a>00125 APREQ_DECLARE(<span class="keywordtype">char</span> *) <a class="code" href="apreq__param_8h.html#a9">apreq_param_encode</a>(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a> *pool,
+<a name="l00126"></a>00126 const <a class="code" href="structapreq__param__t.html">apreq_param_t</a> *param);
+<a name="l00127"></a>00127
+<a name="l00139"></a>00139 APREQ_DECLARE(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__errno.html#ga0">apr_status_t</a>) <a class="code" href="apreq__param_8h.html#a10">apreq_parse_query_string</a>(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a> *pool,
+<a name="l00140"></a>00140 <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__tables.html#ga0">apr_table_t</a> *t,
+<a name="l00141"></a>00141 const <span class="keywordtype">char</span> *qs);
+<a name="l00142"></a>00142
+<a name="l00143"></a>00143
+<a name="l00155"></a>00155 APREQ_DECLARE(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/structapr__array__header__t.html">apr_array_header_t</a> *) <a class="code" href="apreq__param_8h.html#a11">apreq_params_as_array</a>(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a> *p,
+<a name="l00156"></a>00156 const <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__tables.html#ga0">apr_table_t</a> *t,
+<a name="l00157"></a>00157 const <span class="keywordtype">char</span> *key);
+<a name="l00158"></a>00158
+<a name="l00173"></a>00173 APREQ_DECLARE(const <span class="keywordtype">char</span> *) <a class="code" href="apreq__param_8h.html#a12">apreq_params_as_string</a>(<a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a> *p,
+<a name="l00174"></a>00174 const <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__tables.html#ga0">apr_table_t</a> *t,
+<a name="l00175"></a>00175 const <span class="keywordtype">char</span> *key,
+<a name="l00176"></a>00176 <aof the bucket brigade represented by $bb, and
+blesses that copy into the APR::Request::Brigade class. This
+provides syntactic sugar for using perl's builtin <code>read</code>, <code>readline</code>,
+and <code><></code> operations on handles tied to this package:</p>
+
+<pre>
+ use Symbol;
+ $fh = gensym;
+ tie *$fh, "APR::Request:Brigade", $bb;
+ print while <$fh>;</pre>
+
+<p>
+
+</p>
+
+<h2><a name="read">READ</a></h2>
+
+<pre>
+ $bb->READ($contents)
+ $bb->READ($contents, $length)
+ $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
+to read the new data.</p>
+
+<p>
+
+</p>
+
+<h2><a name="readline">READLINE</a></h2>
+
+<pre>
+ $bb->READLINE()</pre>
+
+<p>Returns the first line of data from the bride. Lines are terminated by
+linefeeds (the '\012' character), but we may eventually use <code>$/</code> instead.</p>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="methods">METHODS</a></h1>
+
+<p>APR::Request::Brigade::IO</p>
+
+<p>
+
+</p>
+
+<h2><a name="read">read</a></h2>
+
+<p>OO interface to APR::Request::Brigade::READ.</p>
+
+<p>
+
+</p>
+
+<h2><a name="readline">readline</a></h2>
+
+<p>OO interface to APR::Request::Brigade::READLINE.</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/Table.html">the APR::Table manpage</a>, <a href="/APR/Brigade.html">the APR::Brigade manpage</a>.</p>
+
+<p>
+
+</p>
+<hr />
+
+<h1><a name="copyright">COPYRIGHT</a></h1>
+
+<pre>
+ Copyright 2003-2005 The Apache Software Foundation</pre>
+
+<pre>
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at</pre>
+
+<pre>
+ <a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></pre>
+
+<pre>
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.</pre>
+
+
+<div id="footer">
+<p class="apache">
+Copyright © 2003-2005 <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>
+</p>
+</div>
+</body>
+</html>
Propchange: httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__apr__request__param.html
------------------------------------------------------------------------------
svn:eol-style = native
Modified: httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__cookie.html
URL: http://svn.apache.org/viewcvs/httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__cookie.html?rev=219933&r1=219932&r2=219933&view=diff
==============================================================================
--- httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__cookie.html (original)
+++ httpd/site/trunk/xdocs/apreq/docs/libapreq2/group__apreq__xs__cookie.html Wed Jul 20 09:09:19 2005
@@ -1,7 +1,7 @@
<html>
<head>
<link rel="stylesheet" type="text/css" href="dox.css" />
- <title>libapreq2-2.05-dev: libapreq2: Apache2::Cookie</title>
+ <title>libapreq2-2.06-dev: libapreq2: Apache2::Cookie</title>
</head>
<body>
<div id="page-header">
@@ -10,7 +10,7 @@
<a href="http://httpd.apache.org/apreq/">Request Library Subproject</a></p>
<p class="apache">Apache HTTP Server Request Library</p>
<img alt= class="code" href="apreq_8h.html#a38">apreq_join_t</a> mode);
+<a name="l00177"></a>00177
+<a name="l00185"></a>00185 APREQ_DECLARE(const <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__tables.html#ga0">apr_table_t</a> *) <a class="code" href="apreq__param_8h.html#a13">apreq_uploads</a>(const <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__tables.html#ga0">apr_table_t</a> *body,
+<a name="l00186"></a>00186 <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__pools.html#ga0">apr_pool_t</a> *pool);
+<a name="l00187"></a>00187
+<a name="l00196"></a>00196 APREQ_DECLARE(const <a class="code" href="structapreq__param__t.html">apreq_param_t</a> *) <a class="code" href="apreq__param_8h.html#a14">apreq_upload</a>(const <a class="codeRef" doxygen="apr.tag:http://apr.apache.org/docs/apr/" href="http://apr.apache.org/docs/apr/group__apr__tables.html#ga0">apr_table_t</a> *body,
+<a name="l00197"></a>00197 const <span class="keywordtype">char</span> *name);
+<a name="l00198"></a>00198
+<a name="l00199"></a>00199
+<a name="l00200"></a>00200 #ifdef __cplusplus
+<a name="l00201"></a>00201 }
+<a name="l00202"></a>00202 #endif
+<a name="l00203"></a>00203
+<a name="l00204"></a>00204 #endif <span class="comment">/* APREQ_PARAM_H */</span>
+<a name="l00205"></a>00205
+<a name="l00206"></a>00206
+<a name="l00207"></a>00207
</pre></div><div id="footer">
<p class="apache">
Copyright © 2003-2005 <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.2 on 4 May 2005</span>
+version 1.4.3-20050530 on 19 Jul 2005</span>
</p>
"" src="feather.gif" /></div>
-<!-- Generated by Doxygen 1.4.2 -->
+<!-- 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>
<h1>Apache2::Cookie<br>
<small>
@@ -20,9 +20,12 @@
</table>
+
<p><a name="__index__"></a></p>
+
<!-- INDEX BEGIN -->
+
<ul>
<li><a href="#name">NAME</a></li>
@@ -62,84 +65,105 @@
<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>Apache2::Cookie, Apache2::Cookie::Jar - H</div>
</body>
TTP Cookies Class</p>
+
<p>
+
</p>
<hr />
+
<h1><a name="synopsis">SYNOPSIS</a></h1>
+
<pre>
use Apache2::Cookie;</pre>
+
<pre>
$j = Apache2::Cookie::Jar->new($r);
$c_in = $j->cookies("foo"); # get cookie from request headers</pre>
+
<pre>
$c_out = Apache2::Cookie->new($r,
-name => "mycookie",
-value => $c_in->name );</pre>
+
<pre>
$c_out->path("/bar"); # set path to "/bar"
$c_out->bake; # send cookie in response headers</pre>
+
<p>
+
</p>
<hr />
+
<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
below for known issues).</p>
+
<p>This manpage documents the Apache2::Cookie and Apache2::Cookie::Jar packages.</p>
+
<p>
+
</p>
<hr />
+
<h1><a name="apache2__cookie__jar">Apache2::Cookie::Jar</a></h1>
+
<p>This class collects Apache2::Cookie objects into a lookup table. It plays
the same role for accessing the incoming cookies as Apache2::Request does for
accessing the incoming params and file uploads.</p>
+
<p>
+
</p>
+
<h2><a name="new">new</a></h2>
+
<pre>
- Apache2::Cookie::Jar->new($env, %args)</pre>
+ Apache2::Cookie::Jar->new($env)</pre>
+
<p>Class method that retrieves the parsed cookie jar from the current
-environment. An optional VALUE_CLASS => $class argument instructs
-the jar to bless any returned cookies into $class instead
-of Apache2::Cookie. This feature is meant to be useful in situations
-where <code>Apache2::Cookie::thaw()</code> is unable to correctly interpret an incoming
-cookie's serialization. Users can simply override <code>thaw</code> in an
-application-specific subclass and pass that subclass's name as the
-VALUE_CLASS argument:</p>
-<pre>
- {
- package FOO;
- @ISA= 'Apache2::Cookie';
- }
- my $jar = Apache2::Cookie::Jar->new($r, VALUE_CLASS => "FOO");
- ok $jar->cookies("foo")->isa("FOO");
- ok $jar->cookies->{bar}->isa("FOO");</pre>
+environment.</p>
+
<p>
+
</p>
+
<h2><a name="cookies">cookies</a></h2>
+
<pre>
$jar->cookies()
$jar->cookies($key)</pre>
+
<p>Retrieve cookies named $key with from the jar object. In scalar
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
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
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
the returned <code>value(s)</code> could be unreliable. In particular, note that
<code>scalar $jar->cookies("foo")</code> will not croak if it can locate
@@ -148,37 +172,46 @@
as they appeared in the ``Cookie'' header). In all other circumstances
<code>cookies</code> will croak if the parser failed to successfully parse the
``Cookie'' header.</p>
+
<pre>
$c = Apache2::Cookie->new($r, name => "foo", value => 3);
$j->cookies->add($c);</pre>
+
<pre>
$cookie = $j->cookies("foo"); # first foo cookie
@cookies = $j->cookies("foo"); # all foo cookies
@names = $j->cookies(); # all cookie names</pre>
+
<p>
+
</p>
+
<h2><a name="status">status</a></h2>
+
<pre>
- $jar->status()
- $jar->status($set)</pre>
-<p>Get or set the <em>APR</em> status code of the cookie parser:
+ $jar->status()</pre>
+
+<p>Get the <em>APR</em> status code of the cookie parser:
APR_SUCCESS on success, error otherwise.</p>
-<pre>
- $j->status(-1);
- ok $j->status == -1;
- eval { @cookies = $j->cookies("foo") }; # croaks
- ok $@->isa("Apache2::Cookie::Jar::Error");
- $j->status(0);</pre>
+
<p>
+
</p>
<hr />
+
<h1><a name="apache2__cookie">Apache2::Cookie</a></h1>
+
<p>
+
</p>
+
<h2><a name="new">new</a></h2>
+
<pre>
Apache2::Cookie->new($env, %args)</pre>
+
<p>Just like CGI::Cookie::new, but requires an additional environment argument:</p>
+
<pre>
$cookie = Apache2::Cookie->new($r,
-name => 'foo',
@@ -188,216 +221,357 @@
-path => '/cgi-bin/database',
-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
cookie's raw value.</p>
+
<p>
+
</p>
+
<h2><a name="freeze">freeze</a></h2>
+
<pre>
Apache2::Cookie->freeze($value)</pre>
+
<p>Helper function (for <code>new</code>) that serializes a new cookie's value in a
manner compatible with CGI::Cookie (and Apache2::Cookie 1.X). This class
method accepts an arrayref, hashref, or normal perl string in $value.</p>
+
<pre>
$value = Apache2::Cookie->freeze(["2+2", "=4"]);</pre>
+
<p>
+
</p>
+
<h2><a name="thaw">thaw</a></h2>
+
<pre>
Apache2::Cookie->thaw($value)
$cookie->thaw()</pre>
+
<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
values created using CGI::Cookie or Apache2::Cookie 1.X.</p>
+
<pre>
print $cookie->thaw; # prints "bar"
@values = Apache2::Cookie->thaw($value); # ( "2+2", "=4" )</pre>
+
<p>
+
</p>
+
<h2><a name="as_string">as_string</a></h2>
+
<pre>
$cookie->as_string()</pre>
+
<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>
ok "$cookie" eq $cookie->as_string;</pre>
+
<p>
+
</p>
+
<h2><a name="name">name</a></h2>
+
<pre>
$cookie->name()</pre>
+
<p>Get the name of the cookie.</p>
+
<p>
+
</p>
+
<h2><a name="value">value</a></h2>
+
<pre>
$cookie->value()</pre>
+
<p>Get the (unswizzled) value of the cookie:</p>
+
<pre>
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
Apache2::Cookie with a package that provides the associated <code>thaw</code> sub:</p>
+
<pre>
{
package My::COOKIE;
@ISA = 'Apache2::Cookie';
sub thaw { my $val = shift->raw_value; $val =~ tr/a-z/A-Z/; $val }
}</pre>
+
<pre>
bless $cookie, "My::COOKIE";</pre>
+
<pre>
ok $cookie->value eq "BAR";</pre>
+
<p>
+
</p>
+
<h2><a name="raw_value">raw_value</a></h2>
+
<pre>
$cookie->raw_value()</pre>
+
<p>Gets the raw (opaque) value string as it appears in the incoming
``Cookie'' header.</p>
+
<pre>
ok $cookie->raw_value eq "bar";</pre>
+
<p>
+
</p>
+
<h2><a name="bake">bake</a></h2>
+
<pre>
$cookie->bake($r)</pre>
+
<p>Adds a <em>Set-Cookie</em> header to the outgoing headers table.</p>
+
<p>
+
</p>
+
<h2><a name="bake2">bake2</a></h2>
+
<pre>
$cookie->bake2($r)</pre>
+
<p>Adds a <em>Set-Cookie2</em> header to the outgoing headers table.</p>
+
<p>
+
</p>
+
<h2><a name="domain">domain</a></h2>
+
<pre>
$cookie->domain()
$cookie->domain($set)</pre>
+
<p>Get or set the domain for the cookie:</p>
+
<pre>
$domain = $cookie->domain;
$cookie->domain(".cp.net");</pre>
+
<p>
+
</p>
+
<h2><a name="path">path</a></h2>
+
<pre>
$cookie->path()
$cookie->path($set)</pre>
+
<p>Get or set the path for the cookie:</p>
+
<pre>
$path = $cookie->path;
$cookie->path("/");</pre>
+
<p>
+
</p>
+
<h2><a name="version">version</a></h2>
+
<pre>
$cookie->version()
$cookie->version($set)</pre>
+
<p>Get or set the cookie version for this cookie.
Netscape spec cookies have version = 0;
RFC-compliant cookies have version = 1.</p>
+
<pre>
ok $cookie->version == 0;
$cookie->version(1);
ok $cookie->version == 1;</pre>
+
<p>
+
</p>
+
<h2><a name="expires">expires</a></h2>
+
<pre>
$cookie->expires()
$cookie->expires($set)</pre>
+
<p>Get or set the future expire time for the cookie. When
assigning, the new value ($set) should match /^\+?(\d+)([YMDhms]?)$/
$2 qualifies the number in $1 as representing ``Y''ears, ``M''onths,
``D''ays, ``h''ours, ``m''inutes, or ``s''econds (if the qualifier is
omitted, the number is interpreted as representing seconds).
As a special case, $set = ``now'' is equivalent to $set = ``0''.</p>
+
<pre>
my $expires = $cookie->expires;
$cookie->expires("+3h"); # cookie is set to expire in 3 hours</pre>
+
<p>
+
</p>
+
<h2><a name="secure">secure</a></h2>
+
<pre>
$cookie->secure()
$cookie->secure($set)</pre>
+
<p>Get or set the secure flag for the cookie:</p>
+
<pre>
$cookie->secure(1);
$is_secure = $cookie->secure;
$cookie->secure(0);</pre>
+
<p>
+
</p>
+
<h2><a name="comment">comment</a></h2>
+
<pre>
$cookie->comment()
$cookie->comment($set)</pre>
+
<p>Get or set the comment field of an RFC (Version > 0) cookie.</p>
+
<pre>
$cookie->comment("Never eat yellow snow");
print $cookie->comment;</pre>
+
<p>
+
</p>
+
<h2><a name="commenturl">commentURL</a></h2>
+
<pre>
$cookie->commentURL()
$cookie->commentURL($set)</pre>
+
<p>Get or set the commentURL field of an RFC (Version > 0) cookie.</p>
+
<pre>
$cookie->commentURL("<a href="http://localhost/cookie.policy"">http://localhost/cookie.policy"</a>;);
print $cookie->commentURL;</pre>
+
<p>
+
</p>
+
<h2><a name="fetch">fetch</a></h2>
+
<pre>
Apache2::Cookie->fetch($r)</pre>
+
<p>Fetch and parse the incoming <em>Cookie</em> header:</p>
+
<pre>
my $cookies = Apache2::Cookie->fetch($r); # APR::Request::Cookie::Table ref</pre>
+
<pre>
my %cookies = Apache2::Cookie->fetch($r);</pre>
+
<p>
+
</p>
<hr />
+
<h1><a name="porting_from_1_x">PORTING from 1.X</a></h1>
+
<p>Changes to the 1.X API:</p>
+
<ul>
-<li><strong><a name="item_as"><code>Apache2::Cookie::fetch</code> now expects an <code>$r</code> object as (second)
+
+<li>
+<strong>
+<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.</a>
+</strong><br />
+
</li>
-<li><strong><a name="item_apache2_3a_3acookie_3a_3aparse_is_gone_2e"><code>Apache2::Cookie::parse</code> is gone.</a></strong><br />
+
+
+<li>
+<strong>
+<a name="item_apache2_3a_3acookie_3a_3aparse_is_gone_2e"><code>Apache2::Cookie::parse</code> is gone.</a>
+</strong><br />
+
</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 />
+
+
+<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 />
+
</li>
-<li><strong><a name="item_name"><code>name()</code> and <code>value()</code> no longer accept a ``set'' argument. In other words,
+
+
+<li>
+<strong>
+<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 />
+ should be made instead.</a>
+</strong><br />
+
</li>
+
+
</ul>
+
+
<p>
+
</p>
<hr />
+
<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>
+
</p>
<hr />
+
<h1><a name="copyright">COPYRIGHT</a></h1>
+
<pre>
Copyright 2003-2005 The Apache Software Foundation</pre>
+
<pre>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at</pre>
+
<pre>
<a href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></pre>
+
<pre>
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
@@ -405,13 +579,14 @@
See the License for the specific language governing permissions and
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/>
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.2 on 4 May 2005</span>
+version 1.4.3-20050530 on 19 Jul 2005</span>
</p>
</div>
</body>