moonbridge

annotate reference.txt @ 259:385b6607785a

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

Impressum / About Us