Browse code

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

Kamailio Dev authored on 11/07/2022 08:01:28
Showing 1 changed files
... ...
@@ -30,6 +30,7 @@ Bastian Friedrich
30 30
               5.3. reset_cycles (int)
31 31
               5.4. perl_destroy_func (string)
32 32
               5.5. parse_mode (int)
33
+              5.6. warn_mode (int)
33 34
 
34 35
         6. Functions
35 36
 
... ...
@@ -198,10 +199,11 @@ Bastian Friedrich
198 199
    1.3. Set reset_cycles parameter
199 200
    1.4. Set perl_destroy_func parameter
200 201
    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
202
+   1.6. Set warn_mode parameter
203
+   1.7. perl_exec_simple() usage
204
+   1.8. perl_exec() usage
205
+   1.9. app_perl.set_reset_cycles usage
206
+   1.10. app_perl.get_reset_cycles usage
205 207
 
206 208
 Chapter 1. Admin Guide
207 209
 
... ...
@@ -222,6 +224,7 @@ Chapter 1. Admin Guide
222 224
         5.3. reset_cycles (int)
223 225
         5.4. perl_destroy_func (string)
224 226
         5.5. parse_mode (int)
227
+        5.6. warn_mode (int)
225 228
 
226 229
    6. Functions
227 230
 
... ...
@@ -343,6 +346,7 @@ if (perl_exec("ldap_alias")) {
343 346
    5.3. reset_cycles (int)
344 347
    5.4. perl_destroy_func (string)
345 348
    5.5. parse_mode (int)
349
+   5.6. warn_mode (int)
346 350
 
347 351
 5.1. filename (string)
348 352
 
... ...
@@ -419,6 +423,19 @@ modparam("app_perl", "perl_destroy_func", "my_perl_destroy")
419 423
 modparam("app_perl", "parse_mode", 1)
420 424
 ...
421 425
 
426
+5.6. warn_mode (int)
427
+
428
+   Allows to enable warning for perl_parse(). If set to 1, "-w" is passed
429
+   to perl_parse() and detected warnings in the Perl script should be
430
+   printed to the log.
431
+
432
+   Default value is 0.
433
+
434
+   Example 1.6. Set warn_mode parameter
435
+...
436
+modparam("app_perl", "warn_mode", 1)
437
+...
438
+
422 439
 6. Functions
423 440
 
424 441
    6.1. perl_exec_simple(func, [param])
... ...
@@ -437,7 +454,7 @@ modparam("app_perl", "parse_mode", 1)
437 454
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
438 455
    ONREPLY_ROUTE and BRANCH_ROUTE.
439 456
 
440
-   Example 1.6. perl_exec_simple() usage
457
+   Example 1.7. perl_exec_simple() usage
441 458
 ...
442 459
 if (method=="INVITE") {
443 460
         perl_exec_simple("dosomething", "on invite messages");
... ...
@@ -456,7 +473,7 @@ if (method=="INVITE") {
456 473
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
457 474
    ONREPLY_ROUTE and BRANCH_ROUTE.
458 475
 
459
-   Example 1.7. perl_exec() usage
476
+   Example 1.8. perl_exec() usage
460 477
 ...
461 478
 if (perl_exec("ldapalias")) {
462 479
         ...
... ...
@@ -473,7 +490,7 @@ if (perl_exec("ldapalias")) {
473 490
    Set the value of the reset_cycle. The command has one integer
474 491
    parameter.
475 492
 
476
-   Example 1.8. app_perl.set_reset_cycles usage
493
+   Example 1.9. app_perl.set_reset_cycles usage
477 494
 ...
478 495
 kamcmd app_perl.set_reset_cycles 20000
479 496
 ...
... ...
@@ -482,7 +499,7 @@ kamcmd app_perl.set_reset_cycles 20000
482 499
 
483 500
    Return the value of the reset_cycle.
484 501
 
485
-   Example 1.9. app_perl.get_reset_cycles usage
502
+   Example 1.10. app_perl.get_reset_cycles usage
486 503
 ...
487 504
 kamcmd app_perl.get_reset_cycles
488 505
 ...