← Back to branch summary

~ubuntu-branches/ubuntu/trusty/ocamlnet/trusty

« back to all changes in this revision

Viewing changes to doc/html-main/netcgi1/Netcgi_env.custom_environment.html

  • Committer: Bazaar Package Importer
  • Author(s): Stéphane Glondu
  • Date: 2011-09-02 14:12:33 UTC
  • mfrom: (18.2.3 sid)
  • Revision ID: james.westby@ubuntu.com-20110902141233-zbj0ygxb92u6gy4z
Tags: 3.4-1
http://bugs.debian.org/637147
* New upstream release
  - add a new NetcgiRequire directive to ease dependency management
    (Closes: #637147)
  - remove patches that were applied upstream:
    + Added-missing-shebang-lines-in-example-shell-scripts
    + Try-also-ocamlc-for-POSIX-threads

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/html-main/netcgi1/Netcgi_env.custom_environment.html
1
 
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
3
 
<head>
4
 
<link rel="stylesheet" href="style.css" type="text/css">
5
 
<meta content="text/html; charset=iso-8859-1" http-equiv="Content-Type">
6
 
<link rel="Start" href="index.html">
7
 
<link rel="previous" href="Netcgi_env.test_environment.html">
8
 
<link rel="Up" href="Netcgi_env.html">
9
 
<link title="Index of types" rel=Appendix href="index_types.html">
10
 
<link title="Index of exceptions" rel=Appendix href="index_exceptions.html">
11
 
<link title="Index of values" rel=Appendix href="index_values.html">
12
 
<link title="Index of class methods" rel=Appendix href="index_methods.html">
13
 
<link title="Index of classes" rel=Appendix href="index_classes.html">
14
 
<link title="Index of class types" rel=Appendix href="index_class_types.html">
15
 
<link title="Index of modules" rel=Appendix href="index_modules.html">
16
 
<link title="Netcgi_env" rel="Chapter" href="Netcgi_env.html">
17
 
<link title="Netcgi_types" rel="Chapter" href="Netcgi_types.html">
18
 
<link title="Netcgi" rel="Chapter" href="Netcgi.html">
19
 
<link title="Netcgi_jserv" rel="Chapter" href="Netcgi_jserv.html">
20
 
<link title="Netcgi_jserv_ajp12" rel="Chapter" href="Netcgi_jserv_ajp12.html">
21
 
<link title="Netcgi_jserv_app" rel="Chapter" href="Netcgi_jserv_app.html">
22
 
<link title="Netcgi_fcgi_10" rel="Chapter" href="Netcgi_fcgi_10.html">
23
 
<link title="Netcgi_fcgi" rel="Chapter" href="Netcgi_fcgi.html">
24
 
<link title="Netcgi1_compat" rel="Chapter" href="Netcgi1_compat.html"><title>Ocamlnet 2 Reference Manual (netcgi1 add-on) : Netcgi_env.custom_environment</title>
25
 
</head>
26
 
<body>
27
 
<div class="navbar"><a href="Netcgi_env.test_environment.html">Previous</a>
28
 
&nbsp;<a href="Netcgi_env.html">Up</a>
29
 
&nbsp;</div>
30
 
<center><h1>Class <a href="type_Netcgi_env.custom_environment.html">Netcgi_env.custom_environment</a></h1></center>
31
 
<br>
32
 
<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
33
 
 creation, one sets the properties and the request header, and calls
34
 
 <code class="code">setup_finished</code>.
35
 
<p>
36
 
 
37
 
 Please read the comments about the protocol between environments and
38
 
 <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>
39
 
 before using this class. In particular, it is the task of the
40
 
 environment to receive the request header.<br>
41
 
<b>Inherits</b><ul>
42
 
<li><a href="Netcgi_env.cgi_environment.html"><code class="code">Netcgi_env.cgi_environment</code></a>    Implements this interface</li>
43
 
</ul>
44
 
<hr width="100%">
45
 
<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">
46
 
Sets CGI properties<br>
47
 
</div>
48
 
<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">
49
 
Sets a request header field<br>
50
 
</div>
51
 
<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">
52
 
Sets a request header field to a multiple value<br>
53
 
</div>
54
 
<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">
55
 
Sets all request header fields at once<br>
56
 
</div>
57
 
<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">
58
 
Sets the input channel to use<br>
59
 
</div>
60
 
<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">
61
 
Sets the input content length. This is the same as setting
62
 
 the <code class="code">Content-length</code> field of the request header<br>
63
 
</div>
64
 
<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">
65
 
Sets the input content type. This is the same as setting
66
 
 the <code class="code">Content-type</code> field of the request header<br>
67
 
</div>
68
 
<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">
69
 
Sets the output channel to use<br>
70
 
</div>
71
 
<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">
72
 
Sets the error log function (<code class="code">prerr_endline</code> by default)<br>
73
 
</div>
74
 
<pre><span class="keyword">method</span> <a name="METHODsetup_finished"></a>setup_finished : <code class="type">unit -> unit</code></pre><div class="info">
75
 
Finishes the setup. After that, it is no longer possible to change
76
 
 it.<br>
77
 
</div>
78
 
</body></html>
 
 
b'\\ No newline at end of file'