]> git.ipfire.org Git - thirdparty/haproxy.git/commitdiff
DOC: lua: update Lua doc
authorThierry FOURNIER <tfournier@arpalert.org>
Thu, 1 Oct 2015 12:49:33 +0000 (14:49 +0200)
committerWilly Tarreau <w@1wt.eu>
Fri, 2 Oct 2015 20:56:10 +0000 (22:56 +0200)
 - Removes the Lua action reference
 - Update the tune.lu.service-timeout

doc/configuration.txt

index 3102516710789bf854394c7001a16947b358f884..be5b26c085fb4a4e28c817104cb2a45a922ead08 100644 (file)
@@ -574,6 +574,7 @@ The following keywords are supported in the "global" section :
    - tune.lua.maxmem
    - tune.lua.session-timeout
    - tune.lua.task-timeout
+   - tune.lua.service-timeout
    - tune.maxaccept
    - tune.maxpollevents
    - tune.maxrewrite
@@ -1183,10 +1184,9 @@ tune.lua.maxmem
 
 tune.lua.session-timeout <timeout>
   This is the execution timeout for the Lua sessions. This is useful for
-  preventing infinite loops or spending too much time in Lua. This timeout has a
-  priority over other timeouts. For example, if this timeout is set to 4s and
-  you run a 5s sleep, the code will be interrupted with an error after waiting
-  4s.
+  preventing infinite loops or spending too much time in Lua. This timeout
+  counts only the pure Lua runtime. If the Lua does a sleep, the sleep is
+  not taked in account. The default timeout is 4s.
 
 tune.lua.task-timeout <timeout>
   Purpose is the same as "tune.lua.session-timeout", but this timeout is
@@ -1194,6 +1194,12 @@ tune.lua.task-timeout <timeout>
   remain alive during of the lifetime of HAProxy. For example, a task used to
   check servers.
 
+tune.lua.service-timeout <timeout>
+  This is the execution timeout for the Lua services. This is useful for
+  preventing infinite loops or spending too much time in Lua. This timeout
+  counts only the pure Lua runtime. If the Lua does a sleep, the sleep is
+  not taked in account. The default timeout is 4s.
+
 tune.maxaccept <number>
   Sets the maximum number of consecutive connections a process may accept in a
   row before switching to other work. In single process mode, higher numbers
@@ -3412,7 +3418,6 @@ http-request { allow | deny | tarpit | auth [realm <realm>] | redirect <rule> |
               sc-inc-gpc0(<sc-id>) |
               sc-set-gpt0(<sc-id>) <int> |
               silent-drop |
-              lua <function name>
              }
              [ { if | unless } <condition> ]
   Access control for Layer 7 requests
@@ -3687,10 +3692,6 @@ http-request { allow | deny | tarpit | auth [realm <realm>] | redirect <rule> |
       designated by <sc-id>. If an error occurs, this action silently fails and
       the actions evaluation continues.
 
-    - "lua" is used to run a Lua function if the action is executed. The single
-      parameter is the name of the function to run. The prototype of the
-      function is documented in the API documentation.
-
     - set-var(<var-name>) <expr> :
       Is used to set the contents of a variable. The variable is declared
       inline.
@@ -3818,7 +3819,6 @@ http-response { allow | deny | add-header <name> <fmt> | set-nice <nice> |
                 sc-inc-gpc0(<sc-id>) |
                 sc-set-gpt0(<sc-id>) <int> |
                 silent-drop |
-                lua <function name>
               }
               [ { if | unless } <condition> ]
   Access control for Layer 7 responses
@@ -3975,10 +3975,6 @@ http-response { allow | deny | add-header <name> <fmt> | set-nice <nice> |
       with large lists! It is the equivalent of the "set map" command from the
       stats socket, but can be triggered by an HTTP response.
 
-    - "lua" is used to run a Lua function if the action is executed. The single
-      parameter is the name of the function to run. The prototype of the
-      function is documented in the API documentation.
-
     - capture <sample> id <id> :
       captures sample expression <sample> from the response buffer, and converts
       it to a string. The resulting string is stored into the next request
@@ -8643,7 +8639,6 @@ tcp-request content <action> [{if | unless} <condition>]
     - { track-sc0 | track-sc1 | track-sc2 } <key> [table <table>]
     - sc-inc-gpc0(<sc-id>)
     - set-gpt0(<sc-id>) <int>
-    - lua <function>
     - set-var(<var-name>) <expr>
     - silent-drop
 
@@ -8675,11 +8670,6 @@ tcp-request content <action> [{if | unless} <condition>]
   wait until the inspect delay expires when the data to be tracked is not yet
   available.
 
-  The "lua" keyword is followed by a Lua function name. It is used to run a Lua
-  function if the action is executed. The single parameter is the name of the
-  function to run. The prototype of the function is documented in the API
-  documentation.
-
   The "set-var" is used to set the content of a variable. The variable is
   declared inline.
 
@@ -8849,9 +8839,6 @@ tcp-response content <action> [{if | unless} <condition>]
         or false (when used with "unless"). The first such rule executed ends
         the rules evaluation. Rejected session are immediately closed.
 
-    - lua <function>
-        Executes Lua.
-
     - set-var(<var-name>) <expr>
         Sets a variable.
 
@@ -8894,11 +8881,6 @@ tcp-response content <action> [{if | unless} <condition>]
   the best solution involves detecting the HTTP protocol during the inspection
   period.
 
-  The "lua" keyword is followed by a Lua function name. It is used to run a Lua
-  function if the action is executed. The single parameter is the name of the
-  function to run. The prototype of the function is documented in the API
-  documentation.
-
   The "set-var" is used to set the content of a variable. The variable is
   declared inline.