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@0
|
48 Socket object passed to "connect" handler
|
jbe@0
|
49 -----------------------------------------
|
jbe@0
|
50
|
jbe@0
|
51 For every incoming connection, the registered "connect" handler is called with
|
jbe@0
|
52 a single socket object as argument, which is described below:
|
jbe@0
|
53
|
jbe@0
|
54
|
jbe@94
|
55 ### socket:close()
|
jbe@0
|
56
|
jbe@0
|
57 Closes the socket connection (input and output stream) by flushing all data and
|
jbe@94
|
58 sending a TCP FIN packet.
|
jbe@91
|
59
|
jbe@91
|
60 Returns true on success, or nil plus error message in case of an I/O error.
|
jbe@91
|
61 Using this method on sockets that have already been closed (or reset) will
|
jbe@91
|
62 throw an error.
|
jbe@0
|
63
|
jbe@0
|
64 Warning: Pending data on the input stream may cause connection aborts (TCP RST)
|
jbe@94
|
65 when network connections are used. All pending input data should have been read
|
jbe@94
|
66 (or drained) before calling socket:close(). Use socket:finish() to send a
|
jbe@94
|
67 TCP FIN packet to the peer before waiting for EOF from the peer.
|
jbe@91
|
68
|
jbe@91
|
69
|
jbe@91
|
70 ### socket:drain(maxlen, terminator)
|
jbe@0
|
71
|
jbe@91
|
72 Same as socket:read(maxlen, terminator), but discards the input and returns the
|
jbe@143
|
73 number of discarded bytes (as first return value) and the status code ("term",
|
jbe@143
|
74 "maxlen", "eof" as second return value).
|
jbe@91
|
75
|
jbe@91
|
76 In case of an I/O error, nil (as first return value) plus an error message (as
|
jbe@114
|
77 second return value) are returned.
|
jbe@0
|
78
|
jbe@0
|
79
|
jbe@144
|
80 ### socket:drain_call(waitfunc, maxlen, terminator)
|
jbe@144
|
81
|
jbe@144
|
82 Same as socket:drain(maxlen, terminator), but calls waitfunc(socket, "r") (in
|
jbe@144
|
83 an infinite loop) as long as the reading is blocked.
|
jbe@144
|
84
|
jbe@144
|
85
|
jbe@91
|
86 ### socket:drain_nb(maxlen, terminator)
|
jbe@0
|
87
|
jbe@143
|
88 Same as socket:drain(maxlen, terminator), but non-blocking. The status code
|
jbe@143
|
89 (which is returned as second return value) may therefore be "term", "maxlen",
|
jbe@143
|
90 "eof", or "block".
|
jbe@91
|
91
|
jbe@91
|
92 In case of an I/O error, nil (as first return value) plus an error message (as
|
jbe@114
|
93 second return value) are returned.
|
jbe@91
|
94
|
jbe@0
|
95
|
jbe@144
|
96 ### socket:drain_yield(maxlen, terminator)
|
jbe@144
|
97
|
jbe@144
|
98 Alias for socket:drain_call(coroutine.yield, maxlen, terminator)
|
jbe@144
|
99
|
jbe@144
|
100
|
jbe@94
|
101 ### socket:finish()
|
jbe@94
|
102
|
jbe@94
|
103 Sends a TCP FIN packet to indicate EOF on write stream. Subsequent reads are
|
jbe@94
|
104 still possible. When there is no more input data to be read, the connection
|
jbe@94
|
105 should finally be closed with socket:close().
|
jbe@94
|
106
|
jbe@94
|
107 In case of local sockets (Unix Domain Sockets), socket:finish() simply closes
|
jbe@94
|
108 the underlying socket and emulates EOF on subsequent reads. Also in this case,
|
jbe@94
|
109 the connection should be finally closed with socket:close().
|
jbe@94
|
110
|
jbe@94
|
111
|
jbe@91
|
112 ### socket:flush(...)
|
jbe@91
|
113
|
jbe@91
|
114 Same as socket:write(...) but additionally flushes the socket (i.e. all pending
|
jbe@91
|
115 data is passed to the operating system).
|
jbe@91
|
116
|
jbe@91
|
117 In case of an I/O error, nil (as first return value) plus an error message (as
|
jbe@114
|
118 second return value) are returned. On success, the socket userdata object is
|
jbe@91
|
119 returned.
|
jbe@91
|
120
|
jbe@0
|
121
|
jbe@145
|
122 ### socket:flush_call(waitfunc, ...)
|
jbe@145
|
123
|
jbe@152
|
124 Same as socket:flush(...), but calls waitfunc() (in an infinite loop) as long
|
jbe@152
|
125 as the writing is blocked.
|
jbe@145
|
126
|
jbe@145
|
127
|
jbe@91
|
128 ### socket:flush_nb(...)
|
jbe@91
|
129
|
jbe@91
|
130 Same as socket:write_nb(...) but additionally flushes the socket (i.e. all
|
jbe@91
|
131 pending data is passed to the operating system). The total number of bytes that
|
jbe@91
|
132 could not be passed yet to the operating system is returned. Zero is returned
|
jbe@91
|
133 if all data could be flushed out.
|
jbe@91
|
134
|
jbe@91
|
135 In case of an I/O error, nil (as first return value) plus an error message (as
|
jbe@114
|
136 second return value) are returned.
|
jbe@0
|
137
|
jbe@0
|
138
|
jbe@145
|
139 ### socket:flush_yield(...)
|
jbe@145
|
140
|
jbe@145
|
141 Alias for socket:flush_call(coroutine.yield, ...)
|
jbe@145
|
142
|
jbe@145
|
143
|
jbe@0
|
144 ### socket.interval
|
jbe@0
|
145
|
jbe@0
|
146 Set to the name of an interval timer if the "connect" handler was called due to
|
jbe@0
|
147 an elapsed interval timer. Otherwise nil.
|
jbe@0
|
148
|
jbe@0
|
149
|
jbe@0
|
150 ### socket.local_ip4
|
jbe@0
|
151
|
jbe@0
|
152 Local IPv4 address used for the connection. Encoded as 4 raw bytes in form of a
|
jbe@0
|
153 string.
|
jbe@0
|
154
|
jbe@0
|
155
|
jbe@0
|
156 ### socket.local_ip6
|
jbe@0
|
157
|
jbe@0
|
158 Local IPv6 address used for the connection. Encoded as 16 raw bytes in form of
|
jbe@0
|
159 a string.
|
jbe@0
|
160
|
jbe@0
|
161
|
jbe@0
|
162 ### socket.local_tcpport
|
jbe@0
|
163
|
jbe@0
|
164 Local TCP port used for the connection.
|
jbe@0
|
165
|
jbe@0
|
166
|
jbe@91
|
167 ### socket:read(maxlen, terminator)
|
jbe@0
|
168
|
jbe@143
|
169 Reads up to maxlen bytes or until an optional termination character is
|
jbe@91
|
170 encountered (which is included in the result). The maxlen value may be nil, in
|
jbe@91
|
171 which case there is no limit on the number of bytes read.
|
jbe@0
|
172
|
jbe@91
|
173 In case of an I/O error, nil (as first return value) plus an error message (as
|
jbe@114
|
174 second return value) are returned.
|
jbe@0
|
175
|
jbe@143
|
176 In all other cases (including EOF), the following two values are returned:
|
jbe@143
|
177
|
jbe@143
|
178 - a string containing the bytes read (first return value, may be empty string)
|
jbe@143
|
179 - a status code equal to "term", "maxlen", or "eof" (second return value)
|
jbe@143
|
180
|
jbe@143
|
181 If an EOF is encountered before all data could be read, then "eof" is returned
|
jbe@143
|
182 as second return value. If maxlen bytes have been read and no termination
|
jbe@143
|
183 character has been read, then "maxlen" is returned as second return value. If
|
jbe@143
|
184 the termination character is the last character of the read string, the second
|
jbe@143
|
185 return value will be "term".
|
jbe@143
|
186
|
jbe@0
|
187
|
jbe@140
|
188 ### socket:read_call(waitfunc, maxlen, terminator)
|
jbe@140
|
189
|
jbe@152
|
190 Same as socket:read(maxlen, terminator), but calls waitfunc() (in an infinite
|
jbe@152
|
191 loop) as long as the reading is blocked.
|
jbe@140
|
192
|
jbe@140
|
193
|
jbe@91
|
194 ### socket:read_nb(maxlen, terminator)
|
jbe@91
|
195
|
jbe@143
|
196 Same as socket:read(maxlen, terminator), but does not block.
|
jbe@91
|
197
|
jbe@91
|
198 In case of an I/O error, nil (as first return value) plus an error message (as
|
jbe@114
|
199 second return value) are returned.
|
jbe@78
|
200
|
jbe@143
|
201 In all other cases (including EOF), the following two values are returned:
|
jbe@143
|
202
|
jbe@143
|
203 - a string containing the bytes read (first return value, may be empty string)
|
jbe@143
|
204 - a status code equal to "term", "maxlen", "eof", "block" (second return value)
|
jbe@143
|
205
|
jbe@143
|
206 The status code "block" as second return value is used if the function returned
|
jbe@143
|
207 prematurely because it would block otherwise. In this case, the first return
|
jbe@143
|
208 value is a string that contains the bytes that could be read without blocking.
|
jbe@143
|
209
|
jbe@78
|
210
|
jbe@140
|
211 ### socket:read_yield(maxlen, terminator)
|
jbe@140
|
212
|
jbe@140
|
213 Alias for socket:read_call(coroutine.yield, maxlen, terminator)
|
jbe@140
|
214
|
jbe@140
|
215
|
jbe@0
|
216 ### socket.remote_ip4
|
jbe@0
|
217
|
jbe@0
|
218 Remote IPv4 address used for the connection. Encoded as 4 raw bytes in form of
|
jbe@0
|
219 a string.
|
jbe@0
|
220
|
jbe@0
|
221
|
jbe@0
|
222 ### socket.remote_ip6
|
jbe@0
|
223
|
jbe@0
|
224 Remote IPv6 address used for the connection. Encoded as 16 raw bytes in form of
|
jbe@0
|
225 a string.
|
jbe@0
|
226
|
jbe@0
|
227
|
jbe@0
|
228 ### socket.remote_tcpport
|
jbe@0
|
229
|
jbe@0
|
230 Remote TCP port used for the connection.
|
jbe@0
|
231
|
jbe@0
|
232
|
jbe@91
|
233 ### socket:reset()
|
jbe@91
|
234
|
jbe@91
|
235 Alias for socket:close(0). Closes the socket connection by sending a TCP RST
|
jbe@91
|
236 packet if possible to indicate error condition.
|
jbe@91
|
237
|
jbe@114
|
238 Returns true on success, or nil (as first return value) plus error message (as
|
jbe@114
|
239 second return value) in case of an I/O error. Using this method on sockets that
|
jbe@91
|
240 have already been closed (or reset) will throw an error.
|
jbe@91
|
241
|
jbe@91
|
242 Warning: Previously sent (and flushed) data may be lost during transmission.
|
jbe@91
|
243
|
jbe@91
|
244
|
jbe@0
|
245 ### socket:write(...)
|
jbe@0
|
246
|
jbe@91
|
247 Takes a variable number of strings and sends them to the peer. The operation is
|
jbe@91
|
248 buffered, so to actually send out the data, it is necessary to eventually call
|
jbe@91
|
249 socket:flush(), socket:finish(), or socket:close().
|
jbe@91
|
250
|
jbe@91
|
251 In case of an I/O error, nil (as first return value) plus an error message (as
|
jbe@114
|
252 second return value) are returned. On success, the socket userdata object is
|
jbe@91
|
253 returned.
|
jbe@91
|
254
|
jbe@91
|
255
|
jbe@145
|
256 ### socket:write_call(waitfunc, ...)
|
jbe@145
|
257
|
jbe@152
|
258 Same as socket:write(...), but calls waitfunc() (in an infinite loop) as long
|
jbe@152
|
259 as the writing is blocked.
|
jbe@145
|
260
|
jbe@145
|
261
|
jbe@91
|
262 ### socket:write_nb(...)
|
jbe@91
|
263
|
jbe@91
|
264 Takes a variable number of strings and sends them to the peer. The operation is
|
jbe@91
|
265 buffered, so to actually send out the data, it is necessary to eventually call
|
jbe@91
|
266 socket:flush_nb(), socket:flush(), socket:finish(), or socket:close().
|
jbe@91
|
267
|
jbe@91
|
268 This function always returns immediately (i.e. it does not block). If all data
|
jbe@91
|
269 (but a small buffered portion) could be sent out, then zero is returned.
|
jbe@91
|
270 Otherwise, all arguments that could not be sent are stored in a buffer of
|
jbe@91
|
271 unlimited size (up to memory capabilities) and an integer is returned that
|
jbe@91
|
272 indicates the number of bytes currently in the buffer.
|
jbe@91
|
273
|
jbe@91
|
274 In case of an I/O error, nil (as first return value) plus an error message (as
|
jbe@114
|
275 second return value) are returned.
|
jbe@0
|
276
|
jbe@0
|
277
|
jbe@145
|
278 ### socket:write_yield(...)
|
jbe@145
|
279
|
jbe@145
|
280 Alias for socket:write_call(coroutine.yield, ...)
|
jbe@145
|
281
|
jbe@145
|
282
|
jbe@0
|
283
|
jbe@98
|
284 I/O library
|
jbe@98
|
285 -----------
|
jbe@98
|
286
|
jbe@98
|
287 The Moonbridge Network Server for Lua Applications comes with its own I/O
|
jbe@98
|
288 library to support blocking as well as nonblocking I/O operations.
|
jbe@98
|
289
|
jbe@114
|
290 All methods on an I/O handle (e.g. socket) are described in the previous
|
jbe@114
|
291 section regarding the "socket" object. All other functions of the library are
|
jbe@114
|
292 listed below.
|
jbe@114
|
293
|
jbe@114
|
294
|
jbe@114
|
295 ### moonbridge_io.localconnect(path)
|
jbe@114
|
296
|
jbe@114
|
297 Tries to connect to a local socket (also known as Unix Domain Socket). Returns
|
jbe@114
|
298 a socket object on success, or nil (as first return value) plus an error
|
jbe@114
|
299 message (as second return value) in case of error.
|
jbe@114
|
300
|
jbe@114
|
301
|
jbe@114
|
302 ### moonbridge_io.localconnect_nb(path)
|
jbe@114
|
303
|
jbe@114
|
304 Tries to connect to a local socket (also known as Unix Domain Socket). Returns
|
jbe@114
|
305 a socket object on success, or nil (as first return value) plus an error
|
jbe@114
|
306 message (as second return value) in case of error.
|
jbe@114
|
307
|
jbe@114
|
308 Same as moonbridge_io.localconnect(path), except that this function does not
|
jbe@114
|
309 block and immediately returns a socket object.
|
jbe@114
|
310
|
jbe@114
|
311 In case of an I/O error, nil (as first return value) plus an error message (as
|
jbe@114
|
312 second return value) may be returned. However, connection errors may also be
|
jbe@114
|
313 reported on first read or write on the socket.
|
jbe@114
|
314
|
jbe@114
|
315
|
jbe@114
|
316 ### moonbridge_io.locallisten(path)
|
jbe@114
|
317
|
jbe@114
|
318 Attempts to create a local socket (also known as Unix Domain Socket) to accept
|
jbe@118
|
319 incoming connections. If the file does already exist and is a socket, then it
|
jbe@118
|
320 is deleted automatically before being re-created.
|
jbe@114
|
321
|
jbe@114
|
322 In case of an I/O error, nil (as first return value) plus an error message (as
|
jbe@114
|
323 second return value) may be returned.On success, a listener object is returned
|
jbe@114
|
324 which supports the methods :accept(), :accept_nb(), and :close().
|
jbe@114
|
325
|
jbe@114
|
326 The method :accept() blocks until a new incoming connection is available in
|
jbe@114
|
327 which case a socket object is returned.
|
jbe@114
|
328
|
jbe@114
|
329 The method :accept_nb() works like :accept(), except that the call is
|
jbe@114
|
330 nonblocking and returns false (plus a notice as second return value) in case no
|
jbe@114
|
331 incoming connection is available. It is possible to wait for an incoming
|
jbe@114
|
332 connection by including the listener object in the input_set of the
|
jbe@114
|
333 moonbridge_io.poll(...) call.
|
jbe@114
|
334
|
jbe@114
|
335 The method :close() will close the listening socket. In case of local sockets
|
jbe@114
|
336 (Unix Domain Sockets), the socket will not be unlinked in the file system.
|
jbe@114
|
337
|
jbe@114
|
338 I/O errors by the methods of the listener object are also reported by returning
|
jbe@114
|
339 nil (as first return value) plus an error message (as second return value).
|
jbe@114
|
340
|
jbe@98
|
341
|
jbe@106
|
342 ### moonbridge_io.poll(input_set, output_set, timeout)
|
jbe@106
|
343
|
jbe@106
|
344 This function waits for at least one of the given file descriptors and/or
|
jbe@106
|
345 I/O handles to be ready for input or output. The two sets of file descriptors
|
jbe@106
|
346 and/or handles must contain the file descriptor or handle as a key, and a value
|
jbe@106
|
347 which does evaluate to true. If a set is nil, it is treated as being empty.
|
jbe@106
|
348
|
jbe@106
|
349 Returns true when at least one file descriptor or handle is ready for reading
|
jbe@106
|
350 or writing respectively. Returns false (as first return value) plus a status
|
jbe@106
|
351 message (as second return value) in case of timeout or when a signal was
|
jbe@106
|
352 received.
|
jbe@106
|
353
|
jbe@106
|
354
|
jbe@98
|
355 ### moonbridge_io.tcpconnect(hostname, port)
|
jbe@98
|
356
|
jbe@98
|
357 Tries to open a TCP connection with the given host and TCP port number. Returns
|
jbe@114
|
358 a socket object on success, or nil (as first return value) plus an error
|
jbe@114
|
359 message (as second return value) in case of error.
|
jbe@98
|
360
|
jbe@98
|
361
|
jbe@99
|
362 ### moonbridge_io.tcpconnect_nb(hostname, port)
|
jbe@99
|
363
|
jbe@99
|
364 Same as moonbridge_io.tcpconnect(hostname, port), except that this function
|
jbe@99
|
365 does not block and immediately returns a socket object.
|
jbe@99
|
366
|
jbe@102
|
367 Note: The current implementation still blocks during the DNS lookup. Use a
|
jbe@102
|
368 numeric IP address as hostname to be truly nonblocking.
|
jbe@102
|
369
|
jbe@99
|
370 In case of an I/O error, nil (as first return value) plus an error message (as
|
jbe@114
|
371 second return value) may be returned. However, connection errors may also be
|
jbe@99
|
372 reported on first read or write on the socket.
|
jbe@99
|
373
|
jbe@99
|
374
|
jbe@114
|
375 ### moonbridge_io.tcplisten(hostname, port)
|
jbe@114
|
376
|
jbe@114
|
377 Attempts to open a TCP port for listening. To listen on the loopback interface,
|
jbe@114
|
378 use "::1" as hostname if IPv6 shall be used, or use "127.0.0.1" as hostname if
|
jbe@114
|
379 IPv4 shall be used. To listen on all available interfaces, use "::" (IPv6) or
|
jbe@114
|
380 "0.0.0.0" (IPv4) respectively.
|
jbe@114
|
381
|
jbe@114
|
382 In case of an I/O error, nil (as first return value) plus an error message (as
|
jbe@114
|
383 second return value) may be returned. On success, a listener object is returned
|
jbe@114
|
384 which supports the methods :accept(), :accept_nb(), and :close(). See reference
|
jbe@114
|
385 for moonbridge.io_locallisten(...).
|
jbe@114
|
386
|
jbe@114
|
387
|
jbe@98
|
388
|
jbe@0
|
389 HTTP module
|
jbe@0
|
390 -----------
|
jbe@0
|
391
|
jbe@0
|
392 The http module exports the function http.generate_handler(callback) that
|
jbe@0
|
393 converts an HTTP handler to a "connect" handler. See file "example.lua" for an
|
jbe@0
|
394 example of invocation. A table with options may be passed either as a second
|
jbe@0
|
395 argument, or as a first argument preceeding the callback function (whichever is
|
jbe@0
|
396 more convenient).
|
jbe@0
|
397
|
jbe@0
|
398 The following options are supported:
|
jbe@0
|
399
|
jbe@0
|
400 - request_body_size_limit: maximum size of payload of HTTP request body
|
jbe@0
|
401 (transfer encoding is allowed to add a limited amount of extra data)
|
jbe@0
|
402 - chunk_size: optional default value for maximum_input_chunk_size and
|
jbe@0
|
403 minimum_output_chunk_size
|
jbe@0
|
404 - request_header_size_limit: maximum size of HTTP request headers
|
jbe@0
|
405 - maximum_input_chunk_size: maximum chunk size when streaming a request body or
|
jbe@0
|
406 certain POST fields (bigger chunks will be fragmented automatically)
|
jbe@0
|
407 - minimum_output_chunk_size: minimum size for a chunk when sending a response
|
jbe@0
|
408 body (smaller chunks will be buffered and concatenated with future data;
|
jbe@0
|
409 ignored when request:flush() is called)
|
jbe@0
|
410 - static_headers: a set of headers to be included in every HTTP response
|
jbe@0
|
411 (may be a string, a table or strings, or a table of key-value pairs)
|
jbe@0
|
412
|
jbe@0
|
413 The callback function receives a single request object as argument, which is
|
jbe@0
|
414 described below.
|
jbe@0
|
415
|
jbe@0
|
416
|
jbe@0
|
417 ### request.body
|
jbe@0
|
418
|
jbe@0
|
419 The request body (without headers) as a string. Accessing this value makes
|
jbe@0
|
420 further access to request.post_params and request.post_params_list, or
|
jbe@0
|
421 invocation of request:stream_request_body(...) impossible.
|
jbe@0
|
422
|
jbe@0
|
423
|
jbe@60
|
424 ### request:close_after_finish()
|
jbe@60
|
425
|
jbe@60
|
426 Closes the connection after answering the request.
|
jbe@60
|
427
|
jbe@60
|
428 This method can only be called before the HTTP response header section has been
|
jbe@60
|
429 finished (i.e. before request:finish_headers(), request:send_data(...), or
|
jbe@60
|
430 request:finish() were called), but it may be called before a status code has
|
jbe@60
|
431 been sent using request:send_status(...).
|
jbe@60
|
432
|
jbe@60
|
433 A corresponding "Connection: close" header is automatically sent.
|
jbe@60
|
434
|
jbe@184
|
435 See also request:monologue().
|
jbe@184
|
436
|
jbe@184
|
437
|
jbe@184
|
438 ### request:consume_input()
|
jbe@184
|
439
|
jbe@184
|
440 Starts processing the request body (if existent) to set the values
|
jbe@184
|
441 request.post_params, request.post_params_list, request.post_metadata, and
|
jbe@184
|
442 and request.post_metadata_list and/or to call POST field stream handlers that
|
jbe@184
|
443 have been previously registered with request:stream_post_param(...) or
|
jbe@184
|
444 request:stream_post_params(...), or to call a previously registered request
|
jbe@184
|
445 body stream handler that was set with request:set_request_body_streamer().
|
jbe@184
|
446
|
jbe@184
|
447 This method gets invoked automatically when the POST param tables
|
jbe@184
|
448 (request.post_params, etc.) are accessed or if request.body is accessed.
|
jbe@184
|
449
|
jbe@60
|
450
|
jbe@0
|
451 ### request.cookies
|
jbe@0
|
452
|
jbe@0
|
453 A table with all cookies sent by the client.
|
jbe@0
|
454
|
jbe@0
|
455
|
jbe@50
|
456 ### request.faulty
|
jbe@50
|
457
|
jbe@184
|
458 Normally set to false. In case of a write error on the client connection or
|
jbe@184
|
459 certain other unexpected errors, this value is set to true before a Lua error
|
jbe@184
|
460 is raised.
|
jbe@50
|
461
|
jbe@50
|
462 A faulty request handle must not be used, or another Lua error will be raised.
|
jbe@50
|
463
|
jbe@50
|
464
|
jbe@0
|
465 ### request:finish()
|
jbe@0
|
466
|
jbe@0
|
467 Finishes and flushes a HTTP response. May be called multiple times. An
|
jbe@0
|
468 HTTP status, all headers, and the response body (if applicable) must have been
|
jbe@0
|
469 previously sent. After calling this method, no further data may be written.
|
jbe@0
|
470
|
jbe@0
|
471
|
jbe@0
|
472 ### request:finish_headers()
|
jbe@0
|
473
|
jbe@0
|
474 Finishes and flushes the HTTP response header section. May be called multiple
|
jbe@0
|
475 times, as long as the request is not finished completely. This method is
|
jbe@0
|
476 automatically invoked if the application is beginning to send a response body.
|
jbe@0
|
477 After calling this method, no further headers may be sent.
|
jbe@0
|
478
|
jbe@0
|
479
|
jbe@0
|
480 ### request:flush()
|
jbe@0
|
481
|
jbe@0
|
482 Flushes any pending output data. Note: In order to mark the end of a response
|
jbe@0
|
483 body, it is required to call request:finish().
|
jbe@0
|
484
|
jbe@0
|
485
|
jbe@184
|
486 ### request.fresh
|
jbe@184
|
487
|
jbe@184
|
488 Set to false whenever the request object has been used (e.g. data has been read
|
jbe@184
|
489 or sent out, or a stream handler was installed); true otherwise.
|
jbe@184
|
490
|
jbe@184
|
491
|
jbe@0
|
492 ### request.get_params
|
jbe@0
|
493
|
jbe@0
|
494 A table that maps field names to their corresponding GET value. If there are
|
jbe@0
|
495 several GET values with the given field name, then the first value is used.
|
jbe@0
|
496
|
jbe@35
|
497 Note: May be implemented through metamethods, but does support iteration
|
jbe@35
|
498 through pairs(...).
|
jbe@35
|
499
|
jbe@0
|
500
|
jbe@0
|
501 ### request.get_params_list
|
jbe@0
|
502
|
jbe@0
|
503 A table that maps field names to a sequence of their corresponding GET values.
|
jbe@0
|
504
|
jbe@35
|
505 Note: May be implemented through metamethods, but does support iteration
|
jbe@35
|
506 through pairs(...).
|
jbe@35
|
507
|
jbe@0
|
508
|
jbe@0
|
509 ### request.headers
|
jbe@0
|
510
|
jbe@0
|
511 A table that maps (case-insensitively) a HTTP header field name to a sequence
|
jbe@0
|
512 of values. One entry is created for every occurrence of a header line with the
|
jbe@0
|
513 given field name).
|
jbe@0
|
514
|
jbe@0
|
515
|
jbe@0
|
516 ### request.headers_csv_string
|
jbe@0
|
517
|
jbe@0
|
518 A table that maps (case-insensitively) a HTTP header field name to a comma
|
jbe@0
|
519 separated string. Multiple occurrences of the header with the given field name
|
jbe@0
|
520 are automatically merged into the comma separated string.
|
jbe@0
|
521
|
jbe@0
|
522
|
jbe@0
|
523 ### request.headers_csv_table
|
jbe@0
|
524
|
jbe@0
|
525 A table that maps (case-insensitively) a HTTP header field name to a sequence
|
jbe@0
|
526 of values. One entry is created for every comma separated value of each header
|
jbe@0
|
527 with the given field name.
|
jbe@0
|
528
|
jbe@0
|
529
|
jbe@0
|
530 ### request.headers_flags
|
jbe@0
|
531
|
jbe@0
|
532 A table that maps (case-insensitively) a HTTP header field name to another
|
jbe@0
|
533 table which (again case-insensitively) maps a string to a boolean, depending on
|
jbe@0
|
534 whether this string occurred in the list of comma separated values of one
|
jbe@0
|
535 header line with the given field name that was the key in the first table.
|
jbe@0
|
536
|
jbe@0
|
537
|
jbe@0
|
538 ### request.headers_value
|
jbe@0
|
539
|
jbe@0
|
540 A table that maps (case-insensitively) a HTTP header field name to a value. If
|
jbe@0
|
541 multiple header lines with the given field name have been received, false is
|
jbe@0
|
542 used as value.
|
jbe@0
|
543
|
jbe@0
|
544
|
jbe@0
|
545 ### request.method
|
jbe@0
|
546
|
jbe@0
|
547 The HTTP request method, e.g. "HEAD", "GET", or "POST".
|
jbe@0
|
548
|
jbe@0
|
549
|
jbe@184
|
550 ### request:monologue()
|
jbe@184
|
551
|
jbe@184
|
552 Same as request:close_after_finish() but additionally discards all input data
|
jbe@184
|
553 immediately.
|
jbe@184
|
554
|
jbe@184
|
555
|
jbe@0
|
556 ### request.path
|
jbe@0
|
557
|
jbe@10
|
558 The requested path without a leading slash and without the query part (e.g.
|
jbe@10
|
559 "index.html" if "/index.html?a=b&c=d" has been requested). For the query part,
|
jbe@10
|
560 see request.query.
|
jbe@10
|
561
|
jbe@10
|
562 This value will be nil if (and only if) the request method is "OPTIONS" with a
|
jbe@10
|
563 request target equal to "*" (see also asterisk-form of request-target in
|
jbe@10
|
564 section 5.3.4 in RFC 7230).
|
jbe@0
|
565
|
jbe@0
|
566
|
jbe@0
|
567 ### request.post_metadata
|
jbe@0
|
568
|
jbe@0
|
569 Only set for multipart/form-data POST requests. A table that maps field names
|
jbe@0
|
570 to their corresponding POST metadata table which contains two entries:
|
jbe@0
|
571 "file_name" and "content_type". If there are several POST values with the given
|
jbe@0
|
572 field name, then the first value/file is used.
|
jbe@0
|
573
|
jbe@0
|
574
|
jbe@0
|
575 ### request.post_metadata_list
|
jbe@0
|
576
|
jbe@0
|
577 Only set for multipart/form-data POST requests. A table that maps field names
|
jbe@0
|
578 to a sequence with their corresponding POST metadata tables. Needed if multiple
|
jbe@0
|
579 files are uploaded with the same field name.
|
jbe@0
|
580
|
jbe@0
|
581
|
jbe@0
|
582 ### request.post_params
|
jbe@0
|
583
|
jbe@0
|
584 A table that maps field names to their corresponding POST value. If there are
|
jbe@0
|
585 several POST values with the given field name, then the first value is used.
|
jbe@0
|
586
|
jbe@35
|
587 Note: May be implemented through metamethods, but does support iteration
|
jbe@35
|
588 through pairs(...).
|
jbe@35
|
589
|
jbe@0
|
590
|
jbe@0
|
591 ### request.post_params_list
|
jbe@0
|
592
|
jbe@0
|
593 A table that maps field names to a sequence of their corresponding POST values.
|
jbe@0
|
594
|
jbe@35
|
595 Note: May be implemented through metamethods, but does support iteration
|
jbe@35
|
596 through pairs(...).
|
jbe@35
|
597
|
jbe@0
|
598
|
jbe@0
|
599 ### request.query
|
jbe@0
|
600
|
jbe@12
|
601 Query part of the request target including the leading question mark, e.g.
|
jbe@12
|
602 "?a=b&c=d" if the requested target is "/index.html?a=b&c=d". The data is
|
jbe@10
|
603 automatically parsed and made available through request.get_params and
|
jbe@10
|
604 request.get_params_list.
|
jbe@10
|
605
|
jbe@10
|
606 If there is no query part given in the request target, then this string is
|
jbe@10
|
607 the empty string. This value will be nil if (and only if) the request method
|
jbe@10
|
608 is "OPTIONS" with a request target equal to "*" (see also asterisk-form of
|
jbe@10
|
609 request-target in section 5.3.4 in RFC 7230).
|
jbe@0
|
610
|
jbe@0
|
611
|
jbe@0
|
612 ### request:send_data(...)
|
jbe@0
|
613
|
jbe@0
|
614 Sends data as response body. All arguments are converted via tostring(...) and
|
jbe@0
|
615 concatenated. May be called multiple times until the request has been finished
|
jbe@0
|
616 by calling request:finish().
|
jbe@0
|
617
|
jbe@0
|
618 If the request method (see request.method) is "HEAD", then calls to
|
jbe@0
|
619 request:send_data(...) are automatically ignored.
|
jbe@0
|
620
|
jbe@0
|
621
|
jbe@0
|
622 ### request:send_header(key, value)
|
jbe@0
|
623
|
jbe@0
|
624 Sends a HTTP response header that consists of the given key and the given
|
jbe@0
|
625 value. Note: Key and value must be provided as separate arguments. Before any
|
jbe@0
|
626 headers can be sent, a HTTP status must have been set with
|
jbe@0
|
627 request:send_status(status_string).
|
jbe@0
|
628
|
jbe@0
|
629
|
jbe@0
|
630 ### request:send_status(status_string)
|
jbe@0
|
631
|
jbe@0
|
632 Sends a HTTP response status that is given as a string consisting of a 3-digit
|
jbe@0
|
633 number and an explanatory string, e.g. "200 OK" or "404 Not Found". This
|
jbe@0
|
634 function must be called once before any headers or response body data may be
|
jbe@0
|
635 sent.
|
jbe@0
|
636
|
jbe@0
|
637
|
jbe@0
|
638 ### request.socket
|
jbe@0
|
639
|
jbe@0
|
640 The underlaying socket. Can be used to force a TCP RST, etc.
|
jbe@0
|
641
|
jbe@0
|
642
|
jbe@0
|
643 ### request:stream_post_param(field_name, callback)
|
jbe@0
|
644
|
jbe@0
|
645 Registers a stream handler for the given POST parameter. The callback function
|
jbe@0
|
646 will be called in the following manner:
|
jbe@0
|
647
|
jbe@0
|
648 - For the initial chunk, the first chunk gets passed as first argument while a
|
jbe@0
|
649 table with metadata ("field_name" and "content_type") gets passed as second
|
jbe@0
|
650 argument. In case of an immediate EOF (i.e. an empty file), the passed
|
jbe@0
|
651 chunk is the empty string. In all other cases the chunk has a length greater
|
jbe@0
|
652 than zero.
|
jbe@0
|
653 - For any remaining chunks, the respective chunk gets passed as first and only
|
jbe@0
|
654 argument (no metadata). Here, the chunk has always a length greater than
|
jbe@0
|
655 zero.
|
jbe@0
|
656 - To indicate the end of the stream, the callback function is called without
|
jbe@0
|
657 arguments. This also happens in case of an immediate EOF (see above).
|
jbe@0
|
658
|
jbe@0
|
659 In case of an immediate EOF (i.e. an empty file), the callback function is thus
|
jbe@0
|
660 called as follows:
|
jbe@0
|
661
|
jbe@0
|
662 - The first time with an empty string as first argument, and with the metadata
|
jbe@0
|
663 as second argument.
|
jbe@0
|
664 - The second time without any arguments.
|
jbe@0
|
665
|
jbe@184
|
666 Note that request:consume_input() needs to be called to enforce streaming to
|
jbe@184
|
667 finish.
|
jbe@184
|
668
|
jbe@0
|
669
|
jbe@0
|
670 ### request:stream_post_params(pattern, callback)
|
jbe@0
|
671
|
jbe@0
|
672 Same as request:stream_post_param(...) but providing a string pattern to match
|
jbe@0
|
673 multiple field names (e.g. "^file_[0-9]+$").
|
jbe@0
|
674
|
jbe@0
|
675
|
jbe@0
|
676 ### request:stream_request_body(callback)
|
jbe@0
|
677
|
jbe@184
|
678 Registeres a stream handler for the whole request body. For each chunk of the
|
jbe@184
|
679 request body, the callback function is called with the corresponding chunk. End
|
jbe@184
|
680 of data is indicated by passing a nil value to the callback functuion.
|
jbe@0
|
681
|
jbe@184
|
682 Note that request:consume_input() needs to be called to enforce streaming to
|
jbe@184
|
683 finish.
|
jbe@0
|
684
|
jbe@44
|
685
|
jbe@184
|
686 ### request:stream_request_body_now(callback)
|
jbe@184
|
687
|
jbe@184
|
688 Start streaming of request body immediately. On EOF the function returns and
|
jbe@184
|
689 the callback function is *not* called with nil as argument.
|
jbe@184
|
690
|
jbe@184
|
691 Note that request:consume_input() needs to be called to enforce streaming to
|
jbe@184
|
692 finish.
|
jbe@184
|
693
|
jbe@184
|
694
|