moonbridge

annotate reference.txt @ 144:e7fac0918f9c

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

Impressum / About Us