[sr-dev] git:master:fc1f16e5: modules: readme files regenerated - pipelimit ... [skip ci]

Module: kamailio Branch: master Commit: fc1f16e52433257ad7abf2cbbf26e72f0ac94e7a URL: https://github.com/kamailio/kamailio/commit/fc1f16e52433257ad7abf2cbbf26e72… Author: Kamailio Dev <kamailio.dev(a)kamailio.org> Committer: Kamailio Dev <kamailio.dev(a)kamailio.org> Date: 2018-10-17T09:31:37+02:00 modules: readme files regenerated - pipelimit ... [skip ci] --- Modified: src/modules/pipelimit/README --- Diff: https://github.com/kamailio/kamailio/commit/fc1f16e52433257ad7abf2cbbf26e72… Patch: https://github.com/kamailio/kamailio/commit/fc1f16e52433257ad7abf2cbbf26e72… --- diff --git a/src/modules/pipelimit/README b/src/modules/pipelimit/README index 3b48f2e0d6..810b5d48ca 100644 --- a/src/modules/pipelimit/README +++ b/src/modules/pipelimit/README @@ -41,8 +41,9 @@ Daniel-Constantin Mierla 3.5. plp_limit_column (string) 3.6. plp_algorithm_column (string) 3.7. timer_interval (integer) - 3.8. reply_code (integer) - 3.9. reply_reason (string) + 3.8. timer_mode (integer) + 3.9. reply_code (integer) + 3.10. reply_reason (string) 4. Functions @@ -68,12 +69,13 @@ Daniel-Constantin Mierla 1.5. Set plp_limit_column parameter 1.6. Set plp_algorithm_column parameter 1.7. Set timer_interval parameter - 1.8. Set reply_code parameter - 1.9. Set reply_code parameter at runtime - 1.10. Set reply_reason parameter - 1.11. Set reply_reason parameter at runtime - 1.12. pl_check usage - 1.13. pl_drop usage + 1.8. Set timer_mode parameter + 1.9. Set reply_code parameter + 1.10. Set reply_code parameter at runtime + 1.11. Set reply_reason parameter + 1.12. Set reply_reason parameter at runtime + 1.13. pl_check usage + 1.14. pl_drop usage Chapter 1. Admin Guide @@ -97,8 +99,9 @@ Chapter 1. Admin Guide 3.5. plp_limit_column (string) 3.6. plp_algorithm_column (string) 3.7. timer_interval (integer) - 3.8. reply_code (integer) - 3.9. reply_reason (string) + 3.8. timer_mode (integer) + 3.9. reply_code (integer) + 3.10. reply_reason (string) 4. Functions @@ -207,8 +210,9 @@ Chapter 1. Admin Guide 3.5. plp_limit_column (string) 3.6. plp_algorithm_column (string) 3.7. timer_interval (integer) - 3.8. reply_code (integer) - 3.9. reply_reason (string) + 3.8. timer_mode (integer) + 3.9. reply_code (integer) + 3.10. reply_reason (string) 3.1. hash_size (int) @@ -298,36 +302,48 @@ modparam("pipelimit", "plp_algorithm_column", "name") modparam("pipelimit", "timer_interval", 5) ... -3.8. reply_code (integer) +3.8. timer_mode (integer) + + Control what timer process to be used: 0 - use main fast timer; 1 - use + secondary wheel timer. + + Default value is 0. + + Example 1.8. Set timer_mode parameter +... +modparam("pipelimit", "timer_mode", 1) +... + +3.9. reply_code (integer) The code of the reply sent by Kamailio while limiting. Default value is 503. - Example 1.8. Set reply_code parameter + Example 1.9. Set reply_code parameter ... modparam("pipelimit", "reply_code", 505) ... This value can be modified at runtime using kamcmd - Example 1.9. Set reply_code parameter at runtime + Example 1.10. Set reply_code parameter at runtime kamcmd cfg.set_now_int pipelimit reply_code 505 -3.9. reply_reason (string) +3.10. reply_reason (string) The reason of the reply sent by Kamailio while limiting. Default value is "Server Unavailable". - Example 1.10. Set reply_reason parameter + Example 1.11. Set reply_reason parameter ... modparam("pipelimit", "reply_reason", "Limiting") ... This value can be modified at runtime using kamcmd - Example 1.11. Set reply_reason parameter at runtime + Example 1.12. Set reply_reason parameter at runtime kamcmd cfg.set_now_string pipelimit reply_reason "Limiting" 4. Functions @@ -362,7 +378,7 @@ kamcmd cfg.set_now_string pipelimit reply_reason "Limiting" This function can be used from ANY_ROUTE. - Example 1.12. pl_check usage + Example 1.13. pl_check usage ... # perform pipe match for current method if (!pl_check("one")) { @@ -431,7 +447,7 @@ with unexpected retcode=$var(check_result)\n"); This function can be used from REQUEST_ROUTE|BRANCH_ROUTE|FAILURE_ROUTE|ONSEND_ROUTE. - Example 1.13. pl_drop usage + Example 1.14. pl_drop usage ... if (!pl_check("one")) { # send back a "503 - Server Unavailable"