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

[Kamailio Dev]

Module: kamailio
Branch: master
Commit: 2b35fc28a6cef63158e29e322171621d2c66fa1c
URL: https://github.com/kamailio/kamailio/commit/2b35fc28a6cef63158e29e322171621d2c66fa1c

Author: Kamailio Dev <kamailio.dev at kamailio.org>
Committer: Kamailio Dev <kamailio.dev at kamailio.org>
Date: 2018-10-17T13:01:32+02:00

modules: readme files regenerated - pipelimit ... [skip ci]

---

Modified: src/modules/pipelimit/README

---

Diff:  https://github.com/kamailio/kamailio/commit/2b35fc28a6cef63158e29e322171621d2c66fa1c.diff
Patch: https://github.com/kamailio/kamailio/commit/2b35fc28a6cef63158e29e322171621d2c66fa1c.patch

---

diff --git a/src/modules/pipelimit/README b/src/modules/pipelimit/README
index 810b5d48ca..05d05f27a8 100644
--- a/src/modules/pipelimit/README
+++ b/src/modules/pipelimit/README
@@ -42,8 +42,9 @@ Daniel-Constantin Mierla
               3.6. plp_algorithm_column (string)
               3.7. timer_interval (integer)
               3.8. timer_mode (integer)
-              3.9. reply_code (integer)
-              3.10. reply_reason (string)
+              3.9. load_fetch (integer)
+              3.10. reply_code (integer)
+              3.11. reply_reason (string)
 
         4. Functions
 
@@ -70,12 +71,13 @@ Daniel-Constantin Mierla
    1.6. Set plp_algorithm_column parameter
    1.7. Set timer_interval parameter
    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
+   1.9. Set load_fetch parameter
+   1.10. Set reply_code parameter
+   1.11. Set reply_code parameter at runtime
+   1.12. Set reply_reason parameter
+   1.13. Set reply_reason parameter at runtime
+   1.14. pl_check usage
+   1.15. pl_drop usage
 
 Chapter 1. Admin Guide
 
@@ -100,8 +102,9 @@ Chapter 1. Admin Guide
         3.6. plp_algorithm_column (string)
         3.7. timer_interval (integer)
         3.8. timer_mode (integer)
-        3.9. reply_code (integer)
-        3.10. reply_reason (string)
+        3.9. load_fetch (integer)
+        3.10. reply_code (integer)
+        3.11. reply_reason (string)
 
    4. Functions
 
@@ -211,8 +214,9 @@ Chapter 1. Admin Guide
    3.6. plp_algorithm_column (string)
    3.7. timer_interval (integer)
    3.8. timer_mode (integer)
-   3.9. reply_code (integer)
-   3.10. reply_reason (string)
+   3.9. load_fetch (integer)
+   3.10. reply_code (integer)
+   3.11. reply_reason (string)
 
 3.1. hash_size (int)
 
@@ -314,36 +318,49 @@ modparam("pipelimit", "timer_interval", 5)
 modparam("pipelimit", "timer_mode", 1)
 ...
 
-3.9. reply_code (integer)
+3.9. load_fetch (integer)
+
+   Control if the module should fetch the load for CPU and network
+   traffic. If set to 0, no load is fetched; if set to 1, the load is
+   fetched every timer interval.
+
+   Default value is 1.
+
+   Example 1.9. Set load_fetch parameter
+...
+modparam("pipelimit", "load_fetch", 0)
+...
+
+3.10. reply_code (integer)
 
    The code of the reply sent by Kamailio while limiting.
 
    Default value is 503.
 
-   Example 1.9. Set reply_code parameter
+   Example 1.10. Set reply_code parameter
 ...
 modparam("pipelimit", "reply_code", 505)
 ...
 
    This value can be modified at runtime using kamcmd
 
-   Example 1.10.  Set reply_code parameter at runtime
+   Example 1.11.  Set reply_code parameter at runtime
 kamcmd cfg.set_now_int pipelimit reply_code 505
 
-3.10. reply_reason (string)
+3.11. reply_reason (string)
 
    The reason of the reply sent by Kamailio while limiting.
 
    Default value is "Server Unavailable".
 
-   Example 1.11. Set reply_reason parameter
+   Example 1.12. Set reply_reason parameter
 ...
 modparam("pipelimit", "reply_reason", "Limiting")
 ...
 
    This value can be modified at runtime using kamcmd
 
-   Example 1.12.  Set reply_reason parameter at runtime
+   Example 1.13.  Set reply_reason parameter at runtime
 kamcmd cfg.set_now_string pipelimit reply_reason "Limiting"
 
 4. Functions
@@ -378,7 +395,7 @@ kamcmd cfg.set_now_string pipelimit reply_reason "Limiting"
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.13. pl_check usage
+   Example 1.14. pl_check usage
 ...
         # perform pipe match for current method
         if (!pl_check("one")) {
@@ -447,7 +464,7 @@ with unexpected retcode=$var(check_result)\n");
    This function can be used from
    REQUEST_ROUTE|BRANCH_ROUTE|FAILURE_ROUTE|ONSEND_ROUTE.
 
-   Example 1.14. pl_drop usage
+   Example 1.15. pl_drop usage
 ...
         if (!pl_check("one")) {
                 # send back a "503 - Server Unavailable"