Skip to content

Commit

Permalink
perl: improve docs regarding the return value of perl_exec()
Browse files Browse the repository at this point in the history
  • Loading branch information
rvlad-patrascu committed Jan 28, 2020
1 parent 7b7a9fc commit 286ab28
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions modules/perl/doc/perl_admin.xml
Expand Up @@ -201,6 +201,11 @@ modparam("perl", "modpath", "/usr/local/lib/opensips/perl/")
An arbitrary string may optionally be passed as a parameter.
</para>
<para>
The function returns <emphasis>1</emphasis> if the perl function was successfully called
or <emphasis>-1</emphasis> if an internal error occured. Note that it does not propagate
the return value of the perl function.
</para>
<para>
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE and BRANCH_ROUTE.
</para>
<example>
Expand Down Expand Up @@ -229,6 +234,11 @@ if ($rm=="INVITE") {
An arbitrary string may be passed as a parameter.
</para>
<para>
The function returns back to the OpenSIPS script the value returned by the perl function.
Note that if this value is <emphasis>0</emphasis> the script execution
will be stoped, similarly to calling <emphasis>exit</emphasis>.
</para>
<para>
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, ONREPLY_ROUTE and BRANCH_ROUTE.
</para>
<example>
Expand Down

0 comments on commit 286ab28

Please sign in to comment.