diff --git a/docs/manual/mod/mod_lua.html.en b/docs/manual/mod/mod_lua.html.en index 3600dd4fcd..d66c4281c1 100644 --- a/docs/manual/mod/mod_lua.html.en +++ b/docs/manual/mod/mod_lua.html.en @@ -657,237 +657,320 @@ end

Built in functions

-

The request_rec object has (at least) the following methods:

+

The request_rec object has (at least) the following methods:

- 
-        r:flush() -- flushes the output buffer
-
+
+r:flush() -- flushes the output buffer:
+
+while we_have_stuff_to_send do
+    r:puts("Bla bla bla\n") -- print something to client
+    r:flush() -- flush the buffer (send to client)
+    r:sleep(0.5) -- fake processing time and repeat
+end
+
- 
-        r:addoutputfilter(name|function) -- add an output filter
-
+
+r:addoutputfilter(name|function) -- add an output filter:
+
+r:addoutputfilter("fooFilter") -- add the fooFilter to the output stream
+
- 
-        r:sendfile(filename) -- sends an entire file to the client, using sendfile if supported by the current platform
-
+
+r:sendfile(filename) -- sends an entire file to the client, using sendfile if supported by the current platform:
+
+if use_sendfile_thing then
+    r:sendfile("/var/www/large_file.img")
+end
+
- 
-        r:parseargs() -- returns a Lua table containing the request's query string arguments
-
+
+r:parseargs() -- returns a Lua table containing the request's query string arguments:
+
+local GET = r:parseargs()
+r:puts("Your name is: " .. GET['name'] or "Unknown")
+
- 
-        r:parsebody([sizeLimit]) -- parse the request body as a POST and return a lua table.
-                         -- An optional number may be passed to specify the maximum number 
-                         -- of bytes to parse. Default is 8192 bytes.
-
+
+r:parsebody([sizeLimit]) -- parse the request body as a POST and return a lua table.
+                 -- An optional number may be passed to specify the maximum number 
+                 -- of bytes to parse. Default is 8192 bytes:
+                 
+local POST = r:parsebody(1024*1024)
+r:puts("Your name is: " .. POST['name'] or "Unknown")
+
- 
-        r:puts("hello", " world", "!") -- print to response body
-
+
+r:puts("hello", " world", "!") -- print to response body, self explanatory
+
- 
-        r:write("a single string") -- print to response body
-
+
+r:write("a single string") -- print to response body, self explanatory
+
- 
-        r:escape_html("<html>test</html>") -- Escapes HTML code and returns the escaped result
-
+
+r:escape_html("<html>test</html>") -- Escapes HTML code and returns the escaped result
+
- 
-        r:base64_encode(string) -- Encodes a string using the Base64 encoding standard
-
+
+r:base64_encode(string) -- Encodes a string using the Base64 encoding standard:
+
+local encoded = r:base64_encode("This is a test") -- returns VGhpcyBpcyBhIHRlc3Q=
+
- 
-        r:base64_decode(string) -- Decodes a Base64-encoded string
-
+
+r:base64_decode(string) -- Decodes a Base64-encoded string:
+
+local decoded = r:base64_decode("VGhpcyBpcyBhIHRlc3Q=") -- returns 'This is a test'
+
- 
-        r:md5(string) -- Calculates and returns the MD5 digest of a string (binary safe)
-
+
+r:md5(string) -- Calculates and returns the MD5 digest of a string (binary safe):
+
+local hash = r:md5("This is a test") -- returns ce114e4501d2f4e2dcea3e17b546f339
+
- 
-        r:sha1(string) -- Calculates and returns the SHA1 digest of a string (binary safe)
-
+
+r:sha1(string) -- Calculates and returns the SHA1 digest of a string (binary safe):
+
+local hash = r:sha1("This is a test") -- returns a54d88e06612d820bc3be72877c74f257b561b19
+
- 
-        r:escape(string) -- URL-Escapes a string
-
+
+r:escape(string) -- URL-Escapes a string:
+
+local url = "http://foo.bar/1 2 3 & 4 + 5"
+local escaped = r:escape(url) -- returns 'http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5'
+
- 
-        r:unescape(string) -- Unescapes an URL-escaped string
-
+
+r:unescape(string) -- Unescapes an URL-escaped string:
+
+local url = "http%3a%2f%2ffoo.bar%2f1+2+3+%26+4+%2b+5"
+local unescaped = r:escape(url) -- returns 'http://foo.bar/1 2 3 & 4 + 5'
+
- 
-        r:banner() -- Returns the current server banner
-
+
+r:banner() -- Returns the current server banner, self explanatory
+
- 
-        r:port() -- Returns the current server port used for the request
-
+
+r:port() -- Returns the current server port used for the request, self explanatory
+
- 
-        r:mpm_query(number) -- Queries the server for MPM information using ap_mpm_query
-
+
+r:mpm_query(number) -- Queries the server for MPM information using ap_mpm_query:
+
+local mpm = r.mpm_query(14)
+if mpm == 1 then
+    r:puts("This server uses the Event MPM")
+end
+
- 
-        r:expr(string) -- Evaluates an expr string.
-
+
+r:expr(string) -- Evaluates an expr string.
+
+if r:expr("%{HTTP_HOST} =~ /^www/") then
+    r:puts("This host name starts with www")
+end
+
- 
-        r:scoreboard_process(a) -- Queries the server for information about the process at position a
-
+
+r:scoreboard_process(a) -- Queries the server for information about the process at position a:
+
+local process = r:scoreboard_process(1)
+r:puts("Server 1 has PID " .. process.pid)
+
- 
-        r:scoreboard_worker(a, b) -- Queries for information about the worker thread, b, in process a
-
+
+r:scoreboard_worker(a, b) -- Queries for information about the worker thread, b, in process a:
+
+local thread = r:scoreboard_worker(1, 1)
+r:puts("Server 1's thread 1 has thread ID " .. thread.tid .. " and is in " .. thread.status .. " status")
+
- 
-        r:started() -- Returns the time of the last server (re)start
-
+
+r:started() -- Returns the time of the last server (re)start
+
- 
-        r:clock() -- Returns the current time with microsecond precision
-
+
+r:clock() -- Returns the current time with microsecond precision
+
- 
+
 r:requestbody(filename) -- Reads and returns the request body of a request.
