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
|
<!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="Netcgi_env.test_environment.html">
<link rel="Up" href="Netcgi_env.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 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="Netcgi_env" rel="Chapter" href="Netcgi_env.html">
<link title="Netcgi_types" rel="Chapter" href="Netcgi_types.html">
<link title="Netcgi" rel="Chapter" href="Netcgi.html">
<link title="Netcgi_jserv" rel="Chapter" href="Netcgi_jserv.html">
<link title="Netcgi_jserv_ajp12" rel="Chapter" href="Netcgi_jserv_ajp12.html">
<link title="Netcgi_jserv_app" rel="Chapter" href="Netcgi_jserv_app.html">
<link title="Netcgi_fcgi_10" rel="Chapter" href="Netcgi_fcgi_10.html">
<link title="Netcgi_fcgi" rel="Chapter" href="Netcgi_fcgi.html">
<link title="Netcgi1_compat" rel="Chapter" href="Netcgi1_compat.html"><title>Ocamlnet 2 Reference Manual (netcgi1 add-on) : Netcgi_env.custom_environment</title>
</head>
<body>
<div class="navbar"><a href="Netcgi_env.test_environment.html">Previous</a>
<a href="Netcgi_env.html">Up</a>
</div>
<center><h1>Class <a href="type_Netcgi_env.custom_environment.html">Netcgi_env.custom_environment</a></h1></center>
<br>
<pre><span class="keyword">class</span> <a name="TYPEcustom_environment"></a>custom_environment : <code class="type">?config:<a href="Netcgi_env.html#TYPEcgi_config">cgi_config</a> -> unit -> </code><code class="code">object</code> <a href="Netcgi_env.custom_environment.html">..</a> <code class="code">end</code></pre>This class can be used to set up non-standard environments. After
creation, one sets the properties and the request header, and calls
<code class="code">setup_finished</code>.
<p>
Please read the comments about the protocol between environments and
<code class="code">cgi_activation</code> in the description of <a href="Netcgi_env.cgi_environment.html"><code class="code">Netcgi_env.cgi_environment</code></a>
before using this class. In particular, it is the task of the
environment to receive the request header.<br>
<b>Inherits</b><ul>
<li><a href="Netcgi_env.cgi_environment.html"><code class="code">Netcgi_env.cgi_environment</code></a> Implements this interface</li>
</ul>
<hr width="100%">
<pre><span class="keyword">method</span> <a name="METHODset_cgi"></a>set_cgi : <code class="type">?gateway_interface:string -><br> ?server_software:string -><br> ?server_name:string -><br> ?server_protocol:string -><br> ?server_port:int option -><br> ?request_method:string -><br> ?path_info:string -><br> ?path_translated:string -><br> ?script_name:string -><br> ?query_string:string -><br> ?remote_host:string -><br> ?remote_addr:string -><br> ?auth_type:string -><br> ?remote_user:string -><br> ?remote_ident:string -><br> ?https:bool -> ?property:string * string -> unit -> unit</code></pre><div class="info">
Sets CGI properties<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODset_input_header_field"></a>set_input_header_field : <code class="type">string -> string -> unit</code></pre><div class="info">
Sets a request header field<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODset_multiple_input_header_field"></a>set_multiple_input_header_field : <code class="type">string -> string list -> unit</code></pre><div class="info">
Sets a request header field to a multiple value<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODset_input_header_fields"></a>set_input_header_fields : <code class="type">(string * string) list -> unit</code></pre><div class="info">
Sets all request header fields at once<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODset_input_ch"></a>set_input_ch : <code class="type">Netchannels.in_obj_channel -> unit</code></pre><div class="info">
Sets the input channel to use<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODset_input_content_length"></a>set_input_content_length : <code class="type">int -> unit</code></pre><div class="info">
Sets the input content length. This is the same as setting
the <code class="code">Content-length</code> field of the request header<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODset_input_content_type"></a>set_input_content_type : <code class="type">string -> unit</code></pre><div class="info">
Sets the input content type. This is the same as setting
the <code class="code">Content-type</code> field of the request header<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODset_output_ch"></a>set_output_ch : <code class="type">Netchannels.out_obj_channel -> unit</code></pre><div class="info">
Sets the output channel to use<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODset_error_log"></a>set_error_log : <code class="type">(string -> unit) -> unit</code></pre><div class="info">
Sets the error log function (<code class="code">prerr_endline</code> by default)<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODsetup_finished"></a>setup_finished : <code class="type">unit -> unit</code></pre><div class="info">
Finishes the setup. After that, it is no longer possible to change
it.<br>
</div>
</body></html>
|
