Skip to content

Commit

Permalink
modules: readme files regenerated - app_perl ... [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
kamailio-dev committed Jul 11, 2022
1 parent e038a21 commit 7856251
Showing 1 changed file with 25 additions and 8 deletions.
33 changes: 25 additions & 8 deletions src/modules/app_perl/README
Expand Up @@ -30,6 +30,7 @@ Bastian Friedrich
5.3. reset_cycles (int)
5.4. perl_destroy_func (string)
5.5. parse_mode (int)
5.6. warn_mode (int)

6. Functions

Expand Down Expand Up @@ -198,10 +199,11 @@ Bastian Friedrich
1.3. Set reset_cycles parameter
1.4. Set perl_destroy_func parameter
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
1.6. Set warn_mode parameter
1.7. perl_exec_simple() usage
1.8. perl_exec() usage
1.9. app_perl.set_reset_cycles usage
1.10. app_perl.get_reset_cycles usage

Chapter 1. Admin Guide

Expand All @@ -222,6 +224,7 @@ Chapter 1. Admin Guide
5.3. reset_cycles (int)
5.4. perl_destroy_func (string)
5.5. parse_mode (int)
5.6. warn_mode (int)

6. Functions

Expand Down Expand Up @@ -343,6 +346,7 @@ if (perl_exec("ldap_alias")) {
5.3. reset_cycles (int)
5.4. perl_destroy_func (string)
5.5. parse_mode (int)
5.6. warn_mode (int)

5.1. filename (string)

Expand Down Expand Up @@ -419,6 +423,19 @@ modparam("app_perl", "perl_destroy_func", "my_perl_destroy")
modparam("app_perl", "parse_mode", 1)
...

5.6. warn_mode (int)

Allows to enable warning for perl_parse(). If set to 1, "-w" is passed
to perl_parse() and detected warnings in the Perl script should be
printed to the log.

Default value is 0.

Example 1.6. Set warn_mode parameter
...
modparam("app_perl", "warn_mode", 1)
...

6. Functions

6.1. perl_exec_simple(func, [param])
Expand All @@ -437,7 +454,7 @@ modparam("app_perl", "parse_mode", 1)
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE and BRANCH_ROUTE.

Example 1.6. perl_exec_simple() usage
Example 1.7. perl_exec_simple() usage
...
if (method=="INVITE") {
perl_exec_simple("dosomething", "on invite messages");
Expand All @@ -456,7 +473,7 @@ if (method=="INVITE") {
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
ONREPLY_ROUTE and BRANCH_ROUTE.

Example 1.7. perl_exec() usage
Example 1.8. perl_exec() usage
...
if (perl_exec("ldapalias")) {
...
Expand All @@ -473,7 +490,7 @@ if (perl_exec("ldapalias")) {
Set the value of the reset_cycle. The command has one integer
parameter.

Example 1.8. app_perl.set_reset_cycles usage
Example 1.9. app_perl.set_reset_cycles usage
...
kamcmd app_perl.set_reset_cycles 20000
...
Expand All @@ -482,7 +499,7 @@ kamcmd app_perl.set_reset_cycles 20000

Return the value of the reset_cycle.

Example 1.9. app_perl.get_reset_cycles usage
Example 1.10. app_perl.get_reset_cycles usage
...
kamcmd app_perl.get_reset_cycles
...
Expand Down

0 comments on commit 7856251

Please sign in to comment.