-                        -- If 'filename' is specified, it instead saves the
-                        -- contents to that file.
-        

+                -- If 'filename' is specified, it instead saves the
+                -- contents to that file:
+                
+local input = r:requestbody()
+r:puts("You sent the following request body to me:\n")
+r:puts(input)
+
- 
-        r:add_input_filter(filter_name) -- Adds 'filter_name' as an input filter
-
+
+r:add_input_filter(filter_name) -- Adds 'filter_name' as an input filter
+
- 
-        r:module_info(module_name) -- Queries the server for information about a module
-
+
+r.module_info(module_name) -- Queries the server for information about a module
+
+local mod = r.module_info("mod_lua.c")
+if mod then
+    for k, v in pairs(mod.commands) do
+       r:puts( ("%s: %s\n"):format(k,v)) -- print out all directives accepted by this module
+    end
+end
+
- 
-        r:loaded_modules() -- Returns a list of modules loaded by httpd
-
+
+r:loaded_modules() -- Returns a list of modules loaded by httpd:
+
+for k, module in pairs(r:loaded_modules()) do
+    r:puts("I have loaded module " .. module .. "\n")
+end
+
- 
+
 r:runtime_dir_relative(filename) -- Compute the name of a run-time file (e.g., shared memory "file") 
-                                 -- relative to the appropriate run-time directory. 
-        

+                         -- relative to the appropriate run-time directory. 
+
- 
-        r:server_info() -- Returns a table containing server information, such as 
-                        -- the name of the httpd executable file, mpm used etc.
-
+
+r:server_info() -- Returns a table containing server information, such as 
+                -- the name of the httpd executable file, mpm used etc.
+
- 
-        r:set_document_root(file_path) -- Sets the document root for the request to file_path
-
+
+r:set_document_root(file_path) -- Sets the document root for the request to file_path
+
- 
-        r:add_version_component(component_string) -- Adds a component to the server banner.
-
+
+r:add_version_component(component_string) -- Adds a component to the server banner.
+
- 
-        r:set_context_info(prefix, docroot) -- Sets the context prefix and context document root for a request
-
+
+r:set_context_info(prefix, docroot) -- Sets the context prefix and context document root for a request
+
- 
-        r:os_escape_path(file_path) -- Converts an OS path to a URL in an OS dependant way
-
+
+r:os_escape_path(file_path) -- Converts an OS path to a URL in an OS dependant way
+
- 
-        r:escape_logitem(string) -- Escapes a string for logging
-
+
+r:escape_logitem(string) -- Escapes a string for logging
+
- 
-r:strcmp_match(string, pattern) -- Checks if 'string' matches 'pattern' using strcmp_match (GLOBs).
-                                -- fx. whether 'www.example.com' matches '*.example.com'
-
+
+r:strcmp_match(string, pattern) -- Checks if 'string' matches 'pattern' using strcmp_match (globs).
+                        -- fx. whether 'www.example.com' matches '*.example.com':
+                        
+local match = r:strcmp_match("foobar.com", "foo*.com")
+if match then 
+    r:puts("foobar.com matches foo*.com")
+end
+
- 
-        r:set_keepalive() -- Sets the keepalive status for a request. Returns true if possible, false otherwise.
-
+
+r:set_keepalive() -- Sets the keepalive status for a request. Returns true if possible, false otherwise.
+
- 
-        r:make_etag() -- Constructs and returns the etag for the current request.
-
+
+r:make_etag() -- Constructs and returns the etag for the current request.
+
- 
+
 r:send_interim_response(clear) -- Sends an interim (1xx) response to the client.
