| rev |
line source |
|
jbe@0
|
1
|
|
jbe@0
|
2 Moonbridge reference
|
|
jbe@0
|
3 ====================
|
|
jbe@0
|
4
|
|
jbe@0
|
5
|
|
jbe@0
|
6
|
|
jbe@52
|
7 Global function listen{...}
|
|
jbe@0
|
8 ---------------------------
|
|
jbe@0
|
9
|
|
jbe@0
|
10 This function initializes the Moonbridge Network Server. It may be called
|
|
jbe@0
|
11 multiple times. However, it is not allowed to register additional listeners by
|
|
jbe@0
|
12 calling listen(...) from a "prepare", "connect", or "finish" handler.
|
|
jbe@0
|
13
|
|
jbe@0
|
14 See file "example.lua" for parametrization of the listen(...) function.
|
|
jbe@0
|
15
|
|
jbe@0
|
16 Warning: Moonbridge will fork the Lua environment to handle parallel requests.
|
|
jbe@0
|
17 Functions provided as "prepare", "connect", and "finish" handlers may access
|
|
jbe@0
|
18 global variables, but for every child process these global variables will not
|
|
jbe@0
|
19 be shared! If you require a global state, a DBMS, cache server, or similar is
|
|
jbe@0
|
20 necessary.
|
|
jbe@0
|
21
|
|
jbe@0
|
22
|
|
jbe@0
|
23
|
|
jbe@50
|
24 Global function timeout(...)
|
|
jbe@50
|
25 ----------------------------
|
|
jbe@50
|
26
|
|
jbe@50
|
27 Calling this function with a positive number (time in seconds) sets a timer
|
|
jbe@50
|
28 that kills the current process after the selected time runs out. The remaining
|
|
jbe@50
|
29 time can be queried by calling this function without arguments.
|
|
jbe@50
|
30
|
|
jbe@50
|
31 Calling this function with a single argument that is the number zero will
|
|
jbe@50
|
32 disable the timeout.
|
|
jbe@50
|
33
|
|
jbe@50
|
34 Another mode of operation is selected by passing two arguments: a time (in
|
|
jbe@50
|
35 seconds) as first argument and a function as second argument. In this case, a
|
|
jbe@50
|
36 sub-timer will be used to limit the execution time of the function. In case of
|
|
jbe@50
|
37 timeout, the process will be killed (and the timeout function does not return).
|
|
jbe@50
|
38 If the time for the sub-timer is longer than a previously set timeout (using
|
|
jbe@50
|
39 the timeout(...) function with one argument), the shorter timeout (of the
|
|
jbe@50
|
40 previous call of timeout(...)) will have precedence.
|
|
jbe@50
|
41
|
|
jbe@52
|
42 Timers are also automatically reset (disabled) when a handler (prepare handler
|
|
jbe@52
|
43 or connect handler) returns. To shutdown processes after a certain time waiting
|
|
jbe@52
|
44 for a new request, use the idle_time parameter of the listen function.
|
|
jbe@52
|
45
|
|
jbe@50
|
46
|
|
jbe@50
|
47
|
|
jbe@66
|
48 Function io.poll(read_fds, write_fds, timeout)
|
|
jbe@66
|
49 ----------------------------------------------
|
|
jbe@66
|
50
|
|
jbe@66
|
51 This function allows to wait for file descriptors to become ready for reading
|
|
jbe@66
|
52 or writing. It accepts the following arguments:
|
|
jbe@66
|
53
|
|
jbe@66
|
54 1. Table of file descriptors to wait for reading (optional, may be nil)
|
|
jbe@66
|
55 2. Table of file descriptors to wait for writing (optional, may be nil)
|
|
jbe@66
|
56 3. Timeout in seconds (optional, may be nil or zero to disable timeout)
|
|
jbe@66
|
57
|
|
jbe@66
|
58 Alternatively to file descriptors, the tables may contain file handles (in
|
|
jbe@66
|
59 which case the file descriptor is automatically extracted).
|
|
jbe@66
|
60
|
|
jbe@66
|
61 Please note that support for non-blocking I/O operations is limited if you use
|
|
jbe@66
|
62 ordinary file handles (as Moonbridge does). It is possible, however, to wait
|
|
jbe@66
|
63 until the first byte to read is available at a file handle. For more
|
|
jbe@66
|
64 information, see socket.input:pending().
|
|
jbe@66
|
65
|
|
jbe@66
|
66
|
|
jbe@66
|
67
|
|
jbe@0
|
68 Socket object passed to "connect" handler
|
|
jbe@0
|
69 -----------------------------------------
|
|
jbe@0
|
70
|
|
jbe@0
|
71 For every incoming connection, the registered "connect" handler is called with
|
|
jbe@0
|
72 a single socket object as argument, which is described below:
|
|
jbe@0
|
73
|
|
jbe@0
|
74
|
|
jbe@0
|
75 ### socket:cancel()
|
|
jbe@0
|
76
|
|
jbe@0
|
77 Closes the socket connection by sending a TCP RST package if possible to
|
|
jbe@43
|
78 indicate error condition. Returns true on success, or nil plus error message in
|
|
jbe@43
|
79 case of an I/O error. Using this method on sockets that have already been
|
|
jbe@43
|
80 closed (or canceled) will throw an error.
|
|
jbe@0
|
81
|
|
jbe@0
|
82 Warning: Previously sent (and flushed) data may be lost during transmission.
|
|
jbe@0
|
83
|
|
jbe@0
|
84
|
|
jbe@0
|
85 ### socket:close(timeout)
|
|
jbe@0
|
86
|
|
jbe@0
|
87 Closes the socket connection (input and output stream) by flushing all data and
|
|
jbe@43
|
88 sending a TCP FIN package. Returns true on success, or nil plus error message
|
|
jbe@43
|
89 in case of an I/O error. Using this method on sockets that have already been
|
|
jbe@43
|
90 closed (or canceled) will throw an error.
|
|
jbe@0
|
91
|
|
jbe@0
|
92 Warning: Pending data on the input stream may cause connection aborts (TCP RST)
|
|
jbe@0
|
93 depending on the particular operating system used. All pending input data
|
|
jbe@0
|
94 should have been read before calling socket:close().
|
|
jbe@0
|
95
|
|
jbe@0
|
96 The optional timeout parameter may be used to wait until all data has been sent
|
|
jbe@0
|
97 out, or until the timeout elapses (in which case a TCP RST is sent) whichever
|
|
jbe@0
|
98 happens first. A timeout value of 0 or nil causes immediate return and sending
|
|
jbe@0
|
99 of pending data in background (recommended).
|
|
jbe@0
|
100
|
|
jbe@0
|
101
|
|
jbe@0
|
102 ### socket:flush()
|
|
jbe@0
|
103
|
|
jbe@0
|
104 Alias for socket.output:flush()
|
|
jbe@0
|
105
|
|
jbe@0
|
106
|
|
jbe@0
|
107 ### socket.input
|
|
jbe@0
|
108
|
|
jbe@0
|
109 Lua file handle representing the input stream of the socket connection.
|
|
jbe@0
|
110 Supports the same methods as io.open()'s return values.
|
|
jbe@0
|
111
|
|
jbe@0
|
112
|
|
jbe@66
|
113 ### socket.input:pending()
|
|
jbe@66
|
114
|
|
jbe@66
|
115 Returns true if there is at least one byte to read. In case of I/O errors, true
|
|
jbe@66
|
116 is returned as well (to avoid lockup and cause error on subsequent read).
|
|
jbe@66
|
117
|
|
jbe@66
|
118 Note: Subsequent calls of socket.input:read(...) or socket.input:readuntil(...)
|
|
jbe@66
|
119 may still block when attempting to read more than one byte. To avoid hanging
|
|
jbe@66
|
120 processes, the timeout(...) function may be used as a watchdog that will
|
|
jbe@66
|
121 terminate the process in case of unexpected delay. Because file handles are
|
|
jbe@66
|
122 buffered, data may be still pending even if the underlaying file descriptor
|
|
jbe@66
|
123 does not have any more data to read. Thus, all file handles passed to
|
|
jbe@66
|
124 io.poll(...) to wait for reading should be tested for pending data first.
|
|
jbe@66
|
125
|
|
jbe@66
|
126 This method is also available as :pending() for any other Lua file handle.
|
|
jbe@66
|
127
|
|
jbe@66
|
128
|
|
jbe@66
|
129 ### socket.input:readuntil(terminator, maxlen)
|
|
jbe@66
|
130
|
|
jbe@66
|
131 Reads as many bytes until a byte equal to the terminator value occurs. An
|
|
jbe@66
|
132 optional maximum length may be specified. The terminating byte is included in
|
|
jbe@66
|
133 the return value (unless the maximum length would be exceeded). On EOF, nil is
|
|
jbe@66
|
134 returned. In case of an I/O error, nil (as first result value) plus an error
|
|
jbe@66
|
135 message (as second result value) is returned.
|
|
jbe@66
|
136
|
|
jbe@66
|
137 Note: This function may provide a significant speedup compared to byte-wise
|
|
jbe@66
|
138 reading using socket.input:read(1) in a loop. However, this function will block
|
|
jbe@66
|
139 when no data is available. The timeout(...) function may be used as a watchdog
|
|
jbe@66
|
140 that will terminate the process in case of unexpected delay.
|
|
jbe@66
|
141
|
|
jbe@66
|
142 This method is also available as :readuntil(...) for any other Lua file handle.
|
|
jbe@66
|
143
|
|
jbe@66
|
144
|
|
jbe@0
|
145 ### socket.interval
|
|
jbe@0
|
146
|
|
jbe@0
|
147 Set to the name of an interval timer if the "connect" handler was called due to
|
|
jbe@0
|
148 an elapsed interval timer. Otherwise nil.
|
|
jbe@0
|
149
|
|
jbe@0
|
150
|
|
jbe@0
|
151 ### socket:lines()
|
|
jbe@0
|
152
|
|
jbe@0
|
153 Alias for socket.input:lines()
|
|
jbe@0
|
154
|
|
jbe@0
|
155
|
|
jbe@0
|
156 ### socket.local_ip4
|
|
jbe@0
|
157
|
|
jbe@0
|
158 Local IPv4 address used for the connection. Encoded as 4 raw bytes in form of a
|
|
jbe@0
|
159 string.
|
|
jbe@0
|
160
|
|
jbe@0
|
161
|
|
jbe@0
|
162 ### socket.local_ip6
|
|
jbe@0
|
163
|
|
jbe@0
|
164 Local IPv6 address used for the connection. Encoded as 16 raw bytes in form of
|
|
jbe@0
|
165 a string.
|
|
jbe@0
|
166
|
|
jbe@0
|
167
|
|
jbe@0
|
168 ### socket.local_tcpport
|
|
jbe@0
|
169
|
|
jbe@0
|
170 Local TCP port used for the connection.
|
|
jbe@0
|
171
|
|
jbe@0
|
172
|
|
jbe@0
|
173 ### socket.output
|
|
jbe@0
|
174
|
|
jbe@0
|
175 Lua file handle representing the output stream of the socket connection.
|
|
jbe@0
|
176 Supports the same methods as io.open()'s return values.
|
|
jbe@0
|
177
|
|
jbe@0
|
178
|
|
jbe@66
|
179 ### socket.output:close()
|
|
jbe@66
|
180
|
|
jbe@66
|
181 Performs a half-close (i.e. sends a TCP FIN package in case of a TCP socket).
|
|
jbe@66
|
182
|
|
jbe@66
|
183 Note: In order to shut down a TCP connection properly, it may be necessary to
|
|
jbe@66
|
184 read any pending data from socket.input before closing the socket completely
|
|
jbe@66
|
185 (e.g. with socket:close() or by returning from the connect handler). If there
|
|
jbe@66
|
186 is still incoming data, a TCP RST packet might be sent which can cause loss of
|
|
jbe@66
|
187 transmitted data.
|
|
jbe@66
|
188
|
|
jbe@66
|
189
|
|
jbe@0
|
190 ### socket:read(...)
|
|
jbe@0
|
191
|
|
jbe@0
|
192 Alias for socket.input:read()
|
|
jbe@0
|
193
|
|
jbe@0
|
194
|
|
jbe@0
|
195 ### socket:readuntil(terminator, maxlen)
|
|
jbe@0
|
196
|
|
jbe@66
|
197 Alias for socket.input:readuntil(terminator, maxlen)
|
|
jbe@0
|
198
|
|
jbe@0
|
199
|
|
jbe@0
|
200 ### socket.remote_ip4
|
|
jbe@0
|
201
|
|
jbe@0
|
202 Remote IPv4 address used for the connection. Encoded as 4 raw bytes in form of
|
|
jbe@0
|
203 a string.
|
|
jbe@0
|
204
|
|
jbe@0
|
205
|
|
jbe@0
|
206 ### socket.remote_ip6
|
|
jbe@0
|
207
|
|
jbe@0
|
208 Remote IPv6 address used for the connection. Encoded as 16 raw bytes in form of
|
|
jbe@0
|
209 a string.
|
|
jbe@0
|
210
|
|
jbe@0
|
211
|
|
jbe@0
|
212 ### socket.remote_tcpport
|
|
jbe@0
|
213
|
|
jbe@0
|
214 Remote TCP port used for the connection.
|
|
jbe@0
|
215
|
|
jbe@0
|
216
|
|
jbe@0
|
217 ### socket:write(...)
|
|
jbe@0
|
218
|
|
jbe@0
|
219 Alias for socket.output:write(...)
|
|
jbe@0
|
220
|
|
jbe@0
|
221
|
|
jbe@0
|
222
|
|
jbe@0
|
223 HTTP module
|
|
jbe@0
|
224 -----------
|
|
jbe@0
|
225
|
|
jbe@0
|
226 The http module exports the function http.generate_handler(callback) that
|
|
jbe@0
|
227 converts an HTTP handler to a "connect" handler. See file "example.lua" for an
|
|
jbe@0
|
228 example of invocation. A table with options may be passed either as a second
|
|
jbe@0
|
229 argument, or as a first argument preceeding the callback function (whichever is
|
|
jbe@0
|
230 more convenient).
|
|
jbe@0
|
231
|
|
jbe@0
|
232 The following options are supported:
|
|
jbe@0
|
233
|
|
jbe@0
|
234 - request_body_size_limit: maximum size of payload of HTTP request body
|
|
jbe@0
|
235 (transfer encoding is allowed to add a limited amount of extra data)
|
|
jbe@0
|
236 - chunk_size: optional default value for maximum_input_chunk_size and
|
|
jbe@0
|
237 minimum_output_chunk_size
|
|
jbe@0
|
238 - request_header_size_limit: maximum size of HTTP request headers
|
|
jbe@0
|
239 - maximum_input_chunk_size: maximum chunk size when streaming a request body or
|
|
jbe@0
|
240 certain POST fields (bigger chunks will be fragmented automatically)
|
|
jbe@0
|
241 - minimum_output_chunk_size: minimum size for a chunk when sending a response
|
|
jbe@0
|
242 body (smaller chunks will be buffered and concatenated with future data;
|
|
jbe@0
|
243 ignored when request:flush() is called)
|
|
jbe@0
|
244 - static_headers: a set of headers to be included in every HTTP response
|
|
jbe@0
|
245 (may be a string, a table or strings, or a table of key-value pairs)
|
|
jbe@0
|
246
|
|
jbe@0
|
247 The callback function receives a single request object as argument, which is
|
|
jbe@0
|
248 described below.
|
|
jbe@0
|
249
|
|
jbe@0
|
250
|
|
jbe@0
|
251 ### request.body
|
|
jbe@0
|
252
|
|
jbe@0
|
253 The request body (without headers) as a string. Accessing this value makes
|
|
jbe@0
|
254 further access to request.post_params and request.post_params_list, or
|
|
jbe@0
|
255 invocation of request:stream_request_body(...) impossible.
|
|
jbe@0
|
256
|
|
jbe@0
|
257
|
|
jbe@60
|
258 ### request:close_after_finish()
|
|
jbe@60
|
259
|
|
jbe@60
|
260 Closes the connection after answering the request.
|
|
jbe@60
|
261
|
|
jbe@60
|
262 This method can only be called before the HTTP response header section has been
|
|
jbe@60
|
263 finished (i.e. before request:finish_headers(), request:send_data(...), or
|
|
jbe@60
|
264 request:finish() were called), but it may be called before a status code has
|
|
jbe@60
|
265 been sent using request:send_status(...).
|
|
jbe@60
|
266
|
|
jbe@60
|
267 A corresponding "Connection: close" header is automatically sent.
|
|
jbe@60
|
268
|
|
jbe@60
|
269
|
|
jbe@0
|
270 ### request.cookies
|
|
jbe@0
|
271
|
|
jbe@0
|
272 A table with all cookies sent by the client.
|
|
jbe@0
|
273
|
|
jbe@0
|
274
|
|
jbe@0
|
275 ### request.defer_reading()
|
|
jbe@0
|
276
|
|
jbe@0
|
277 Disables automatic request body processing on write. Can be called before
|
|
jbe@0
|
278 sending a HTTP status code to send a response before the request has been fully
|
|
jbe@0
|
279 received.
|
|
jbe@0
|
280
|
|
jbe@0
|
281 CAUTION: Responding to a request before the request body has been processed may
|
|
jbe@0
|
282 lead to a deadlock if the browser does not process the response while trying to
|
|
jbe@0
|
283 send the request. Therefore, this function should only be used if:
|
|
jbe@0
|
284
|
|
jbe@0
|
285 - the TCP stack has enough buffer space for the response (i.e. if the response
|
|
jbe@0
|
286 is small enough), and if
|
|
jbe@0
|
287 - a timer is used to cancel the response in case of a deadlock.
|
|
jbe@0
|
288
|
|
jbe@0
|
289 It is recommended to not use this function unless certain performance tweaks
|
|
jbe@0
|
290 are desired.
|
|
jbe@0
|
291
|
|
jbe@0
|
292
|
|
jbe@50
|
293 ### request.faulty
|
|
jbe@50
|
294
|
|
jbe@50
|
295 Normally set to false. In case of a read or write error on the client
|
|
jbe@50
|
296 connection, this value is set to true before a Lua error is raised.
|
|
jbe@50
|
297
|
|
jbe@50
|
298 A faulty request handle must not be used, or another Lua error will be raised.
|
|
jbe@50
|
299
|
|
jbe@50
|
300
|
|
jbe@0
|
301 ### request:finish()
|
|
jbe@0
|
302
|
|
jbe@0
|
303 Finishes and flushes a HTTP response. May be called multiple times. An
|
|
jbe@0
|
304 HTTP status, all headers, and the response body (if applicable) must have been
|
|
jbe@0
|
305 previously sent. After calling this method, no further data may be written.
|
|
jbe@0
|
306
|
|
jbe@0
|
307
|
|
jbe@0
|
308 ### request:finish_headers()
|
|
jbe@0
|
309
|
|
jbe@0
|
310 Finishes and flushes the HTTP response header section. May be called multiple
|
|
jbe@0
|
311 times, as long as the request is not finished completely. This method is
|
|
jbe@0
|
312 automatically invoked if the application is beginning to send a response body.
|
|
jbe@0
|
313 After calling this method, no further headers may be sent.
|
|
jbe@0
|
314
|
|
jbe@0
|
315
|
|
jbe@0
|
316 ### request:flush()
|
|
jbe@0
|
317
|
|
jbe@0
|
318 Flushes any pending output data. Note: In order to mark the end of a response
|
|
jbe@0
|
319 body, it is required to call request:finish().
|
|
jbe@0
|
320
|
|
jbe@0
|
321
|
|
jbe@0
|
322 ### request.get_params
|
|
jbe@0
|
323
|
|
jbe@0
|
324 A table that maps field names to their corresponding GET value. If there are
|
|
jbe@0
|
325 several GET values with the given field name, then the first value is used.
|
|
jbe@0
|
326
|
|
jbe@35
|
327 Note: May be implemented through metamethods, but does support iteration
|
|
jbe@35
|
328 through pairs(...).
|
|
jbe@35
|
329
|
|
jbe@0
|
330
|
|
jbe@0
|
331 ### request.get_params_list
|
|
jbe@0
|
332
|
|
jbe@0
|
333 A table that maps field names to a sequence of their corresponding GET values.
|
|
jbe@0
|
334
|
|
jbe@35
|
335 Note: May be implemented through metamethods, but does support iteration
|
|
jbe@35
|
336 through pairs(...).
|
|
jbe@35
|
337
|
|
jbe@0
|
338
|
|
jbe@0
|
339 ### request.headers
|
|
jbe@0
|
340
|
|
jbe@0
|
341 A table that maps (case-insensitively) a HTTP header field name to a sequence
|
|
jbe@0
|
342 of values. One entry is created for every occurrence of a header line with the
|
|
jbe@0
|
343 given field name).
|
|
jbe@0
|
344
|
|
jbe@0
|
345
|
|
jbe@0
|
346 ### request.headers_csv_string
|
|
jbe@0
|
347
|
|
jbe@0
|
348 A table that maps (case-insensitively) a HTTP header field name to a comma
|
|
jbe@0
|
349 separated string. Multiple occurrences of the header with the given field name
|
|
jbe@0
|
350 are automatically merged into the comma separated string.
|
|
jbe@0
|
351
|
|
jbe@0
|
352
|
|
jbe@0
|
353 ### request.headers_csv_table
|
|
jbe@0
|
354
|
|
jbe@0
|
355 A table that maps (case-insensitively) a HTTP header field name to a sequence
|
|
jbe@0
|
356 of values. One entry is created for every comma separated value of each header
|
|
jbe@0
|
357 with the given field name.
|
|
jbe@0
|
358
|
|
jbe@0
|
359
|
|
jbe@0
|
360 ### request.headers_flags
|
|
jbe@0
|
361
|
|
jbe@0
|
362 A table that maps (case-insensitively) a HTTP header field name to another
|
|
jbe@0
|
363 table which (again case-insensitively) maps a string to a boolean, depending on
|
|
jbe@0
|
364 whether this string occurred in the list of comma separated values of one
|
|
jbe@0
|
365 header line with the given field name that was the key in the first table.
|
|
jbe@0
|
366
|
|
jbe@0
|
367
|
|
jbe@0
|
368 ### request.headers_value
|
|
jbe@0
|
369
|
|
jbe@0
|
370 A table that maps (case-insensitively) a HTTP header field name to a value. If
|
|
jbe@0
|
371 multiple header lines with the given field name have been received, false is
|
|
jbe@0
|
372 used as value.
|
|
jbe@0
|
373
|
|
jbe@0
|
374
|
|
jbe@0
|
375 ### request.method
|
|
jbe@0
|
376
|
|
jbe@0
|
377 The HTTP request method, e.g. "HEAD", "GET", or "POST".
|
|
jbe@0
|
378
|
|
jbe@0
|
379
|
|
jbe@0
|
380 ### request.path
|
|
jbe@0
|
381
|
|
jbe@10
|
382 The requested path without a leading slash and without the query part (e.g.
|
|
jbe@10
|
383 "index.html" if "/index.html?a=b&c=d" has been requested). For the query part,
|
|
jbe@10
|
384 see request.query.
|
|
jbe@10
|
385
|
|
jbe@10
|
386 This value will be nil if (and only if) the request method is "OPTIONS" with a
|
|
jbe@10
|
387 request target equal to "*" (see also asterisk-form of request-target in
|
|
jbe@10
|
388 section 5.3.4 in RFC 7230).
|
|
jbe@0
|
389
|
|
jbe@0
|
390
|
|
jbe@0
|
391 ### request.post_metadata
|
|
jbe@0
|
392
|
|
jbe@0
|
393 Only set for multipart/form-data POST requests. A table that maps field names
|
|
jbe@0
|
394 to their corresponding POST metadata table which contains two entries:
|
|
jbe@0
|
395 "file_name" and "content_type". If there are several POST values with the given
|
|
jbe@0
|
396 field name, then the first value/file is used.
|
|
jbe@0
|
397
|
|
jbe@0
|
398
|
|
jbe@0
|
399 ### request.post_metadata_list
|
|
jbe@0
|
400
|
|
jbe@0
|
401 Only set for multipart/form-data POST requests. A table that maps field names
|
|
jbe@0
|
402 to a sequence with their corresponding POST metadata tables. Needed if multiple
|
|
jbe@0
|
403 files are uploaded with the same field name.
|
|
jbe@0
|
404
|
|
jbe@0
|
405
|
|
jbe@0
|
406 ### request.post_params
|
|
jbe@0
|
407
|
|
jbe@0
|
408 A table that maps field names to their corresponding POST value. If there are
|
|
jbe@0
|
409 several POST values with the given field name, then the first value is used.
|
|
jbe@0
|
410
|
|
jbe@35
|
411 Note: May be implemented through metamethods, but does support iteration
|
|
jbe@35
|
412 through pairs(...).
|
|
jbe@35
|
413
|
|
jbe@0
|
414
|
|
jbe@0
|
415 ### request.post_params_list
|
|
jbe@0
|
416
|
|
jbe@0
|
417 A table that maps field names to a sequence of their corresponding POST values.
|
|
jbe@0
|
418
|
|
jbe@35
|
419 Note: May be implemented through metamethods, but does support iteration
|
|
jbe@35
|
420 through pairs(...).
|
|
jbe@35
|
421
|
|
jbe@0
|
422
|
|
jbe@0
|
423 ### request.query
|
|
jbe@0
|
424
|
|
jbe@12
|
425 Query part of the request target including the leading question mark, e.g.
|
|
jbe@12
|
426 "?a=b&c=d" if the requested target is "/index.html?a=b&c=d". The data is
|
|
jbe@10
|
427 automatically parsed and made available through request.get_params and
|
|
jbe@10
|
428 request.get_params_list.
|
|
jbe@10
|
429
|
|
jbe@10
|
430 If there is no query part given in the request target, then this string is
|
|
jbe@10
|
431 the empty string. This value will be nil if (and only if) the request method
|
|
jbe@10
|
432 is "OPTIONS" with a request target equal to "*" (see also asterisk-form of
|
|
jbe@10
|
433 request-target in section 5.3.4 in RFC 7230).
|
|
jbe@0
|
434
|
|
jbe@0
|
435
|
|
jbe@0
|
436 ### request:process_request_body()
|
|
jbe@0
|
437
|
|
jbe@0
|
438 Starts processing the request body (if existent) to set the values
|
|
jbe@0
|
439 request.post_params, request.post_params_list, request.post_metadata, and
|
|
jbe@0
|
440 and request.post_metadata_list and/or to call POST field stream handlers that
|
|
jbe@0
|
441 have been previously registered with request:stream_post_param(...) or
|
|
jbe@0
|
442 request:stream_post_params(...).
|
|
jbe@0
|
443
|
|
jbe@0
|
444 This method gets invoked automatically when the POST param tables
|
|
jbe@0
|
445 (request.post_params, etc.) are accessed, or if a response is sent (to avoid
|
|
jbe@0
|
446 deadlocks with the webbrowser). (Note: Automatic request body processing on
|
|
jbe@0
|
447 write may be disabled by calling request:defer_reading().)
|
|
jbe@0
|
448
|
|
jbe@0
|
449 After this method returned, all registered POST field stream handlers have
|
|
jbe@0
|
450 received all data. Registration of other POST field stream handlers is not
|
|
jbe@0
|
451 possible after this method has been called (or after request.post_params_list
|
|
jbe@0
|
452 or request.post_params have been accessed).
|
|
jbe@0
|
453
|
|
jbe@0
|
454
|
|
jbe@0
|
455 ### request:send_data(...)
|
|
jbe@0
|
456
|
|
jbe@0
|
457 Sends data as response body. All arguments are converted via tostring(...) and
|
|
jbe@0
|
458 concatenated. May be called multiple times until the request has been finished
|
|
jbe@0
|
459 by calling request:finish().
|
|
jbe@0
|
460
|
|
jbe@0
|
461 If the request method (see request.method) is "HEAD", then calls to
|
|
jbe@0
|
462 request:send_data(...) are automatically ignored.
|
|
jbe@0
|
463
|
|
jbe@0
|
464
|
|
jbe@0
|
465 ### request:send_header(key, value)
|
|
jbe@0
|
466
|
|
jbe@0
|
467 Sends a HTTP response header that consists of the given key and the given
|
|
jbe@0
|
468 value. Note: Key and value must be provided as separate arguments. Before any
|
|
jbe@0
|
469 headers can be sent, a HTTP status must have been set with
|
|
jbe@0
|
470 request:send_status(status_string).
|
|
jbe@0
|
471
|
|
jbe@0
|
472
|
|
jbe@0
|
473 ### request:send_status(status_string)
|
|
jbe@0
|
474
|
|
jbe@0
|
475 Sends a HTTP response status that is given as a string consisting of a 3-digit
|
|
jbe@0
|
476 number and an explanatory string, e.g. "200 OK" or "404 Not Found". This
|
|
jbe@0
|
477 function must be called once before any headers or response body data may be
|
|
jbe@0
|
478 sent.
|
|
jbe@0
|
479
|
|
jbe@0
|
480
|
|
jbe@0
|
481 ### request.socket
|
|
jbe@0
|
482
|
|
jbe@0
|
483 The underlaying socket. Can be used to force a TCP RST, etc.
|
|
jbe@0
|
484
|
|
jbe@0
|
485
|
|
jbe@0
|
486 ### request:stream_post_param(field_name, callback)
|
|
jbe@0
|
487
|
|
jbe@0
|
488 Registers a stream handler for the given POST parameter. The callback function
|
|
jbe@0
|
489 will be called in the following manner:
|
|
jbe@0
|
490
|
|
jbe@0
|
491 - For the initial chunk, the first chunk gets passed as first argument while a
|
|
jbe@0
|
492 table with metadata ("field_name" and "content_type") gets passed as second
|
|
jbe@0
|
493 argument. In case of an immediate EOF (i.e. an empty file), the passed
|
|
jbe@0
|
494 chunk is the empty string. In all other cases the chunk has a length greater
|
|
jbe@0
|
495 than zero.
|
|
jbe@0
|
496 - For any remaining chunks, the respective chunk gets passed as first and only
|
|
jbe@0
|
497 argument (no metadata). Here, the chunk has always a length greater than
|
|
jbe@0
|
498 zero.
|
|
jbe@0
|
499 - To indicate the end of the stream, the callback function is called without
|
|
jbe@0
|
500 arguments. This also happens in case of an immediate EOF (see above).
|
|
jbe@0
|
501
|
|
jbe@0
|
502 In case of an immediate EOF (i.e. an empty file), the callback function is thus
|
|
jbe@0
|
503 called as follows:
|
|
jbe@0
|
504
|
|
jbe@0
|
505 - The first time with an empty string as first argument, and with the metadata
|
|
jbe@0
|
506 as second argument.
|
|
jbe@0
|
507 - The second time without any arguments.
|
|
jbe@0
|
508
|
|
jbe@0
|
509
|
|
jbe@0
|
510 ### request:stream_post_params(pattern, callback)
|
|
jbe@0
|
511
|
|
jbe@0
|
512 Same as request:stream_post_param(...) but providing a string pattern to match
|
|
jbe@0
|
513 multiple field names (e.g. "^file_[0-9]+$").
|
|
jbe@0
|
514
|
|
jbe@0
|
515
|
|
jbe@0
|
516 ### request:stream_request_body(callback)
|
|
jbe@0
|
517
|
|
jbe@0
|
518 Start streaming of request body. For each chunk of the request body, the
|
|
jbe@0
|
519 callback function is called with the corresponding chunk. End of data is
|
|
jbe@0
|
520 indicated through return of request:stream_request_body(...) (not by calling
|
|
jbe@0
|
521 the callback without arguments).
|
|
jbe@0
|
522
|
|
jbe@44
|
523 The function may be called with nil instead of a callback function. In this
|
|
jbe@44
|
524 case, the request body is read and discarded. Only if nil is passed instead of
|
|
jbe@44
|
525 a callback, then the function may also be invoked when the request body has
|
|
jbe@44
|
526 already been read and/or processed. In the latter case, the function performs
|
|
jbe@44
|
527 no operation.
|
|
jbe@0
|
528
|
|
jbe@44
|
529
|