Debian Codegraph @

docs/html/apreq__module_8h.html

raw
1 <html>
2 <head>
3 <link rel="stylesheet" type="text/css" href="dox.css" />
4 <title>libapreq2-2.17: include/apreq_module.h File Reference</title>
5 </head>
6 <body>
7 <div id="page-header">
8 <p class="menu">
9 <a href="http://www.apache.org/">Apache Software Foundation</a> &gt; <a href="http://httpd.apache.org">HTTP Server Project</a> &gt;
10 <a href="http://httpd.apache.org/apreq/">Request Library Subproject</a></p>
11 <p class="apache">Apache HTTP Server Request Library</p>
12 <img alt="" src="feather.gif" /></div>
13 <!-- Generated by Doxygen 1.9.1 -->
14 <script type="text/javascript" src="menudata.js"></script>
15 <script type="text/javascript" src="menu.js"></script>
16 <script type="text/javascript">
17 /* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
18 $(function() {
19 initMenu('',false,false,'search.php','Search');
20 });
21 /* @license-end */</script>
22 <div id="main-nav"></div>
23 <div id="nav-path" class="navpath">
24 <ul>
25 <li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li> </ul>
26 </div>
27 </div><!-- top -->
28 <div class="header">
29 <div class="summary">
30 <a href="#nested-classes">Data Structures</a> &#124;
31 <a href="#define-members">Macros</a> &#124;
32 <a href="#typedef-members">Typedefs</a> &#124;
33 <a href="#func-members">Functions</a> </div>
34 <div class="headertitle">
35 <div class="title">apreq_module.h File Reference<div class="ingroups"><a class="el" href="group__libapreq2.html">Apache Request Library</a></div></div> </div>
36 </div><!--header-->
37 <div class="contents">
38
39 <p>Module API.
40 <a href="#details">More...</a></p>
41 <div class="textblock"><code>#include &quot;<a class="el" href="apreq__cookie_8h_source.html">apreq_cookie.h</a>&quot;</code><br />
42 <code>#include &quot;<a class="el" href="apreq__parser_8h_source.html">apreq_parser.h</a>&quot;</code><br />
43 <code>#include &quot;<a class="el" href="apreq__error_8h_source.html">apreq_error.h</a>&quot;</code><br />
44 </div>
45 <p><a href="apreq__module_8h_source.html">Go to the source code of this file.</a></p>
46 <table class="memberdecls">
47 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
48 Data Structures</h2></td></tr>
49 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a></td></tr>
50 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
51 <tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structapreq__module__t.html">apreq_module_t</a></td></tr>
52 <tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vtable describing the necessary module functions. <a href="structapreq__module__t.html#details">More...</a><br /></td></tr>
53 <tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
54 </table><table class="memberdecls">
55 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
56 Macros</h2></td></tr>
57 <tr class="memitem:a7d6d0550f527e18c8cfab702e65daf3b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a7d6d0550f527e18c8cfab702e65daf3b">APREQ_MODULE</a>(pre, mmn)</td></tr>
58 <tr class="separator:a7d6d0550f527e18c8cfab702e65daf3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
59 <tr class="memitem:a5b5398d109fb933fb0367ef947e7c7b6"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a5b5398d109fb933fb0367ef947e7c7b6">apreq_cookie</a>(req, name)&#160;&#160;&#160;<a class="el" href="apreq__module_8h.html#a63dfa7b7b303d061fe56c7109528d430">apreq_jar_get</a>(req, name)</td></tr>
60 <tr class="separator:a5b5398d109fb933fb0367ef947e7c7b6"><td class="memSeparator" colspan="2">&#160;</td></tr>
61 </table><table class="memberdecls">
62 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
63 Typedefs</h2></td></tr>
64 <tr class="memitem:acc662f2b62f1d13f6c9e03536f565952"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="structapreq__handle__t.html">apreq_handle_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#acc662f2b62f1d13f6c9e03536f565952">apreq_handle_t</a></td></tr>
65 <tr class="separator:acc662f2b62f1d13f6c9e03536f565952"><td class="memSeparator" colspan="2">&#160;</td></tr>
66 <tr class="memitem:ab584b3f1216e609ba8082d081cfb5659"><td class="memItemLeft" align="right" valign="top"><a id="ab584b3f1216e609ba8082d081cfb5659"></a>
67 typedef struct <a class="el" href="structapreq__module__t.html">apreq_module_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#ab584b3f1216e609ba8082d081cfb5659">apreq_module_t</a></td></tr>
68 <tr class="memdesc:ab584b3f1216e609ba8082d081cfb5659"><td class="mdescLeft">&#160;</td><td class="mdescRight">Vtable describing the necessary module functions. <br /></td></tr>
69 <tr class="separator:ab584b3f1216e609ba8082d081cfb5659"><td class="memSeparator" colspan="2">&#160;</td></tr>
70 </table><table class="memberdecls">
71 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
72 Functions</h2></td></tr>
73 <tr class="memitem:a08dedd0ec5b291dad6b58644896eb2ed"><td class="memItemLeft" align="right" valign="top">static APR_INLINE unsigned&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a08dedd0ec5b291dad6b58644896eb2ed">apreq_module_status_is_error</a> (apr_status_t s)</td></tr>
74 <tr class="separator:a08dedd0ec5b291dad6b58644896eb2ed"><td class="memSeparator" colspan="2">&#160;</td></tr>
75 <tr class="memitem:a2652c9a9b0e0f4162051fc3904ac480a"><td class="memItemLeft" align="right" valign="top">static APR_INLINE apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a2652c9a9b0e0f4162051fc3904ac480a">apreq_jar</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, const apr_table_t **t)</td></tr>
76 <tr class="separator:a2652c9a9b0e0f4162051fc3904ac480a"><td class="memSeparator" colspan="2">&#160;</td></tr>
77 <tr class="memitem:ade74830e449fa5bb24694ffc3b8374ca"><td class="memItemLeft" align="right" valign="top">static APR_INLINE apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#ade74830e449fa5bb24694ffc3b8374ca">apreq_args</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, const apr_table_t **t)</td></tr>
78 <tr class="separator:ade74830e449fa5bb24694ffc3b8374ca"><td class="memSeparator" colspan="2">&#160;</td></tr>
79 <tr class="memitem:ae928689622d094025a8efb8c6c17d680"><td class="memItemLeft" align="right" valign="top">static APR_INLINE apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#ae928689622d094025a8efb8c6c17d680">apreq_body</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, const apr_table_t **t)</td></tr>
80 <tr class="separator:ae928689622d094025a8efb8c6c17d680"><td class="memSeparator" colspan="2">&#160;</td></tr>
81 <tr class="memitem:a63dfa7b7b303d061fe56c7109528d430"><td class="memItemLeft" align="right" valign="top">static APR_INLINE <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a63dfa7b7b303d061fe56c7109528d430">apreq_jar_get</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, const char *name)</td></tr>
82 <tr class="separator:a63dfa7b7b303d061fe56c7109528d430"><td class="memSeparator" colspan="2">&#160;</td></tr>
83 <tr class="memitem:aeadd074ee9dd8095d857820ce15f1701"><td class="memItemLeft" align="right" valign="top">static APR_INLINE <a class="el" href="structapreq__param__t.html">apreq_param_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#aeadd074ee9dd8095d857820ce15f1701">apreq_args_get</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, const char *name)</td></tr>
84 <tr class="separator:aeadd074ee9dd8095d857820ce15f1701"><td class="memSeparator" colspan="2">&#160;</td></tr>
85 <tr class="memitem:a7c4cb1c2b91f5539b2231d09ebea2239"><td class="memItemLeft" align="right" valign="top">static APR_INLINE <a class="el" href="structapreq__param__t.html">apreq_param_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a7c4cb1c2b91f5539b2231d09ebea2239">apreq_body_get</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, const char *name)</td></tr>
86 <tr class="separator:a7c4cb1c2b91f5539b2231d09ebea2239"><td class="memSeparator" colspan="2">&#160;</td></tr>
87 <tr class="memitem:a136584883dac2b5c76052bed1c4e61dc"><td class="memItemLeft" align="right" valign="top">static APR_INLINE apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a136584883dac2b5c76052bed1c4e61dc">apreq_parser_get</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, const <a class="el" href="structapreq__parser__t.html">apreq_parser_t</a> **parser)</td></tr>
88 <tr class="separator:a136584883dac2b5c76052bed1c4e61dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
89 <tr class="memitem:a6842f8b5a1d1f9115ba8ff7b1da1e78b"><td class="memItemLeft" align="right" valign="top">static APR_INLINE apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a6842f8b5a1d1f9115ba8ff7b1da1e78b">apreq_parser_set</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, <a class="el" href="structapreq__parser__t.html">apreq_parser_t</a> *parser)</td></tr>
90 <tr class="separator:a6842f8b5a1d1f9115ba8ff7b1da1e78b"><td class="memSeparator" colspan="2">&#160;</td></tr>
91 <tr class="memitem:a0c24fc39ad03c54839a9cb03dc00dc28"><td class="memItemLeft" align="right" valign="top">static APR_INLINE apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a0c24fc39ad03c54839a9cb03dc00dc28">apreq_hook_add</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, <a class="el" href="structapreq__hook__t.html">apreq_hook_t</a> *hook)</td></tr>
92 <tr class="separator:a0c24fc39ad03c54839a9cb03dc00dc28"><td class="memSeparator" colspan="2">&#160;</td></tr>
93 <tr class="memitem:ab368191aa61cd0386e824c1a6dbd6e49"><td class="memItemLeft" align="right" valign="top">static APR_INLINE apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#ab368191aa61cd0386e824c1a6dbd6e49">apreq_brigade_limit_set</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, apr_size_t bytes)</td></tr>
94 <tr class="separator:ab368191aa61cd0386e824c1a6dbd6e49"><td class="memSeparator" colspan="2">&#160;</td></tr>
95 <tr class="memitem:ad98e3dac181ac837159581812229d8e3"><td class="memItemLeft" align="right" valign="top">static APR_INLINE apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#ad98e3dac181ac837159581812229d8e3">apreq_brigade_limit_get</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, apr_size_t *bytes)</td></tr>
96 <tr class="separator:ad98e3dac181ac837159581812229d8e3"><td class="memSeparator" colspan="2">&#160;</td></tr>
97 <tr class="memitem:a97d4d8090e7847ace598c7a65b309564"><td class="memItemLeft" align="right" valign="top">static APR_INLINE apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a97d4d8090e7847ace598c7a65b309564">apreq_read_limit_set</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, apr_uint64_t bytes)</td></tr>
98 <tr class="separator:a97d4d8090e7847ace598c7a65b309564"><td class="memSeparator" colspan="2">&#160;</td></tr>
99 <tr class="memitem:ab5cc462231ee5e4389ceb46eab1e456f"><td class="memItemLeft" align="right" valign="top">static APR_INLINE apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#ab5cc462231ee5e4389ceb46eab1e456f">apreq_read_limit_get</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, apr_uint64_t *bytes)</td></tr>
100 <tr class="separator:ab5cc462231ee5e4389ceb46eab1e456f"><td class="memSeparator" colspan="2">&#160;</td></tr>
101 <tr class="memitem:afc1b7d33062581140fd16b859b06d24a"><td class="memItemLeft" align="right" valign="top">static APR_INLINE apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#afc1b7d33062581140fd16b859b06d24a">apreq_temp_dir_set</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, const char *path)</td></tr>
102 <tr class="separator:afc1b7d33062581140fd16b859b06d24a"><td class="memSeparator" colspan="2">&#160;</td></tr>
103 <tr class="memitem:a51c4bd2bc98e9355f8595341ba6aff0b"><td class="memItemLeft" align="right" valign="top">static APR_INLINE apr_status_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a51c4bd2bc98e9355f8595341ba6aff0b">apreq_temp_dir_get</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, const char **path)</td></tr>
104 <tr class="separator:a51c4bd2bc98e9355f8595341ba6aff0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
105 <tr class="memitem:a3f9b9c725672298c86b081aaa258fbdc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a3f9b9c725672298c86b081aaa258fbdc">apreq_handle_cgi</a> (apr_pool_t *pool)</td></tr>
106 <tr class="separator:a3f9b9c725672298c86b081aaa258fbdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
107 <tr class="memitem:abeaaad6c03b54ca963f9f14a3031e912"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#abeaaad6c03b54ca963f9f14a3031e912">apreq_handle_custom</a> (apr_pool_t *pool, const char *query_string, const char *cookie, <a class="el" href="structapreq__parser__t.html">apreq_parser_t</a> *parser, apr_uint64_t read_limit, apr_bucket_brigade *in)</td></tr>
108 <tr class="separator:abeaaad6c03b54ca963f9f14a3031e912"><td class="memSeparator" colspan="2">&#160;</td></tr>
109 <tr class="memitem:a08c59b5f07fb36080bb4d62e68bfeddf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structapreq__param__t.html">apreq_param_t</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a08c59b5f07fb36080bb4d62e68bfeddf">apreq_param</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, const char *key)</td></tr>
110 <tr class="separator:a08c59b5f07fb36080bb4d62e68bfeddf"><td class="memSeparator" colspan="2">&#160;</td></tr>
111 <tr class="memitem:a0dff48fd4e83399a07853abe9d67c251"><td class="memItemLeft" align="right" valign="top">apr_table_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a0dff48fd4e83399a07853abe9d67c251">apreq_params</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, apr_pool_t *p)</td></tr>
112 <tr class="separator:a0dff48fd4e83399a07853abe9d67c251"><td class="memSeparator" colspan="2">&#160;</td></tr>
113 <tr class="memitem:a7435376b1f543c604d8326de3157e075"><td class="memItemLeft" align="right" valign="top">apr_table_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="apreq__module_8h.html#a7435376b1f543c604d8326de3157e075">apreq_cookies</a> (<a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *req, apr_pool_t *p)</td></tr>
114 <tr class="separator:a7435376b1f543c604d8326de3157e075"><td class="memSeparator" colspan="2">&#160;</td></tr>
115 </table>
116 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
117 <div class="textblock"><p>Module API. </p>
118 </div><h2 class="groupheader">Macro Definition Documentation</h2>
119 <a id="a5b5398d109fb933fb0367ef947e7c7b6"></a>
120 <h2 class="memtitle"><span class="permalink"><a href="#a5b5398d109fb933fb0367ef947e7c7b6">&#9670;&nbsp;</a></span>apreq_cookie</h2>
121
122 <div class="memitem">
123 <div class="memproto">
124 <table class="memname">
125 <tr>
126 <td class="memname">#define apreq_cookie</td>
127 <td>(</td>
128 <td class="paramtype">&#160;</td>
129 <td class="paramname">req, </td>
130 </tr>
131 <tr>
132 <td class="paramkey"></td>
133 <td></td>
134 <td class="paramtype">&#160;</td>
135 <td class="paramname">name&#160;</td>
136 </tr>
137 <tr>
138 <td></td>
139 <td>)</td>
140 <td></td><td>&#160;&#160;&#160;<a class="el" href="apreq__module_8h.html#a63dfa7b7b303d061fe56c7109528d430">apreq_jar_get</a>(req, name)</td>
141 </tr>
142 </table>
143 </div><div class="memdoc">
144 <p>Find the first cookie with the specified name. The match is case-insensitive.</p>
145 <dl class="params"><dt>Parameters</dt><dd>
146 <table class="params">
147 <tr><td class="paramname">req</td><td>request handle. </td></tr>
148 <tr><td class="paramname">name</td><td>desired cookie name</td></tr>
149 </table>
150 </dd>
151 </dl>
152 <dl class="section return"><dt>Returns</dt><dd>The first matching cookie or NULL. </dd></dl>
153
154 </div>
155 </div>
156 <a id="a7d6d0550f527e18c8cfab702e65daf3b"></a>
157 <h2 class="memtitle"><span class="permalink"><a href="#a7d6d0550f527e18c8cfab702e65daf3b">&#9670;&nbsp;</a></span>APREQ_MODULE</h2>
158
159 <div class="memitem">
160 <div class="memproto">
161 <table class="memname">
162 <tr>
163 <td class="memname">#define APREQ_MODULE</td>
164 <td>(</td>
165 <td class="paramtype">&#160;</td>
166 <td class="paramname">pre, </td>
167 </tr>
168 <tr>
169 <td class="paramkey"></td>
170 <td></td>
171 <td class="paramtype">&#160;</td>
172 <td class="paramname">mmn&#160;</td>
173 </tr>
174 <tr>
175 <td></td>
176 <td>)</td>
177 <td></td><td></td>
178 </tr>
179 </table>
180 </div><div class="memdoc">
181 <b>Value:</b><div class="fragment"><div class="line"> <span class="keyword">const</span> apreq_module_t \</div>
182 <div class="line"> pre##_module = { #pre, mmn, \</div>
183 <div class="line"> pre##_jar, pre##_args, pre##_body, \</div>
184 <div class="line"> pre##_jar_get, pre##_args_get, pre##_body_get, \</div>
185 <div class="line"> pre##_parser_get, pre##_parser_set, pre##_hook_add, \</div>
186 <div class="line"> pre##_brigade_limit_get, pre##_brigade_limit_set, \</div>
187 <div class="line"> pre##_read_limit_get, pre##_read_limit_set, \</div>
188 <div class="line"> pre##_temp_dir_get, pre##_temp_dir_set, \</div>
189 <div class="line"> }</div>
190 </div><!-- fragment --><p>Convenience macro for defining a module by mapping a function prefix to an associated <a class="el" href="structapreq__module__t.html" title="Vtable describing the necessary module functions.">apreq_module_t</a> structure.</p>
191 <dl class="params"><dt>Parameters</dt><dd>
192 <table class="params">
193 <tr><td class="paramname">pre</td><td>Prefix to define new module. All attributes of the <a class="el" href="structapreq__module__t.html" title="Vtable describing the necessary module functions.">apreq_module_t</a> struct are defined with this as their prefix. The generated struct is named by appending "_module" to the prefix. </td></tr>
194 <tr><td class="paramname">mmn</td><td>Magic number (i.e. version number) of this module. </td></tr>
195 </table>
196 </dd>
197 </dl>
198
199 </div>
200 </div>
201 <h2 class="groupheader">Typedef Documentation</h2>
202 <a id="acc662f2b62f1d13f6c9e03536f565952"></a>
203 <h2 class="memtitle"><span class="permalink"><a href="#acc662f2b62f1d13f6c9e03536f565952">&#9670;&nbsp;</a></span>apreq_handle_t</h2>
204
205 <div class="memitem">
206 <div class="memproto">
207 <table class="memname">
208 <tr>
209 <td class="memname">typedef struct <a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> <a class="el" href="structapreq__handle__t.html">apreq_handle_t</a></td>
210 </tr>
211 </table>
212 </div><div class="memdoc">
213 <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. </p>
214
215 </div>
216 </div>
217 <h2 class="groupheader">Function Documentation</h2>
218 <a id="ade74830e449fa5bb24694ffc3b8374ca"></a>
219 <h2 class="memtitle"><span class="permalink"><a href="#ade74830e449fa5bb24694ffc3b8374ca">&#9670;&nbsp;</a></span>apreq_args()</h2>
220
221 <div class="memitem">
222 <div class="memproto">
223 <table class="mlabels">
224 <tr>
225 <td class="mlabels-left">
226 <table class="memname">
227 <tr>
228 <td class="memname">static APR_INLINE apr_status_t apreq_args </td>
229 <td>(</td>
230 <td class="paramtype"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *&#160;</td>
231 <td class="paramname"><em>req</em>, </td>
232 </tr>
233 <tr>
234 <td class="paramkey"></td>
235 <td></td>
236 <td class="paramtype">const apr_table_t **&#160;</td>
237 <td class="paramname"><em>t</em>&#160;</td>
238 </tr>
239 <tr>
240 <td></td>
241 <td>)</td>
242 <td></td><td></td>
243 </tr>
244 </table>
245 </td>
246 <td class="mlabels-right">
247 <span class="mlabels"><span class="mlabel">static</span></span> </td>
248 </tr>
249 </table>
250 </div><div class="memdoc">
251 <p>Expose the parsed "query string" associated to this handle.</p>
252 <dl class="params"><dt>Parameters</dt><dd>
253 <table class="params">
254 <tr><td class="paramname">req</td><td>The request handle </td></tr>
255 <tr><td class="paramname">t</td><td>The resulting table, which will either be NULL or a valid table object on return.</td></tr>
256 </table>
257 </dd>
258 </dl>
259 <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS or a module-specific error status code. </dd></dl>
260
261 </div>
262 </div>
263 <a id="aeadd074ee9dd8095d857820ce15f1701"></a>
264 <h2 class="memtitle"><span class="permalink"><a href="#aeadd074ee9dd8095d857820ce15f1701">&#9670;&nbsp;</a></span>apreq_args_get()</h2>
265
266 <div class="memitem">
267 <div class="memproto">
268 <table class="mlabels">
269 <tr>
270 <td class="mlabels-left">
271 <table class="memname">
272 <tr>
273 <td class="memname">static APR_INLINE <a class="el" href="structapreq__param__t.html">apreq_param_t</a>* apreq_args_get </td>
274 <td>(</td>
275 <td class="paramtype"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *&#160;</td>
276 <td class="paramname"><em>req</em>, </td>
277 </tr>
278 <tr>
279 <td class="paramkey"></td>
280 <td></td>
281 <td class="paramtype">const char *&#160;</td>
282 <td class="paramname"><em>name</em>&#160;</td>
283 </tr>
284 <tr>
285 <td></td>
286 <td>)</td>
287 <td></td><td></td>
288 </tr>
289 </table>
290 </td>
291 <td class="mlabels-right">
292 <span class="mlabels"><span class="mlabel">static</span></span> </td>
293 </tr>
294 </table>
295 </div><div class="memdoc">
296 <p>Fetch the first query string param with the given name.</p>
297 <dl class="params"><dt>Parameters</dt><dd>
298 <table class="params">
299 <tr><td class="paramname">req</td><td>The request handle </td></tr>
300 <tr><td class="paramname">name</td><td>Case-insensitive param name.</td></tr>
301 </table>
302 </dd>
303 </dl>
304 <dl class="section return"><dt>Returns</dt><dd>First matching param, or NULL if none match. </dd></dl>
305
306 </div>
307 </div>
308 <a id="ae928689622d094025a8efb8c6c17d680"></a>
309 <h2 class="memtitle"><span class="permalink"><a href="#ae928689622d094025a8efb8c6c17d680">&#9670;&nbsp;</a></span>apreq_body()</h2>
310
311 <div class="memitem">
312 <div class="memproto">
313 <table class="mlabels">
314 <tr>
315 <td class="mlabels-left">
316 <table class="memname">
317 <tr>
318 <td class="memname">static APR_INLINE apr_status_t apreq_body </td>
319 <td>(</td>
320 <td class="paramtype"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *&#160;</td>
321 <td class="paramname"><em>req</em>, </td>
322 </tr>
323 <tr>
324 <td class="paramkey"></td>
325 <td></td>
326 <td class="paramtype">const apr_table_t **&#160;</td>
327 <td class="paramname"><em>t</em>&#160;</td>
328 </tr>
329 <tr>
330 <td></td>
331 <td>)</td>
332 <td></td><td></td>
333 </tr>
334 </table>
335 </td>
336 <td class="mlabels-right">
337 <span class="mlabels"><span class="mlabel">static</span></span> </td>
338 </tr>
339 </table>
340 </div><div class="memdoc">
341 <p>Expose the parsed "request body" associated to this handle.</p>
342 <dl class="params"><dt>Parameters</dt><dd>
343 <table class="params">
344 <tr><td class="paramname">req</td><td>The request handle </td></tr>
345 <tr><td class="paramname">t</td><td>The resulting table, which will either be NULL or a valid table object on return.</td></tr>
346 </table>
347 </dd>
348 </dl>
349 <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS or a module-specific error status code. </dd></dl>
350
351 </div>
352 </div>
353 <a id="a7c4cb1c2b91f5539b2231d09ebea2239"></a>
354 <h2 class="memtitle"><span class="permalink"><a href="#a7c4cb1c2b91f5539b2231d09ebea2239">&#9670;&nbsp;</a></span>apreq_body_get()</h2>
355
356 <div class="memitem">
357 <div class="memproto">
358 <table class="mlabels">
359 <tr>
360 <td class="mlabels-left">
361 <table class="memname">
362 <tr>
363 <td class="memname">static APR_INLINE <a class="el" href="structapreq__param__t.html">apreq_param_t</a>* apreq_body_get </td>
364 <td>(</td>
365 <td class="paramtype"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *&#160;</td>
366 <td class="paramname"><em>req</em>, </td>
367 </tr>
368 <tr>
369 <td class="paramkey"></td>
370 <td></td>
371 <td class="paramtype">const char *&#160;</td>
372 <td class="paramname"><em>name</em>&#160;</td>
373 </tr>
374 <tr>
375 <td></td>
376 <td>)</td>
377 <td></td><td></td>
378 </tr>
379 </table>
380 </td>
381 <td class="mlabels-right">
382 <span class="mlabels"><span class="mlabel">static</span></span> </td>
383 </tr>
384 </table>
385 </div><div class="memdoc">
386 <p>Fetch the first body param with the given name.</p>
387 <dl class="params"><dt>Parameters</dt><dd>
388 <table class="params">
389 <tr><td class="paramname">req</td><td>The request handle </td></tr>
390 <tr><td class="paramname">name</td><td>Case-insensitive cookie name.</td></tr>
391 </table>
392 </dd>
393 </dl>
394 <dl class="section return"><dt>Returns</dt><dd>First matching param, or NULL if none match. </dd></dl>
395
396 </div>
397 </div>
398 <a id="ad98e3dac181ac837159581812229d8e3"></a>
399 <h2 class="memtitle"><span class="permalink"><a href="#ad98e3dac181ac837159581812229d8e3">&#9670;&nbsp;</a></span>apreq_brigade_limit_get()</h2>
400
401 <div class="memitem">
402 <div class="memproto">
403 <table class="mlabels">
404 <tr>
405 <td class="mlabels-left">
406 <table class="memname">
407 <tr>
408 <td class="memname">static APR_INLINE apr_status_t apreq_brigade_limit_get </td>
409 <td>(</td>
410 <td class="paramtype"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *&#160;</td>
411 <td class="paramname"><em>req</em>, </td>
412 </tr>
413 <tr>
414 <td class="paramkey"></td>
415 <td></td>
416 <td class="paramtype">apr_size_t *&#160;</td>
417 <td class="paramname"><em>bytes</em>&#160;</td>
418 </tr>
419 <tr>
420 <td></td>
421 <td>)</td>
422 <td></td><td></td>
423 </tr>
424 </table>
425 </td>
426 <td class="mlabels-right">
427 <span class="mlabels"><span class="mlabel">static</span></span> </td>
428 </tr>
429 </table>
430 </div><div class="memdoc">
431 <p>Get the active brigade limit.</p>
432 <dl class="params"><dt>Parameters</dt><dd>
433 <table class="params">
434 <tr><td class="paramname">req</td><td>The handle. </td></tr>
435 <tr><td class="paramname">bytes</td><td>Pointer to resulting (current) limit.</td></tr>
436 </table>
437 </dd>
438 </dl>
439 <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS or a module-specific error, which may leave bytes undefined. </dd></dl>
440
441 </div>
442 </div>
443 <a id="ab368191aa61cd0386e824c1a6dbd6e49"></a>
444 <h2 class="memtitle"><span class="permalink"><a href="#ab368191aa61cd0386e824c1a6dbd6e49">&#9670;&nbsp;</a></span>apreq_brigade_limit_set()</h2>
445
446 <div class="memitem">
447 <div class="memproto">
448 <table class="mlabels">
449 <tr>
450 <td class="mlabels-left">
451 <table class="memname">
452 <tr>
453 <td class="memname">static APR_INLINE apr_status_t apreq_brigade_limit_set </td>
454 <td>(</td>
455 <td class="paramtype"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *&#160;</td>
456 <td class="paramname"><em>req</em>, </td>
457 </tr>
458 <tr>
459 <td class="paramkey"></td>
460 <td></td>
461 <td class="paramtype">apr_size_t&#160;</td>
462 <td class="paramname"><em>bytes</em>&#160;</td>
463 </tr>
464 <tr>
465 <td></td>
466 <td>)</td>
467 <td></td><td></td>
468 </tr>
469 </table>
470 </td>
471 <td class="mlabels-right">
472 <span class="mlabels"><span class="mlabel">static</span></span> </td>
473 </tr>
474 </table>
475 </div><div class="memdoc">
476 <p>Set the active brigade limit.</p>
477 <dl class="params"><dt>Parameters</dt><dd>
478 <table class="params">
479 <tr><td class="paramname">req</td><td>The handle. </td></tr>
480 <tr><td class="paramname">bytes</td><td>New limit to use.</td></tr>
481 </table>
482 </dd>
483 </dl>
484 <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS or module-specific error. </dd></dl>
485
486 </div>
487 </div>
488 <a id="a7435376b1f543c604d8326de3157e075"></a>
489 <h2 class="memtitle"><span class="permalink"><a href="#a7435376b1f543c604d8326de3157e075">&#9670;&nbsp;</a></span>apreq_cookies()</h2>
490
491 <div class="memitem">
492 <div class="memproto">
493 <table class="memname">
494 <tr>
495 <td class="memname">apr_table_t* apreq_cookies </td>
496 <td>(</td>
497 <td class="paramtype"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *&#160;</td>
498 <td class="paramname"><em>req</em>, </td>
499 </tr>
500 <tr>
501 <td class="paramkey"></td>
502 <td></td>
503 <td class="paramtype">apr_pool_t *&#160;</td>
504 <td class="paramname"><em>p</em>&#160;</td>
505 </tr>
506 <tr>
507 <td></td>
508 <td>)</td>
509 <td></td><td></td>
510 </tr>
511 </table>
512 </div><div class="memdoc">
513 <p>Returns a table containing all request cookies.</p>
514 <dl class="params"><dt>Parameters</dt><dd>
515 <table class="params">
516 <tr><td class="paramname">req</td><td>the apreq request handle </td></tr>
517 <tr><td class="paramname">p</td><td>Allocates the returned table. </td></tr>
518 </table>
519 </dd>
520 </dl>
521
522 </div>
523 </div>
524 <a id="a3f9b9c725672298c86b081aaa258fbdc"></a>
525 <h2 class="memtitle"><span class="permalink"><a href="#a3f9b9c725672298c86b081aaa258fbdc">&#9670;&nbsp;</a></span>apreq_handle_cgi()</h2>
526
527 <div class="memitem">
528 <div class="memproto">
529 <table class="memname">
530 <tr>
531 <td class="memname"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a>* apreq_handle_cgi </td>
532 <td>(</td>
533 <td class="paramtype">apr_pool_t *&#160;</td>
534 <td class="paramname"><em>pool</em></td><td>)</td>
535 <td></td>
536 </tr>
537 </table>
538 </div><div class="memdoc">
539 <p>Create an apreq handle which is suitable for a CGI program. It reads input from stdin and writes output to stdout.</p>
540 <dl class="params"><dt>Parameters</dt><dd>
541 <table class="params">
542 <tr><td class="paramname">pool</td><td>Pool associated to this handle.</td></tr>
543 </table>
544 </dd>
545 </dl>
546 <dl class="section return"><dt>Returns</dt><dd>New handle; can only be NULL if the pool allocation failed.</dd></dl>
547 <dl class="section remark"><dt>Remarks</dt><dd>The handle gets cached in the pool's userdata, so subsequent calls will retrieve the original cached handle. </dd></dl>
548
549 </div>
550 </div>
551 <a id="abeaaad6c03b54ca963f9f14a3031e912"></a>
552 <h2 class="memtitle"><span class="permalink"><a href="#abeaaad6c03b54ca963f9f14a3031e912">&#9670;&nbsp;</a></span>apreq_handle_custom()</h2>
553
554 <div class="memitem">
555 <div class="memproto">
556 <table class="memname">
557 <tr>
558 <td class="memname"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a>* apreq_handle_custom </td>
559 <td>(</td>
560 <td class="paramtype">apr_pool_t *&#160;</td>
561 <td class="paramname"><em>pool</em>, </td>
562 </tr>
563 <tr>
564 <td class="paramkey"></td>
565 <td></td>
566 <td class="paramtype">const char *&#160;</td>
567 <td class="paramname"><em>query_string</em>, </td>
568 </tr>
569 <tr>
570 <td class="paramkey"></td>
571 <td></td>
572 <td class="paramtype">const char *&#160;</td>
573 <td class="paramname"><em>cookie</em>, </td>
574 </tr>
575 <tr>
576 <td class="paramkey"></td>
577 <td></td>
578 <td class="paramtype"><a class="el" href="structapreq__parser__t.html">apreq_parser_t</a> *&#160;</td>
579 <td class="paramname"><em>parser</em>, </td>
580 </tr>
581 <tr>
582 <td class="paramkey"></td>
583 <td></td>
584 <td class="paramtype">apr_uint64_t&#160;</td>
585 <td class="paramname"><em>read_limit</em>, </td>
586 </tr>
587 <tr>
588 <td class="paramkey"></td>
589 <td></td>
590 <td class="paramtype">apr_bucket_brigade *&#160;</td>
591 <td class="paramname"><em>in</em>&#160;</td>
592 </tr>
593 <tr>
594 <td></td>
595 <td>)</td>
596 <td></td><td></td>
597 </tr>
598 </table>
599 </div><div class="memdoc">
600 <p>Create a custom apreq handle which knows only some static values. Useful if you want to test the parser code or if you have got data from a custom source (neither Apache 2 nor CGI).</p>
601 <dl class="params"><dt>Parameters</dt><dd>
602 <table class="params">
603 <tr><td class="paramname">pool</td><td>allocates the parse data, </td></tr>
604 <tr><td class="paramname">query_string</td><td>parsed into args table </td></tr>
605 <tr><td class="paramname">cookie</td><td>value of the request "Cookie" header </td></tr>
606 <tr><td class="paramname">parser</td><td>parses the request body </td></tr>
607 <tr><td class="paramname">read_limit</td><td>maximum bytes to read from the body </td></tr>
608 <tr><td class="paramname">in</td><td>brigade containing the request body</td></tr>
609 </table>
610 </dd>
611 </dl>
612 <dl class="section return"><dt>Returns</dt><dd>new handle; can only be NULL if the pool allocation failed. </dd></dl>
613
614 </div>
615 </div>
616 <a id="a0c24fc39ad03c54839a9cb03dc00dc28"></a>
617 <h2 class="memtitle"><span class="permalink"><a href="#a0c24fc39ad03c54839a9cb03dc00dc28">&#9670;&nbsp;</a></span>apreq_hook_add()</h2>
618
619 <div class="memitem">
620 <div class="memproto">
621 <table class="mlabels">
622 <tr>
623 <td class="mlabels-left">
624 <table class="memname">
625 <tr>
626 <td class="memname">static APR_INLINE apr_status_t apreq_hook_add </td>
627 <td>(</td>
628 <td class="paramtype"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *&#160;</td>
629 <td class="paramname"><em>req</em>, </td>
630 </tr>
631 <tr>
632 <td class="paramkey"></td>
633 <td></td>
634 <td class="paramtype"><a class="el" href="structapreq__hook__t.html">apreq_hook_t</a> *&#160;</td>
635 <td class="paramname"><em>hook</em>&#160;</td>
636 </tr>
637 <tr>
638 <td></td>
639 <td>)</td>
640 <td></td><td></td>
641 </tr>
642 </table>
643 </td>
644 <td class="mlabels-right">
645 <span class="mlabels"><span class="mlabel">static</span></span> </td>
646 </tr>
647 </table>
648 </div><div class="memdoc">
649 <p>Add a parser hook for this request.</p>
650 <dl class="params"><dt>Parameters</dt><dd>
651 <table class="params">
652 <tr><td class="paramname">req</td><td>The request handle </td></tr>
653 <tr><td class="paramname">hook</td><td>Hook to add.</td></tr>
654 </table>
655 </dd>
656 </dl>
657 <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS or module-specific error. </dd></dl>
658
659 </div>
660 </div>
661 <a id="a2652c9a9b0e0f4162051fc3904ac480a"></a>
662 <h2 class="memtitle"><span class="permalink"><a href="#a2652c9a9b0e0f4162051fc3904ac480a">&#9670;&nbsp;</a></span>apreq_jar()</h2>
663
664 <div class="memitem">
665 <div class="memproto">
666 <table class="mlabels">
667 <tr>
668 <td class="mlabels-left">
669 <table class="memname">
670 <tr>
671 <td class="memname">static APR_INLINE apr_status_t apreq_jar </td>
672 <td>(</td>
673 <td class="paramtype"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *&#160;</td>
674 <td class="paramname"><em>req</em>, </td>
675 </tr>
676 <tr>
677 <td class="paramkey"></td>
678 <td></td>
679 <td class="paramtype">const apr_table_t **&#160;</td>
680 <td class="paramname"><em>t</em>&#160;</td>
681 </tr>
682 <tr>
683 <td></td>
684 <td>)</td>
685 <td></td><td></td>
686 </tr>
687 </table>
688 </td>
689 <td class="mlabels-right">
690 <span class="mlabels"><span class="mlabel">static</span></span> </td>
691 </tr>
692 </table>
693 </div><div class="memdoc">
694 <p>Expose the parsed "cookie" header associated to this handle.</p>
695 <dl class="params"><dt>Parameters</dt><dd>
696 <table class="params">
697 <tr><td class="paramname">req</td><td>The request handle </td></tr>
698 <tr><td class="paramname">t</td><td>The resulting table, which will either be NULL or a valid table object on return.</td></tr>
699 </table>
700 </dd>
701 </dl>
702 <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS or a module-specific error status code. </dd></dl>
703
704 </div>
705 </div>
706 <a id="a63dfa7b7b303d061fe56c7109528d430"></a>
707 <h2 class="memtitle"><span class="permalink"><a href="#a63dfa7b7b303d061fe56c7109528d430">&#9670;&nbsp;</a></span>apreq_jar_get()</h2>
708
709 <div class="memitem">
710 <div class="memproto">
711 <table class="mlabels">
712 <tr>
713 <td class="mlabels-left">
714 <table class="memname">
715 <tr>
716 <td class="memname">static APR_INLINE <a class="el" href="structapreq__cookie__t.html">apreq_cookie_t</a>* apreq_jar_get </td>
717 <td>(</td>
718 <td class="paramtype"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *&#160;</td>
719 <td class="paramname"><em>req</em>, </td>
720 </tr>
721 <tr>
722 <td class="paramkey"></td>
723 <td></td>
724 <td class="paramtype">const char *&#160;</td>
725 <td class="paramname"><em>name</em>&#160;</td>
726 </tr>
727 <tr>
728 <td></td>
729 <td>)</td>
730 <td></td><td></td>
731 </tr>
732 </table>
733 </td>
734 <td class="mlabels-right">
735 <span class="mlabels"><span class="mlabel">static</span></span> </td>
736 </tr>
737 </table>
738 </div><div class="memdoc">
739 <p>Fetch the first cookie with the given name.</p>
740 <dl class="params"><dt>Parameters</dt><dd>
741 <table class="params">
742 <tr><td class="paramname">req</td><td>The request handle </td></tr>
743 <tr><td class="paramname">name</td><td>Case-insensitive cookie name.</td></tr>
744 </table>
745 </dd>
746 </dl>
747 <dl class="section return"><dt>Returns</dt><dd>First matching cookie, or NULL if none match. </dd></dl>
748
749 </div>
750 </div>
751 <a id="a08dedd0ec5b291dad6b58644896eb2ed"></a>
752 <h2 class="memtitle"><span class="permalink"><a href="#a08dedd0ec5b291dad6b58644896eb2ed">&#9670;&nbsp;</a></span>apreq_module_status_is_error()</h2>
753
754 <div class="memitem">
755 <div class="memproto">
756 <table class="mlabels">
757 <tr>
758 <td class="mlabels-left">
759 <table class="memname">
760 <tr>
761 <td class="memname">static APR_INLINE unsigned apreq_module_status_is_error </td>
762 <td>(</td>
763 <td class="paramtype">apr_status_t&#160;</td>
764 <td class="paramname"><em>s</em></td><td>)</td>
765 <td></td>
766 </tr>
767 </table>
768 </td>
769 <td class="mlabels-right">
770 <span class="mlabels"><span class="mlabel">static</span></span> </td>
771 </tr>
772 </table>
773 </div><div class="memdoc">
774 <p>Defines the module-specific status codes which are commonly considered to be non-fatal.</p>
775 <dl class="params"><dt>Parameters</dt><dd>
776 <table class="params">
777 <tr><td class="paramname">s</td><td>status code returned by an <a class="el" href="structapreq__module__t.html" title="Vtable describing the necessary module functions.">apreq_module_t</a> method.</td></tr>
778 </table>
779 </dd>
780 </dl>
781 <dl class="section return"><dt>Returns</dt><dd>1 if s is fatal, 0 otherwise. </dd></dl>
782
783 </div>
784 </div>
785 <a id="a08c59b5f07fb36080bb4d62e68bfeddf"></a>
786 <h2 class="memtitle"><span class="permalink"><a href="#a08c59b5f07fb36080bb4d62e68bfeddf">&#9670;&nbsp;</a></span>apreq_param()</h2>
787
788 <div class="memitem">
789 <div class="memproto">
790 <table class="memname">
791 <tr>
792 <td class="memname"><a class="el" href="structapreq__param__t.html">apreq_param_t</a>* apreq_param </td>
793 <td>(</td>
794 <td class="paramtype"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *&#160;</td>
795 <td class="paramname"><em>req</em>, </td>
796 </tr>
797 <tr>
798 <td class="paramkey"></td>
799 <td></td>
800 <td class="paramtype">const char *&#160;</td>
801 <td class="paramname"><em>key</em>&#160;</td>
802 </tr>
803 <tr>
804 <td></td>
805 <td>)</td>
806 <td></td><td></td>
807 </tr>
808 </table>
809 </div><div class="memdoc">
810 <p>Find the first query string parameter or body parameter with the specified name. The match is case-insensitive.</p>
811 <dl class="params"><dt>Parameters</dt><dd>
812 <table class="params">
813 <tr><td class="paramname">req</td><td>request handle. </td></tr>
814 <tr><td class="paramname">key</td><td>desired parameter name</td></tr>
815 </table>
816 </dd>
817 </dl>
818 <dl class="section return"><dt>Returns</dt><dd>The first matching parameter (with args searched first) or NULL. </dd></dl>
819
820 </div>
821 </div>
822 <a id="a0dff48fd4e83399a07853abe9d67c251"></a>
823 <h2 class="memtitle"><span class="permalink"><a href="#a0dff48fd4e83399a07853abe9d67c251">&#9670;&nbsp;</a></span>apreq_params()</h2>
824
825 <div class="memitem">
826 <div class="memproto">
827 <table class="memname">
828 <tr>
829 <td class="memname">apr_table_t* apreq_params </td>
830 <td>(</td>
831 <td class="paramtype"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *&#160;</td>
832 <td class="paramname"><em>req</em>, </td>
833 </tr>
834 <tr>
835 <td class="paramkey"></td>
836 <td></td>
837 <td class="paramtype">apr_pool_t *&#160;</td>
838 <td class="paramname"><em>p</em>&#160;</td>
839 </tr>
840 <tr>
841 <td></td>
842 <td>)</td>
843 <td></td><td></td>
844 </tr>
845 </table>
846 </div><div class="memdoc">
847 <p>Returns a table containing key-value pairs for the full request (args + body).</p>
848 <dl class="params"><dt>Parameters</dt><dd>
849 <table class="params">
850 <tr><td class="paramname">req</td><td>request handle </td></tr>
851 <tr><td class="paramname">p</td><td>allocates the returned table.</td></tr>
852 </table>
853 </dd>
854 </dl>
855 <dl class="section return"><dt>Returns</dt><dd>table representing all available params; is never NULL. </dd></dl>
856
857 </div>
858 </div>
859 <a id="a136584883dac2b5c76052bed1c4e61dc"></a>
860 <h2 class="memtitle"><span class="permalink"><a href="#a136584883dac2b5c76052bed1c4e61dc">&#9670;&nbsp;</a></span>apreq_parser_get()</h2>
861
862 <div class="memitem">
863 <div class="memproto">
864 <table class="mlabels">
865 <tr>
866 <td class="mlabels-left">
867 <table class="memname">
868 <tr>
869 <td class="memname">static APR_INLINE apr_status_t apreq_parser_get </td>
870 <td>(</td>
871 <td class="paramtype"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *&#160;</td>
872 <td class="paramname"><em>req</em>, </td>
873 </tr>
874 <tr>
875 <td class="paramkey"></td>
876 <td></td>
877 <td class="paramtype">const <a class="el" href="structapreq__parser__t.html">apreq_parser_t</a> **&#160;</td>
878 <td class="paramname"><em>parser</em>&#160;</td>
879 </tr>
880 <tr>
881 <td></td>
882 <td>)</td>
883 <td></td><td></td>
884 </tr>
885 </table>
886 </td>
887 <td class="mlabels-right">
888 <span class="mlabels"><span class="mlabel">static</span></span> </td>
889 </tr>
890 </table>
891 </div><div class="memdoc">
892 <p>Fetch the active body parser.</p>
893 <dl class="params"><dt>Parameters</dt><dd>
894 <table class="params">
895 <tr><td class="paramname">req</td><td>The request handle </td></tr>
896 <tr><td class="paramname">parser</td><td>Points to the active parser on return.</td></tr>
897 </table>
898 </dd>
899 </dl>
900 <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS or module-specific error. </dd></dl>
901
902 </div>
903 </div>
904 <a id="a6842f8b5a1d1f9115ba8ff7b1da1e78b"></a>
905 <h2 class="memtitle"><span class="permalink"><a href="#a6842f8b5a1d1f9115ba8ff7b1da1e78b">&#9670;&nbsp;</a></span>apreq_parser_set()</h2>
906
907 <div class="memitem">
908 <div class="memproto">
909 <table class="mlabels">
910 <tr>
911 <td class="mlabels-left">
912 <table class="memname">
913 <tr>
914 <td class="memname">static APR_INLINE apr_status_t apreq_parser_set </td>
915 <td>(</td>
916 <td class="paramtype"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *&#160;</td>
917 <td class="paramname"><em>req</em>, </td>
918 </tr>
919 <tr>
920 <td class="paramkey"></td>
921 <td></td>
922 <td class="paramtype"><a class="el" href="structapreq__parser__t.html">apreq_parser_t</a> *&#160;</td>
923 <td class="paramname"><em>parser</em>&#160;</td>
924 </tr>
925 <tr>
926 <td></td>
927 <td>)</td>
928 <td></td><td></td>
929 </tr>
930 </table>
931 </td>
932 <td class="mlabels-right">
933 <span class="mlabels"><span class="mlabel">static</span></span> </td>
934 </tr>
935 </table>
936 </div><div class="memdoc">
937 <p>Set the body parser for this request.</p>
938 <dl class="params"><dt>Parameters</dt><dd>
939 <table class="params">
940 <tr><td class="paramname">req</td><td>The request handle </td></tr>
941 <tr><td class="paramname">parser</td><td>New parser to use.</td></tr>
942 </table>
943 </dd>
944 </dl>
945 <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS or module-specific error. </dd></dl>
946
947 </div>
948 </div>
949 <a id="ab5cc462231ee5e4389ceb46eab1e456f"></a>
950 <h2 class="memtitle"><span class="permalink"><a href="#ab5cc462231ee5e4389ceb46eab1e456f">&#9670;&nbsp;</a></span>apreq_read_limit_get()</h2>
951
952 <div class="memitem">
953 <div class="memproto">
954 <table class="mlabels">
955 <tr>
956 <td class="mlabels-left">
957 <table class="memname">
958 <tr>
959 <td class="memname">static APR_INLINE apr_status_t apreq_read_limit_get </td>
960 <td>(</td>
961 <td class="paramtype"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *&#160;</td>
962 <td class="paramname"><em>req</em>, </td>
963 </tr>
964 <tr>
965 <td class="paramkey"></td>
966 <td></td>
967 <td class="paramtype">apr_uint64_t *&#160;</td>
968 <td class="paramname"><em>bytes</em>&#160;</td>
969 </tr>
970 <tr>
971 <td></td>
972 <td>)</td>
973 <td></td><td></td>
974 </tr>
975 </table>
976 </td>
977 <td class="mlabels-right">
978 <span class="mlabels"><span class="mlabel">static</span></span> </td>
979 </tr>
980 </table>
981 </div><div class="memdoc">
982 <p>Get the active read limit.</p>
983 <dl class="params"><dt>Parameters</dt><dd>
984 <table class="params">
985 <tr><td class="paramname">req</td><td>The request handle. </td></tr>
986 <tr><td class="paramname">bytes</td><td>Pointer to resulting (current) limit.</td></tr>
987 </table>
988 </dd>
989 </dl>
990 <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS or a module-specific error, which may leave bytes undefined. </dd></dl>
991
992 </div>
993 </div>
994 <a id="a97d4d8090e7847ace598c7a65b309564"></a>
995 <h2 class="memtitle"><span class="permalink"><a href="#a97d4d8090e7847ace598c7a65b309564">&#9670;&nbsp;</a></span>apreq_read_limit_set()</h2>
996
997 <div class="memitem">
998 <div class="memproto">
999 <table class="mlabels">
1000 <tr>
1001 <td class="mlabels-left">
1002 <table class="memname">
1003 <tr>
1004 <td class="memname">static APR_INLINE apr_status_t apreq_read_limit_set </td>
1005 <td>(</td>
1006 <td class="paramtype"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *&#160;</td>
1007 <td class="paramname"><em>req</em>, </td>
1008 </tr>
1009 <tr>
1010 <td class="paramkey"></td>
1011 <td></td>
1012 <td class="paramtype">apr_uint64_t&#160;</td>
1013 <td class="paramname"><em>bytes</em>&#160;</td>
1014 </tr>
1015 <tr>
1016 <td></td>
1017 <td>)</td>
1018 <td></td><td></td>
1019 </tr>
1020 </table>
1021 </td>
1022 <td class="mlabels-right">
1023 <span class="mlabels"><span class="mlabel">static</span></span> </td>
1024 </tr>
1025 </table>
1026 </div><div class="memdoc">
1027 <p>Set the active read limit.</p>
1028 <dl class="params"><dt>Parameters</dt><dd>
1029 <table class="params">
1030 <tr><td class="paramname">req</td><td>The handle. </td></tr>
1031 <tr><td class="paramname">bytes</td><td>New limit to use.</td></tr>
1032 </table>
1033 </dd>
1034 </dl>
1035 <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS or a module-specific error. </dd></dl>
1036
1037 </div>
1038 </div>
1039 <a id="a51c4bd2bc98e9355f8595341ba6aff0b"></a>
1040 <h2 class="memtitle"><span class="permalink"><a href="#a51c4bd2bc98e9355f8595341ba6aff0b">&#9670;&nbsp;</a></span>apreq_temp_dir_get()</h2>
1041
1042 <div class="memitem">
1043 <div class="memproto">
1044 <table class="mlabels">
1045 <tr>
1046 <td class="mlabels-left">
1047 <table class="memname">
1048 <tr>
1049 <td class="memname">static APR_INLINE apr_status_t apreq_temp_dir_get </td>
1050 <td>(</td>
1051 <td class="paramtype"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *&#160;</td>
1052 <td class="paramname"><em>req</em>, </td>
1053 </tr>
1054 <tr>
1055 <td class="paramkey"></td>
1056 <td></td>
1057 <td class="paramtype">const char **&#160;</td>
1058 <td class="paramname"><em>path</em>&#160;</td>
1059 </tr>
1060 <tr>
1061 <td></td>
1062 <td>)</td>
1063 <td></td><td></td>
1064 </tr>
1065 </table>
1066 </td>
1067 <td class="mlabels-right">
1068 <span class="mlabels"><span class="mlabel">static</span></span> </td>
1069 </tr>
1070 </table>
1071 </div><div class="memdoc">
1072 <p>Get the active temp directory.</p>
1073 <dl class="params"><dt>Parameters</dt><dd>
1074 <table class="params">
1075 <tr><td class="paramname">req</td><td>The handle. </td></tr>
1076 <tr><td class="paramname">path</td><td>Resulting path to temp dir.</td></tr>
1077 </table>
1078 </dd>
1079 </dl>
1080 <dl class="section return"><dt>Returns</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>
1081
1082 </div>
1083 </div>
1084 <a id="afc1b7d33062581140fd16b859b06d24a"></a>
1085 <h2 class="memtitle"><span class="permalink"><a href="#afc1b7d33062581140fd16b859b06d24a">&#9670;&nbsp;</a></span>apreq_temp_dir_set()</h2>
1086
1087 <div class="memitem">
1088 <div class="memproto">
1089 <table class="mlabels">
1090 <tr>
1091 <td class="mlabels-left">
1092 <table class="memname">
1093 <tr>
1094 <td class="memname">static APR_INLINE apr_status_t apreq_temp_dir_set </td>
1095 <td>(</td>
1096 <td class="paramtype"><a class="el" href="structapreq__handle__t.html">apreq_handle_t</a> *&#160;</td>
1097 <td class="paramname"><em>req</em>, </td>
1098 </tr>
1099 <tr>
1100 <td class="paramkey"></td>
1101 <td></td>
1102 <td class="paramtype">const char *&#160;</td>
1103 <td class="paramname"><em>path</em>&#160;</td>
1104 </tr>
1105 <tr>
1106 <td></td>
1107 <td>)</td>
1108 <td></td><td></td>
1109 </tr>
1110 </table>
1111 </td>
1112 <td class="mlabels-right">
1113 <span class="mlabels"><span class="mlabel">static</span></span> </td>
1114 </tr>
1115 </table>
1116 </div><div class="memdoc">
1117 <p>Set the active temp directory.</p>
1118 <dl class="params"><dt>Parameters</dt><dd>
1119 <table class="params">
1120 <tr><td class="paramname">req</td><td>The handle. </td></tr>
1121 <tr><td class="paramname">path</td><td>New path to use; may be NULL.</td></tr>
1122 </table>
1123 </dd>
1124 </dl>
1125 <dl class="section return"><dt>Returns</dt><dd>APR_SUCCESS or a module-specific error . </dd></dl>
1126
1127 </div>
1128 </div>
1129 </div><!-- contents -->
1130 <div id="footer">
1131 <p class="apache">
1132 Copyright &copy; 2003-2006 <a href="http://www.apache.org">The Apache Software Foundation</a>.<br/>
1133 See <a href="apreq_license.html">LICENSE</a>.</p>
1134 <p class="menu">
1135 <span style="color:#aaa">page generated by <a href="http://www.doxygen.org/"><code>doxygen</code></a>
1136 version 1.9.1 on Thu Aug 18 2022</span>
1137 </p>
1138 </div>
1139 </body>
1140 </html>