moonbridge
changeset 220:6c02564342fe
Minor fixes/improvements for reference
author | jbe |
---|---|
date | Tue Jun 23 02:11:41 2015 +0200 (2015-06-23) |
parents | e53da349fd8f |
children | db8abd21762c |
files | reference.txt |
line diff
1.1 --- a/reference.txt Tue Jun 23 02:10:59 2015 +0200 1.2 +++ b/reference.txt Tue Jun 23 02:11:41 2015 +0200 1.3 @@ -311,7 +311,7 @@ 1.4 - :wait_yield() 1.5 1.6 Use :kill(signal) to terminate the process with the given signal (defaults to 1.7 -SIGTERM). 1.8 +15 for SIGTERM). 1.9 1.10 The :wait() method will wait for the process to terminate and return its exit 1.11 code. If the process was terminated by a signal, a negative integer is returned 1.12 @@ -355,10 +355,10 @@ 1.13 is deleted automatically before being re-created. 1.14 1.15 In case of an I/O error, nil (as first return value) plus an error message (as 1.16 -second return value) may be returned.On success, a listener object is returned 1.17 +second return value) may be returned. On success, a listener object is returned 1.18 which supports the methods :accept(), :accept_nb(), and :close(). 1.19 1.20 -The method :accept() blocks until a new incoming connection is available in 1.21 +The method :accept() blocks until a new incoming connection is available, in 1.22 which case a socket object is returned. 1.23 1.24 The method :accept_nb() works like :accept(), except that the call is 1.25 @@ -379,7 +379,8 @@ 1.26 This function waits for at least one of the given file descriptors and/or 1.27 I/O handles to be ready for input or output. The two sets of file descriptors 1.28 and/or handles must contain the file descriptor or handle as a key, and a value 1.29 -which does evaluate to true. If a set is nil, it is treated as being empty. 1.30 +which does evaluate to true, e.g. input_set = {[socketA] = true}. If a set is 1.31 +nil, it is treated as being empty. 1.32 1.33 Returns true when at least one file descriptor or handle is ready for reading 1.34 or writing respectively. Returns false (plus a notice as second return value) 1.35 @@ -424,11 +425,11 @@ 1.36 HTTP module 1.37 ----------- 1.38 1.39 -The http module exports the function http.generate_handler(callback) that 1.40 -converts an HTTP handler to a "connect" handler. See file "example.lua" for an 1.41 -example of invocation. A table with options may be passed either as a second 1.42 -argument, or as a first argument preceeding the callback function (whichever is 1.43 -more convenient). 1.44 +The HTTP module exports the function moonbridge_http.generate_handler(callback) 1.45 +that converts an HTTP handler to a "connect" handler. See file "example.lua" 1.46 +for an example of invocation. A table with options may be passed either as a 1.47 +second argument, or as a first argument preceeding the callback function 1.48 +(whichever is more convenient). 1.49 1.50 The following options are supported: 1.51