1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<link rel="stylesheet" href="style.css" type="text/css">
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
<link rel="Start" href="index.html">
<link rel="previous" href="Uq_tcl.html">
<link rel="next" href="Netcgi.html">
<link rel="Up" href="index.html">
<link title="Index of types" rel=Appendix href="index_types.html">
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
<link title="Index of values" rel=Appendix href="index_values.html">
<link title="Index of class attributes" rel=Appendix href="index_attributes.html">
<link title="Index of class methods" rel=Appendix href="index_methods.html">
<link title="Index of classes" rel=Appendix href="index_classes.html">
<link title="Index of class types" rel=Appendix href="index_class_types.html">
<link title="Index of modules" rel=Appendix href="index_modules.html">
<link title="Index of module types" rel=Appendix href="index_module_types.html">
<link title="Uq_gtk" rel="Chapter" href="Uq_gtk.html">
<link title="Equeue" rel="Chapter" href="Equeue.html">
<link title="Unixqueue" rel="Chapter" href="Unixqueue.html">
<link title="Uq_engines" rel="Chapter" href="Uq_engines.html">
<link title="Uq_socks5" rel="Chapter" href="Uq_socks5.html">
<link title="Unixqueue_mt" rel="Chapter" href="Unixqueue_mt.html">
<link title="Equeue_intro" rel="Chapter" href="Equeue_intro.html">
<link title="Uq_ssl" rel="Chapter" href="Uq_ssl.html">
<link title="Uq_tcl" rel="Chapter" href="Uq_tcl.html">
<link title="Netcgi_common" rel="Chapter" href="Netcgi_common.html">
<link title="Netcgi" rel="Chapter" href="Netcgi.html">
<link title="Netcgi_ajp" rel="Chapter" href="Netcgi_ajp.html">
<link title="Netcgi_scgi" rel="Chapter" href="Netcgi_scgi.html">
<link title="Netcgi_cgi" rel="Chapter" href="Netcgi_cgi.html">
<link title="Netcgi_fcgi" rel="Chapter" href="Netcgi_fcgi.html">
<link title="Netcgi_dbi" rel="Chapter" href="Netcgi_dbi.html">
<link title="Netcgi1_compat" rel="Chapter" href="Netcgi1_compat.html">
<link title="Netcgi_test" rel="Chapter" href="Netcgi_test.html">
<link title="Netcgi_porting" rel="Chapter" href="Netcgi_porting.html">
<link title="Netcgi_plex" rel="Chapter" href="Netcgi_plex.html">
<link title="Http_client" rel="Chapter" href="Http_client.html">
<link title="Telnet_client" rel="Chapter" href="Telnet_client.html">
<link title="Ftp_data_endpoint" rel="Chapter" href="Ftp_data_endpoint.html">
<link title="Ftp_client" rel="Chapter" href="Ftp_client.html">
<link title="Nethttpd_types" rel="Chapter" href="Nethttpd_types.html">
<link title="Nethttpd_kernel" rel="Chapter" href="Nethttpd_kernel.html">
<link title="Nethttpd_reactor" rel="Chapter" href="Nethttpd_reactor.html">
<link title="Nethttpd_engine" rel="Chapter" href="Nethttpd_engine.html">
<link title="Nethttpd_services" rel="Chapter" href="Nethttpd_services.html">
<link title="Nethttpd_plex" rel="Chapter" href="Nethttpd_plex.html">
<link title="Nethttpd_intro" rel="Chapter" href="Nethttpd_intro.html">
<link title="Netplex_types" rel="Chapter" href="Netplex_types.html">
<link title="Netplex_mp" rel="Chapter" href="Netplex_mp.html">
<link title="Netplex_mt" rel="Chapter" href="Netplex_mt.html">
<link title="Netplex_log" rel="Chapter" href="Netplex_log.html">
<link title="Netplex_controller" rel="Chapter" href="Netplex_controller.html">
<link title="Netplex_container" rel="Chapter" href="Netplex_container.html">
<link title="Netplex_sockserv" rel="Chapter" href="Netplex_sockserv.html">
<link title="Netplex_workload" rel="Chapter" href="Netplex_workload.html">
<link title="Netplex_main" rel="Chapter" href="Netplex_main.html">
<link title="Netplex_config" rel="Chapter" href="Netplex_config.html">
<link title="Netplex_kit" rel="Chapter" href="Netplex_kit.html">
<link title="Rpc_netplex" rel="Chapter" href="Rpc_netplex.html">
<link title="Netplex_cenv" rel="Chapter" href="Netplex_cenv.html">
<link title="Netplex_intro" rel="Chapter" href="Netplex_intro.html">
<link title="Netshm" rel="Chapter" href="Netshm.html">
<link title="Netshm_data" rel="Chapter" href="Netshm_data.html">
<link title="Netshm_hashtbl" rel="Chapter" href="Netshm_hashtbl.html">
<link title="Netshm_array" rel="Chapter" href="Netshm_array.html">
<link title="Netshm_intro" rel="Chapter" href="Netshm_intro.html">
<link title="Netconversion" rel="Chapter" href="Netconversion.html">
<link title="Netchannels" rel="Chapter" href="Netchannels.html">
<link title="Netstream" rel="Chapter" href="Netstream.html">
<link title="Mimestring" rel="Chapter" href="Mimestring.html">
<link title="Netmime" rel="Chapter" href="Netmime.html">
<link title="Netsendmail" rel="Chapter" href="Netsendmail.html">
<link title="Neturl" rel="Chapter" href="Neturl.html">
<link title="Netaddress" rel="Chapter" href="Netaddress.html">
<link title="Netbuffer" rel="Chapter" href="Netbuffer.html">
<link title="Netdate" rel="Chapter" href="Netdate.html">
<link title="Netencoding" rel="Chapter" href="Netencoding.html">
<link title="Netulex" rel="Chapter" href="Netulex.html">
<link title="Netaccel" rel="Chapter" href="Netaccel.html">
<link title="Netaccel_link" rel="Chapter" href="Netaccel_link.html">
<link title="Nethtml" rel="Chapter" href="Nethtml.html">
<link title="Netstring_str" rel="Chapter" href="Netstring_str.html">
<link title="Netstring_pcre" rel="Chapter" href="Netstring_pcre.html">
<link title="Netstring_mt" rel="Chapter" href="Netstring_mt.html">
<link title="Netmappings" rel="Chapter" href="Netmappings.html">
<link title="Netaux" rel="Chapter" href="Netaux.html">
<link title="Nethttp" rel="Chapter" href="Nethttp.html">
<link title="Netchannels_tut" rel="Chapter" href="Netchannels_tut.html">
<link title="Netmime_tut" rel="Chapter" href="Netmime_tut.html">
<link title="Netsendmail_tut" rel="Chapter" href="Netsendmail_tut.html">
<link title="Netulex_tut" rel="Chapter" href="Netulex_tut.html">
<link title="Neturl_tut" rel="Chapter" href="Neturl_tut.html">
<link title="Netsys" rel="Chapter" href="Netsys.html">
<link title="Netpop" rel="Chapter" href="Netpop.html">
<link title="Rpc_auth_dh" rel="Chapter" href="Rpc_auth_dh.html">
<link title="Rpc_key_service" rel="Chapter" href="Rpc_key_service.html">
<link title="Rpc_time" rel="Chapter" href="Rpc_time.html">
<link title="Rpc_auth_local" rel="Chapter" href="Rpc_auth_local.html">
<link title="Rtypes" rel="Chapter" href="Rtypes.html">
<link title="Xdr" rel="Chapter" href="Xdr.html">
<link title="Rpc" rel="Chapter" href="Rpc.html">
<link title="Rpc_program" rel="Chapter" href="Rpc_program.html">
<link title="Rpc_portmapper_aux" rel="Chapter" href="Rpc_portmapper_aux.html">
<link title="Rpc_packer" rel="Chapter" href="Rpc_packer.html">
<link title="Rpc_transport" rel="Chapter" href="Rpc_transport.html">
<link title="Rpc_client" rel="Chapter" href="Rpc_client.html">
<link title="Rpc_simple_client" rel="Chapter" href="Rpc_simple_client.html">
<link title="Rpc_portmapper_clnt" rel="Chapter" href="Rpc_portmapper_clnt.html">
<link title="Rpc_portmapper" rel="Chapter" href="Rpc_portmapper.html">
<link title="Rpc_server" rel="Chapter" href="Rpc_server.html">
<link title="Rpc_auth_sys" rel="Chapter" href="Rpc_auth_sys.html">
<link title="Rpc_intro" rel="Chapter" href="Rpc_intro.html">
<link title="Rpc_mapping_ref" rel="Chapter" href="Rpc_mapping_ref.html">
<link title="Rpc_ssl" rel="Chapter" href="Rpc_ssl.html">
<link title="Rpc_xti_client" rel="Chapter" href="Rpc_xti_client.html">
<link title="Shell_sys" rel="Chapter" href="Shell_sys.html">
<link title="Shell" rel="Chapter" href="Shell.html">
<link title="Shell_uq" rel="Chapter" href="Shell_uq.html">
<link title="Shell_mt" rel="Chapter" href="Shell_mt.html">
<link title="Shell_intro" rel="Chapter" href="Shell_intro.html">
<link title="Netsmtp" rel="Chapter" href="Netsmtp.html"><link title="Arguments" rel="Section" href="#2_Arguments">
<link title="Cookies" rel="Section" href="#2_Cookies">
<link title="Environment" rel="Section" href="#2_Environment">
<link title="CGI" rel="Section" href="#2_CGI">
<link title="Exceptions" rel="Section" href="#2_Exceptions">
<link title="Useful functions" rel="Section" href="#2_Usefulfunctions">
<title>Ocamlnet 2 Reference Manual : Netcgi_common</title>
</head>
<body>
<div class="navbar"><a href="Uq_tcl.html">Previous</a>
<a href="index.html">Up</a>
<a href="Netcgi.html">Next</a>
</div>
<center><h1>Module <a href="type_Netcgi_common.html">Netcgi_common</a></h1></center>
<br>
<pre><span class="keyword">module</span> Netcgi_common: <code class="code">sig</code> <a href="Netcgi_common.html">..</a> <code class="code">end</code></pre>Functions to develop new connectors.
<p>
The following module is provided as a set of helper functions to
define new connectors. As a normal user of <code class="code">Netcgi</code>, <b>you should
not use this module</b>.<br>
<hr width="100%">
<br>
The goal of this module is to factor out common routines to easily
set up new connectors. Here is the normal flow of operations:
<p>
<ul>
<li>You start by reading the request environment properties as well
as the input header. Often both are undistinguished and provided
through some sort of meta-variables. The function
<a href="Netcgi_common.html#VALupdate_props_inheader"><code class="code">Netcgi_common.update_props_inheader</code></a> helps you to sort them and
to normalize the input header fields. You also need to set up a
<a href="Netchannels.out_obj_channel.html"><code class="code">Netchannels.out_obj_channel</code></a> to the output stream of your
connector. Then, <code class="code">Netcgi_common.cgi_environment</code> can create an
environment object for you. If <code class="code">stderr</code> output is not appropriate
(e.g. ot is not redirected to the server log), you need to
override <code class="code">#log_error</code>.</li>
</ul>
<ul>
<li>From the environment object and arguments, <code class="code">Netcgi_common.cgi</code>
creates a CGI object. Often, arguments are read from the
environment <code class="code">#cgi_query_string</code> (in case of GET) or from an input
channel (in case of POST). <a href="Netcgi_common.html#VALcgi_with_args"><code class="code">Netcgi_common.cgi_with_args</code></a> handles
this for you: it requires a <a href="Netchannels.in_obj_channel.html"><code class="code">Netchannels.in_obj_channel</code></a> from
which the arguments are read (only used in the case of POST).</li>
</ul>
<ul>
<li><a href="Netcgi_common.html#VALexn_handler_default"><code class="code">Netcgi_common.exn_handler_default</code></a> provides a default error
page for uncaught exceptions. It also allows the user to pass his
own exception handler that has precedence on the default one.</li>
</ul>
To see this schema in use, we recommend you have a look to the
implementation of the CGI connector because it is very simple.<br>
<br>
<a name="2_Arguments"></a>
<h2>Arguments</h2><br>
<pre><span class="keyword">type</span> <a name="TYPErepresentation"></a><code class="type"></code>representation = <code class="type">[ `MIME of <a href="Netmime.html#TYPEmime_message">Netmime.mime_message</a> | `Simple of <a href="Netmime.mime_body.html">Netmime.mime_body</a> ]</code> </pre>
<pre><span class="keyword">type</span> <a name="TYPEstore"></a><code class="type"></code>store = <code class="type">[ `File of string | `Memory ]</code> </pre>
<pre><span class="keyword">exception</span> <a name="EXCEPTIONOversized"></a>Oversized</pre>
<div class="info">
See <a href="Netcgi.Argument.html#EXCEPTIONOversized"><code class="code">Netcgi.Argument.Oversized</code></a>.<br>
</div>
<pre><span class="keyword">class type</span> <a name="TYPEcgi_argument"></a><a href="Netcgi_common.cgi_argument.html">cgi_argument</a> = <code class="code">object</code> <a href="Netcgi_common.cgi_argument.html">..</a> <code class="code">end</code></pre><div class="info">
See <a href="Netcgi.cgi_argument.html"><code class="code">Netcgi.cgi_argument</code></a>.
</div>
<pre><span class="keyword">class type</span> <a name="TYPErw_cgi_argument"></a><a href="Netcgi_common.rw_cgi_argument.html">rw_cgi_argument</a> = <code class="code">object</code> <a href="Netcgi_common.rw_cgi_argument.html">..</a> <code class="code">end</code></pre><div class="info">
<font color="#CCCCCC">See <a href="Netcgi.rw_cgi_argument.html"><code class="code">Netcgi.rw_cgi_argument</code></a>.
</font></div>
<pre><span class="keyword">class</span> <a name="TYPEsimple_arg"></a><a href="Netcgi_common.simple_arg.html">simple_arg</a> : <code class="type">?ro:bool -> string -> string -> </code><code class="type"><a href="Netcgi_common.rw_cgi_argument.html">rw_cgi_argument</a></code></pre><div class="info">
See <a href="Netcgi.Argument.html#VALsimple"><code class="code">Netcgi.Argument.simple</code></a>.
</div>
<pre><span class="keyword">class</span> <a name="TYPEmime_arg"></a><a href="Netcgi_common.mime_arg.html">mime_arg</a> : <code class="type">?work_around_backslash_bug:bool -> ?name:string -> <a href="Netmime.html#TYPEmime_message">Netmime.mime_message</a> -> </code><code class="type"><a href="Netcgi_common.rw_cgi_argument.html">rw_cgi_argument</a></code></pre><div class="info">
See <a href="Netcgi.Argument.html#VALmime"><code class="code">Netcgi.Argument.mime</code></a>.
</div>
<br>
<a name="2_Cookies"></a>
<h2>Cookies</h2><br>
<pre><span class="keyword">module</span> <a href="Netcgi_common.Cookie.html">Cookie</a>: <code class="code">sig</code> <a href="Netcgi_common.Cookie.html">..</a> <code class="code">end</code></pre><div class="info">
Extended interface for <a href="Netcgi.Cookie.html"><code class="code">Netcgi.Cookie</code></a> suitable for OCamlNet
developers.
</div>
<br>
<a name="2_Environment"></a>
<h2>Environment</h2><br>
<br><code><span class="keyword">type</span> <a name="TYPEconfig"></a><code class="type"></code>config = {</code><table class="typetable">
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>tmp_directory : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>tmp_prefix : <code class="type">string</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>permitted_http_methods : <code class="type">[ `DELETE | `GET | `HEAD | `POST | `PUT ] list</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>permitted_input_content_types : <code class="type">string list</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>input_content_length_limit : <code class="type">int</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>workarounds : <code class="type">[ `Backslash_bug<br> | `MSIE_Content_type_bug<br> | `Work_around_MSIE_Content_type_bug<br> | `Work_around_backslash_bug ] list</code>;</code></td>
</tr>
<tr>
<td align="left" valign="top" >
<code> </code></td>
<td align="left" valign="top" >
<code>default_exn_handler : <code class="type">bool</code>;</code></td>
</tr></table>
}
<div class="info">
See <a href="Netcgi.html#TYPEconfig"><code class="code">Netcgi.config</code></a>.<br>
</div>
<pre><span class="keyword">type</span> <a name="TYPEoutput_type"></a><code class="type"></code>output_type = <code class="type">[ `Direct of string<br> | `Transactional of<br> <a href="Netcgi_common.html#TYPEconfig">config</a> -><br> <a href="Netchannels.out_obj_channel.html">Netchannels.out_obj_channel</a> -> <a href="Netchannels.trans_out_obj_channel.html">Netchannels.trans_out_obj_channel</a> ]</code> </pre>
<div class="info">
See <a href="Netcgi.html#TYPEoutput_type"><code class="code">Netcgi.output_type</code></a>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALfix_MSIE_Content_type_bug"></a>fix_MSIE_Content_type_bug : <code class="type">string -> string</code></pre><div class="info">
<code class="code">fix_MSIE_Content_type_bug ct</code> transforms the content-type
string <code class="code">ct</code> to fix the MSIE Content-Type bug.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALis_MSIE"></a>is_MSIE : <code class="type">string -> bool</code></pre><div class="info">
<code class="code">is_MSIE user_agent</code> tells whether the <code class="code">user_agent</code> is Microsoft
Internet Explorer. Useful to know when to apply
<a href="Netcgi_common.html#VALfix_MSIE_Content_type_bug"><code class="code">Netcgi_common.fix_MSIE_Content_type_bug</code></a>.<br>
</div>
<pre><span class="keyword">class</span> <a name="TYPEcgi_environment"></a><a href="Netcgi_common.cgi_environment.html">cgi_environment</a> : <code class="type">config:<a href="Netcgi_common.html#TYPEconfig">config</a> -> properties:(string * string) list -> input_header:(string * string) list -> <a href="Netchannels.out_obj_channel.html">Netchannels.out_obj_channel</a> -> </code><code class="code">object</code> <a href="Netcgi_common.cgi_environment.html">..</a> <code class="code">end</code></pre><div class="info">
<code class="code">new cgi_environment ~config ~properties ~input_header out_obj</code>
generates a <a href="Netcgi.cgi_environment.html"><code class="code">Netcgi.cgi_environment</code></a> object, from the arguments.
</div>
<br>
<a name="2_CGI"></a>
<h2>CGI</h2><br>
<pre><span class="keyword">type</span> <a name="TYPEother_url_spec"></a><code class="type"></code>other_url_spec = <code class="type">[ `Env | `None | `This of string ]</code> </pre>
<div class="info">
See <a href="Netcgi.html#TYPEother_url_spec"><code class="code">Netcgi.other_url_spec</code></a>.<br>
</div>
<pre><span class="keyword">type</span> <a name="TYPEquery_string_spec"></a><code class="type"></code>query_string_spec = <code class="type">[ `Args of <a href="Netcgi_common.rw_cgi_argument.html">rw_cgi_argument</a> list<br> | `Env<br> | `None<br> | `This of <a href="Netcgi_common.cgi_argument.html">cgi_argument</a> list ]</code> </pre>
<div class="info">
See <a href="Netcgi.html#TYPEquery_string_spec"><code class="code">Netcgi.query_string_spec</code></a>.<br>
</div>
<pre><span class="keyword">type</span> <a name="TYPEcache_control"></a><code class="type"></code>cache_control = <code class="type">[ `Max_age of int | `No_cache | `Unspecified ]</code> </pre>
<div class="info">
See <a href="Netcgi.html#TYPEcache_control"><code class="code">Netcgi.cache_control</code></a>.<br>
</div>
<pre><span class="keyword">type</span> <a name="TYPErequest_method"></a><code class="type"></code>request_method = <code class="type">[ `DELETE | `GET | `HEAD | `POST | `PUT of <a href="Netcgi_common.cgi_argument.html">cgi_argument</a> ]</code> </pre>
<pre><span class="keyword">val</span> <a name="VALstring_of_request_method"></a>string_of_request_method : <code class="type"><a href="Netcgi_common.html#TYPErequest_method">request_method</a> -> string</code></pre><pre><span class="keyword">type</span> <a name="TYPEarg_store_type"></a><code class="type"></code>arg_store_type = <code class="type">[ `Automatic<br> | `Automatic_max of float<br> | `Discard<br> | `File<br> | `File_max of float<br> | `Memory<br> | `Memory_max of float ]</code> </pre>
<pre><span class="keyword">type</span> <a name="TYPEarg_store"></a><code class="type"></code>arg_store = <code class="type"><a href="Netcgi_common.cgi_environment.html">cgi_environment</a> -><br> string -> <a href="Netmime.mime_header_ro.html">Netmime.mime_header_ro</a> -> <a href="Netcgi_common.html#TYPEarg_store_type">arg_store_type</a></code> </pre>
<div class="info">
See <a href="Netcgi.html#TYPEarg_store"><code class="code">Netcgi.arg_store</code></a>.<br>
</div>
<pre><span class="keyword">class</span> <a name="TYPEcgi"></a><a href="Netcgi_common.cgi.html">cgi</a> : <code class="type"><a href="Netcgi_common.cgi_environment.html">cgi_environment</a> -> <a href="Netcgi_common.html#TYPEoutput_type">output_type</a> -> <a href="Netcgi_common.html#TYPErequest_method">request_method</a> -> <a href="Netcgi_common.cgi_argument.html">cgi_argument</a> list -> </code><code class="code">object</code> <a href="Netcgi_common.cgi.html">..</a> <code class="code">end</code></pre><div class="info">
<code class="code">cgi env op meth args</code> constructs <a href="Netcgi.cgi.html"><code class="code">Netcgi.cgi</code></a> objects.
</div>
<pre><span class="keyword">val</span> <a name="VALcgi_with_args"></a>cgi_with_args : <code class="type">(<a href="Netcgi_common.cgi_environment.html">cgi_environment</a> -><br> <a href="Netcgi_common.html#TYPEoutput_type">output_type</a> -><br> <a href="Netcgi_common.html#TYPErequest_method">request_method</a> -> <a href="Netcgi_common.cgi_argument.html">cgi_argument</a> list -> 'a) -><br> <a href="Netcgi_common.cgi_environment.html">cgi_environment</a> -><br> <a href="Netcgi_common.html#TYPEoutput_type">output_type</a> -><br> <a href="Netchannels.in_obj_channel.html">Netchannels.in_obj_channel</a> -> <a href="Netcgi_common.html#TYPEarg_store">arg_store</a> -> 'a</code></pre><div class="info">
<code class="code">cgi_with_args (new cgi) env out op ?put_arg in_chan</code> constructs
a <a href="Netcgi.cgi.html"><code class="code">Netcgi.cgi</code></a> object. However, <code class="code">new cgi</code> can be replaced by
any function, so it is easy to use this to construct extensions
of the <code class="code">cgi</code> class (as needed by some connectors). The
arguments of the cgi object are taken from the environment <code class="code">env</code>
(for HEAD, GET, DELETE) or from the <code class="code">in_chan</code> (for POST, PUT)
and processed according to <code class="code">arg_store</code>.<br>
<b>Raises</b> <code>HTTP</code> if the data does not conform the standards or it not
allowed.<br>
</div>
<br>
<a name="2_Exceptions"></a>
<h2>Exceptions</h2><br>
<pre><span class="keyword">exception</span> <a name="EXCEPTIONHTTP"></a>HTTP <span class="keyword">of</span> <code class="type"><a href="Nethttp.html#TYPEhttp_status">Nethttp.http_status</a> * string</code></pre>
<div class="info">
Exception raised by various functions of this library to return
to the user agent an appropriate error page with the specified
http-status (this exception must be caught by the connector and
a default answer sent).
<p>
The string is a description of the cause of the error.
<p>
This exception is for use by connectors only, users should deal
with the exceptions in their code by generating a response with
the usual <code class="code">#set_header</code> and <code class="code">#out_channel</code> of <a href="Netcgi.cgi.html"><code class="code">Netcgi.cgi</code></a>.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALexn_handler_default"></a>exn_handler_default : <code class="type"><a href="Netcgi_common.cgi_environment.html">cgi_environment</a> -><br> exn_handler:(<a href="Netcgi_common.cgi_environment.html">cgi_environment</a> -> (unit -> unit) -> unit) -><br> finally:(unit -> unit) -> (unit -> exn option) -> unit</code></pre><div class="info">
<code class="code">exn_handler_default env ~exn_handler ~finally run_cgi</code> will
basically execute <code class="code">exn_handler env run_cgi</code>. Provided that the
environment config <code class="code">default_exn_handler</code> is set to <code class="code">true</code> (the
default), any exception <code class="code">e</code> not catched by the user provided
<code class="code">exn_handler</code> (or that is raised by it) will be passed to the
default handler of OCamlNet which will rollback the current
output, produce a page describing the exception <code class="code">e</code>, and close
the output channel of <code class="code">env</code>. Note that the default handler
treats <code class="code">HTTP</code> exceptions specially -- for example, the response
to <code class="code">HTTP(`Method_not_allowed,...)</code> includes an "Allow" header
(as mandated by HTTP/1.1);...
<p>
Note that, regardless of the value of <code class="code">default_exn_handler</code>, the
<code class="code">Exit</code> exception is always catched and treated like an
acceptable early termination (thus produces no error page).
<p>
Whether <code class="code">run_cgi</code> terminates normally or by an exception,
<code class="code">finally()</code> is be executed last and its return value is the
return value of <code class="code">exn_handler_default</code>.
<p>
Sometimes, you want that some "special" exceptions (for example
exceptions internal to the connector) CANNOT to be catched by
<code class="code">exn_handler</code>. In this case, <code class="code">run_cgi()</code> catches the exception,
say <code class="code">e</code>, and returns it as <code class="code">Some e</code>. The exception <code class="code">e</code> will "go
through" <code class="code">exn_handler_default</code>, it will not even be passed to
the default handler. Therefore, you must take care that it is
handled by the surrounding code or your connector may die
without an error message. Of course, <code class="code">run_cgi</code> must return
<code class="code">None</code> if no "special" exception is raised.
<p>
REMARK: Stricly speaking, <code class="code">exn_handler env run_cgi</code> is obviously
not possible because the return type of <code class="code">run_cgi</code> is not <code class="code">unit</code>
but you can ignore that to understand what this function does.<br>
</div>
<br>
<a name="2_Usefulfunctions"></a>
<h2>Useful functions</h2>
<p>
The following functions are used in several connectors and are
gouped here for convenience.<br>
<pre><span class="keyword">val</span> <a name="VALupdate_props_inheader"></a>update_props_inheader : <code class="type">string * string -><br> (string * string) list * (string * string) list -><br> (string * string) list * (string * string) list</code></pre><div class="info">
<code class="code">update_props_inheader (name, value) (props, inheader)</code> returns
<code class="code">(props, inheader)</code> to which the new parameter <code class="code">name</code>-<code class="code">value</code>
has been added -- to <code class="code">props</code> or <code class="code">inheader</code>, depending on <code class="code">name</code>.
Unless you know what you are going, you <b>must</b> use this
function to classify parameters as it also performs some
standardisation.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALrm_htspace"></a>rm_htspace : <code class="type">(char -> bool) -> string -> int -> int -> string</code></pre><div class="info">
<code class="code">rm_htspace is_space s low up</code> returns the substring <code class="code">s.[low
.. up - 1]</code> stripped of possible heading and trailing spaces
identified by the function <code class="code">is_space</code>.<br>
<b>Raises</b> <code>Invalid_argument</code> if <code class="code">low < 0</code> or <code class="code">up > String.length s</code><br>
</div>
<pre><span class="keyword">val</span> <a name="VALrev_split"></a>rev_split : <code class="type">(char -> bool) -> string -> string list</code></pre><div class="info">
<code class="code">split_rev is_delim s</code> split <code class="code">s</code> at each character <code class="code">is_delim</code>
and returns the list of substrings in reverse order. Several
consecutive delimiters are treated as a single one. The
substrings do not share <code class="code">s</code> memory.<br>
</div>
<pre><span class="keyword">val</span> <a name="VALis_prefix"></a>is_prefix : <code class="type">string -> string -> bool</code></pre><div class="info">
<code class="code">is_prefix pre s</code> checks whether <code class="code">pre</code> is a prefix of <code class="code">s</code>.<br>
</div>
</body></html>
|
