[sr-dev] git:master:840b4f90: modules: readme files regenerated - app_perl ... [skip ci]

[Kamailio Dev]

Module: kamailio
Branch: master
Commit: 840b4f9054fe9f8a29cb41deeb421b0ebe75e4b8
URL: https://github.com/kamailio/kamailio/commit/840b4f9054fe9f8a29cb41deeb421b0ebe75e4b8

Author: Kamailio Dev <kamailio.dev at kamailio.org>
Committer: Kamailio Dev <kamailio.dev at kamailio.org>
Date: 2022-07-07T09:31:19+02:00

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

---

Modified: src/modules/app_perl/README

---

Diff:  https://github.com/kamailio/kamailio/commit/840b4f9054fe9f8a29cb41deeb421b0ebe75e4b8.diff
Patch: https://github.com/kamailio/kamailio/commit/840b4f9054fe9f8a29cb41deeb421b0ebe75e4b8.patch

---

diff --git a/src/modules/app_perl/README b/src/modules/app_perl/README
index c6f42f585e..f2b6ffb7a1 100644
--- a/src/modules/app_perl/README
+++ b/src/modules/app_perl/README
@@ -29,6 +29,7 @@ Bastian Friedrich
               5.2. modpath (string)
               5.3. reset_cycles (int)
               5.4. perl_destroy_func (string)
+              5.5. parse_mode (int)
 
         6. Functions
 
@@ -196,10 +197,11 @@ Bastian Friedrich
    1.2. Set modpath parameter
    1.3. Set reset_cycles parameter
    1.4. Set perl_destroy_func parameter
-   1.5. perl_exec_simple() usage
-   1.6. perl_exec() usage
-   1.7. app_perl.set_reset_cycles usage
-   1.8. app_perl.get_reset_cycles usage
+   1.5. Set parse_mode parameter
+   1.6. perl_exec_simple() usage
+   1.7. perl_exec() usage
+   1.8. app_perl.set_reset_cycles usage
+   1.9. app_perl.get_reset_cycles usage
 
 Chapter 1. Admin Guide
 
@@ -219,6 +221,7 @@ Chapter 1. Admin Guide
         5.2. modpath (string)
         5.3. reset_cycles (int)
         5.4. perl_destroy_func (string)
+        5.5. parse_mode (int)
 
    6. Functions
 
@@ -339,6 +342,7 @@ if (perl_exec("ldap_alias")) {
    5.2. modpath (string)
    5.3. reset_cycles (int)
    5.4. perl_destroy_func (string)
+   5.5. parse_mode (int)
 
 5.1. filename (string)
 
@@ -399,6 +403,22 @@ modparam("app_perl", "reset_cycles", 100000)
 modparam("app_perl", "perl_destroy_func", "my_perl_destroy")
 ...
 
+5.5. parse_mode (int)
+
+   Control how to behave on perl_parse() return code - on some versions it
+   is the value for application exit and can break reloading.
+
+   If set to 0, continue even of perl_parse() returns non-zero, logging a
+   warning. If set to 1, realod fails on non-zero return code and triggers
+   an exit.
+
+   Default value is 0.
+
+   Example 1.5. Set parse_mode parameter
+...
+modparam("app_perl", "parse_mode", 1)
+...
+
 6. Functions
 
    6.1. perl_exec_simple(func, [param])
@@ -417,7 +437,7 @@ modparam("app_perl", "perl_destroy_func", "my_perl_destroy")
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    ONREPLY_ROUTE and BRANCH_ROUTE.
 
-   Example 1.5. perl_exec_simple() usage
+   Example 1.6. perl_exec_simple() usage
 ...
 if (method=="INVITE") {
         perl_exec_simple("dosomething", "on invite messages");
@@ -436,7 +456,7 @@ if (method=="INVITE") {
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    ONREPLY_ROUTE and BRANCH_ROUTE.
 
-   Example 1.6. perl_exec() usage
+   Example 1.7. perl_exec() usage
 ...
 if (perl_exec("ldapalias")) {
         ...
@@ -453,7 +473,7 @@ if (perl_exec("ldapalias")) {
    Set the value of the reset_cycle. The command has one integer
    parameter.
 
-   Example 1.7. app_perl.set_reset_cycles usage
+   Example 1.8. app_perl.set_reset_cycles usage
 ...
 kamcmd app_perl.set_reset_cycles 20000
 ...
@@ -462,7 +482,7 @@ kamcmd app_perl.set_reset_cycles 20000
 
    Return the value of the reset_cycle.
 
-   Example 1.8. app_perl.get_reset_cycles usage
+   Example 1.9. app_perl.get_reset_cycles usage
 ...
 kamcmd app_perl.get_reset_cycles
 ...