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
|
<!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="Nethttpd_engine.extended_async_environment.html">
<link rel="next" href="Nethttpd_engine.http_request_notification.html">
<link rel="Up" href="Nethttpd_engine.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"><title>Ocamlnet 2 Reference Manual : Nethttpd_engine.http_request_header_notification</title>
</head>
<body>
<div class="navbar"><a href="Nethttpd_engine.extended_async_environment.html">Previous</a>
<a href="Nethttpd_engine.html">Up</a>
<a href="Nethttpd_engine.http_request_notification.html">Next</a>
</div>
<center><h1>Class type <a href="type_Nethttpd_engine.http_request_header_notification.html">Nethttpd_engine.http_request_header_notification</a></h1></center>
<br>
<pre><span class="keyword">class type</span> <a name="TYPEhttp_request_header_notification"></a>http_request_header_notification = <code class="code">object</code> <a href="Nethttpd_engine.http_request_header_notification.html">..</a> <code class="code">end</code></pre><hr width="100%">
<a name="2_Notificationthatanewrequestheaderhasarrived"></a>
<h2>Notification that a new request header has arrived</h2>
<p>
This object notifies the user that a new request header has arrived.
The header is accessible by the <code class="code">environment</code> object. The channels
also contained in this object are locked at this moment. The user must
now either call <code class="code">schedule_accept_body</code> or <code class="code">schedule_reject_body</code>. The
user will get a second notification (a <code class="code">http_request_notification</code>, below)
when the request body has completely arrived (in case of acceptance), or
immediately (in case of rejection). One can also call <code class="code">schedule_finish</code>
at any time to drop the current request.<pre><span class="keyword">method</span> <a name="METHODreq_state"></a>req_state : <code class="type"><a href="Nethttpd_engine.html#TYPEengine_req_state">engine_req_state</a></code></pre><div class="info">
Returns the request processing state which is <code class="code">`Received_header</code> at the
moment when this notification is delivered.<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODenvironment"></a>environment : <code class="type"><a href="Nethttpd_engine.extended_async_environment.html">extended_async_environment</a></code></pre><div class="info">
The request environment. Depending on the request processing state, parts
of the environment are already set up or still unaccessible ("locked").
In the state <code class="code">`Received_header</code> only the request header and the
derived fields are accessible, and the input and output channels are
locked. In the state <code class="code">`Receiving_body</code> the input channel is unlocked,
but it is not yet filled (reading from it may cause the exception
<code class="code">Buffer_underrun</code>). The output channel remains locked.
In the state <code class="code">`Received_request</code>, the input channel is unlocked and filled
with data, and the output channel is unlocked, too.
<p>
This environment is not fully CGI-compatible. In particular, the following
differences exist:<ul>
<li>There is no <code class="code">cgi_path_info</code> and no <code class="code">cgi_path_translated</code>.</li>
<li>The user is always unauthenticated.</li>
<li>The <code class="code">Status</code> response header works as in CGI. The <code class="code">Location</code> header, however,
must be a full URL when set (only browser redirects)</li>
<li>When the request body is transmitted by chunked encoding, the header
<code class="code">Content-Length</code> is not set. In CGI this is interpreted as missing body.
It is unlikely that clients send requests with chunked encoding, as this
may cause interoperability problems anyway.
</li>
</ul>
<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODschedule_accept_body"></a>schedule_accept_body : <code class="type">on_request:(<a href="Nethttpd_engine.http_request_notification.html">http_request_notification</a> -> unit) -><br> ?on_error:(unit -> unit) -> unit -> unit</code></pre><div class="info">
Schedules that the request body is accepted. In terms of HTTP, this sends the
"100 Continue" response when necessary. One can reply with a positive or
negative message.
<p>
This method returns immediately, and sets callbacks for certain events.
When the body has completely arrived (or is empty), the function
<code class="code">on_request</code> is called back. The argument is the full request notification
(see below).
<p>
When the request is dropped for some reason, <code class="code">on_error</code> is called back instead.
This can be used to free resources, for example.
<p>
Neither of the callbacks must raise exceptions.<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODschedule_reject_body"></a>schedule_reject_body : <code class="type">on_request:(<a href="Nethttpd_engine.http_request_notification.html">http_request_notification</a> -> unit) -><br> ?on_error:(unit -> unit) -> unit -> unit</code></pre><div class="info">
Schedules that the request body is rejected. In terms of HTTP, this prevents
sending the "100 Continue" response. Any arriving request body is silently
discarded. One should immediately reply with an error mesage.
negative message.
<p>
This method returns immediately, and sets callbacks for certain events.
When the body has completely arrived (or is empty), the function
<code class="code">on_request</code> is called back. The argument is the full request notification
(see below).
<p>
When the request is dropped for some reason, <code class="code">on_error</code> is called back instead.
This can be used to free resources, for example.
<p>
Neither of the callbacks must raise exceptions.<br>
</div>
<pre><span class="keyword">method</span> <a name="METHODschedule_finish"></a>schedule_finish : <code class="type">unit -> unit</code></pre><div class="info">
Schedules that the request is finished. This method should be called after
the regular processing of the request to ensure that the HTTP protocol
is fulfilled. If the request body has not been
fully read, this is now done, and its data are dropped. If the response
is incomplete, it is completed. If the error is not recoverable, a "Server
Error" is generated.<br>
</div>
</body></html>
|
