Browse code

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

Kamailio Dev authored on 07/07/2022 07:31:19
Showing 1 changed files
... ...
@@ -29,6 +29,7 @@ Bastian Friedrich
29 29
               5.2. modpath (string)
30 30
               5.3. reset_cycles (int)
31 31
               5.4. perl_destroy_func (string)
32
+              5.5. parse_mode (int)
32 33
 
33 34
         6. Functions
34 35
 
... ...
@@ -196,10 +197,11 @@ Bastian Friedrich
196 197
    1.2. Set modpath parameter
197 198
    1.3. Set reset_cycles parameter
198 199
    1.4. Set perl_destroy_func parameter
199
-   1.5. perl_exec_simple() usage
200
-   1.6. perl_exec() usage
201
-   1.7. app_perl.set_reset_cycles usage
202
-   1.8. app_perl.get_reset_cycles usage
200
+   1.5. Set parse_mode parameter
201
+   1.6. perl_exec_simple() usage
202
+   1.7. perl_exec() usage
203
+   1.8. app_perl.set_reset_cycles usage
204
+   1.9. app_perl.get_reset_cycles usage
203 205
 
204 206
 Chapter 1. Admin Guide
205 207
 
... ...
@@ -219,6 +221,7 @@ Chapter 1. Admin Guide
219 221
         5.2. modpath (string)
220 222
         5.3. reset_cycles (int)
221 223
         5.4. perl_destroy_func (string)
224
+        5.5. parse_mode (int)
222 225
 
223 226
    6. Functions
224 227
 
... ...
@@ -339,6 +342,7 @@ if (perl_exec("ldap_alias")) {
339 342
    5.2. modpath (string)
340 343
    5.3. reset_cycles (int)
341 344
    5.4. perl_destroy_func (string)
345
+   5.5. parse_mode (int)
342 346
 
343 347
 5.1. filename (string)
344 348
 
... ...
@@ -399,6 +403,22 @@ modparam("app_perl", "reset_cycles", 100000)
399 403
 modparam("app_perl", "perl_destroy_func", "my_perl_destroy")
400 404
 ...
401 405
 
406
+5.5. parse_mode (int)
407
+
408
+   Control how to behave on perl_parse() return code - on some versions it
409
+   is the value for application exit and can break reloading.
410
+
411
+   If set to 0, continue even of perl_parse() returns non-zero, logging a
412
+   warning. If set to 1, realod fails on non-zero return code and triggers
413
+   an exit.
414
+
415
+   Default value is 0.
416
+
417
+   Example 1.5. Set parse_mode parameter
418
+...
419
+modparam("app_perl", "parse_mode", 1)
420
+...
421
+
402 422
 6. Functions
403 423
 
404 424
    6.1. perl_exec_simple(func, [param])
... ...
@@ -417,7 +437,7 @@ modparam("app_perl", "perl_destroy_func", "my_perl_destroy")
417 437
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
418 438
    ONREPLY_ROUTE and BRANCH_ROUTE.
419 439
 
420
-   Example 1.5. perl_exec_simple() usage
440
+   Example 1.6. perl_exec_simple() usage
421 441
 ...
422 442
 if (method=="INVITE") {
423 443
         perl_exec_simple("dosomething", "on invite messages");
... ...
@@ -436,7 +456,7 @@ if (method=="INVITE") {
436 456
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
437 457
    ONREPLY_ROUTE and BRANCH_ROUTE.
438 458
 
439
-   Example 1.6. perl_exec() usage
459
+   Example 1.7. perl_exec() usage
440 460
 ...
441 461
 if (perl_exec("ldapalias")) {
442 462
         ...
... ...
@@ -453,7 +473,7 @@ if (perl_exec("ldapalias")) {
453 473
    Set the value of the reset_cycle. The command has one integer
454 474
    parameter.
455 475
 
456
-   Example 1.7. app_perl.set_reset_cycles usage
476
+   Example 1.8. app_perl.set_reset_cycles usage
457 477
 ...
458 478
 kamcmd app_perl.set_reset_cycles 20000
459 479
 ...
... ...
@@ -462,7 +482,7 @@ kamcmd app_perl.set_reset_cycles 20000
462 482
 
463 483
    Return the value of the reset_cycle.
464 484
 
465
-   Example 1.8. app_perl.get_reset_cycles usage
485
+   Example 1.9. app_perl.get_reset_cycles usage
466 486
 ...
467 487
 kamcmd app_perl.get_reset_cycles
468 488
 ...