-                               -- if 'clear' is true, available headers will be sent and cleared.
-        

+                       -- if 'clear' is true, available headers will be sent and cleared.
+
- 
+
 r:custom_response(status_code, string) -- Construct and set a custom response for a given status code.
-                                       -- This works much like the ErrorDocument directive.
-        

+                               -- This works much like the ErrorDocument directive:
+                               
+r:custom_response(404, "Baleted!")
+
- 
-        r:exists_config_define(string) -- Checks whether a configuration definition exists or not.
-
+
+r:exists_config_define(string) -- Checks whether a configuration definition exists or not:
+
+if r:exists_config_define("FOO") then
+    r:puts("httpd was probably run with -DFOO, or it was defined in the configuration")
+end
+
- 
-        r:state_query(string) -- Queries the server for state information
-
+
+r:state_query(string) -- Queries the server for state information
+
- 
-        r:stat(filename) -- Runs stat() on a file, and returns a table with file information
-
+
+r:stat(filename) -- Runs stat() on a file, and returns a table with file information:
+
+local info = r:stat("/var/www/foo.txt")
+if info then
+    r:puts("This file exists and was last modified at: " .. info.modified)
+end
+
- 
-        r:regex(string, pattern) -- Runs a regular expression match on a string, returning captures if matched.
-
+
+r:regex(string, pattern) -- Runs a regular expression match on a string, returning captures if matched:
+
+local matches = r:regex("foo bar baz", "foo (%w+) (%S*)")
+if matches then
+    r:puts("The regex matched, and the last word captured ($2) was: " .. matches[2])
+end
+
- 
+
 r:sleep(number_of_seconds) -- Puts the script to sleep for a given number of seconds.
-                           -- This can be a floating point number like 1.25 for extra accuracy.
-        

+                   -- This can be a floating point number like 1.25 for extra accuracy.
+
- 
+
 r:dbacquire(dbType[, dbParams]) -- Acquires a connection to a database and returns a database class.
-                                -- See 'Database connectivity' for details.
-        

+                        -- See 'Database connectivity' for details.
+
diff --git a/docs/manual/mod/mod_lua.xml.fr b/docs/manual/mod/mod_lua.xml.fr index 3a442c231f..c1ea755a87 100644 --- a/docs/manual/mod/mod_lua.xml.fr +++ b/docs/manual/mod/mod_lua.xml.fr @@ -1,7 +1,7 @@ - + diff --git a/docs/manual/mod/mod_lua.xml.meta b/docs/manual/mod/mod_lua.xml.meta index b55c7710e9..8fc1a0efdf 100644 --- a/docs/manual/mod/mod_lua.xml.meta +++ b/docs/manual/mod/mod_lua.xml.meta @@ -8,6 +8,6 @@ en - fr + fr diff --git a/docs/manual/mod/mod_proxy.html.en b/docs/manual/mod/mod_proxy.html.en index b4111985ee..426fa0b4be 100644 --- a/docs/manual/mod/mod_proxy.html.en +++ b/docs/manual/mod/mod_proxy.html.en @@ -1311,6 +1311,12 @@ ProxyPass /mirror/foo http://backend.example.com force the worker into error state when the backend returns any status code in the list. Worker recovery behaves the same as other worker errors. + failontimeout + Off + If set, an IO read timeout after a request is sent to the backend will + force the worker into error state. Worker recovery behaves the same as other + worker errors. + nonce <auto> The protective nonce used in the balancer-manager application page. diff --git a/docs/manual/mod/mod_proxy.xml.fr b/docs/manual/mod/mod_proxy.xml.fr index ca8aa66cd8..699849bffc 100644 --- a/docs/manual/mod/mod_proxy.xml.fr +++ b/docs/manual/mod/mod_proxy.xml.fr @@ -1,7 +1,7 @@ - + diff --git a/docs/manual/mod/mod_proxy.xml.ja b/docs/manual/mod/mod_proxy.xml.ja index f05875e325..7049f02191 100644 --- a/docs/manual/mod/mod_proxy.xml.ja +++ b/docs/manual/mod/mod_proxy.xml.ja @@ -1,7 +1,7 @@ - + - +