Skip to content

Commit

Permalink
async: docs for return parameter
Browse files Browse the repository at this point in the history
  • Loading branch information
miconda committed Feb 18, 2022
1 parent 29035b3 commit 73321a9
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions src/modules/async/doc/async_admin.xml
Expand Up @@ -108,6 +108,29 @@ modparam("async", "workers", 2)
...
modparam("async", "ms_timer", 10)
...
</programlisting>
</example>
</section>
<section>
<title>Parameters</title>
<section id="async.p.return">
<title><varname>return</varname> (int)</title>
<para>
The value to be returned by async functions on success. It does
not apply for async data functions, only for those that suspend
the SIP transaction.
</para>
<para>
<emphasis>
Default value is 0.
</emphasis>
</para>
<example>
<title>Set <varname>workers</varname> parameter</title>
<programlisting format="linespecific">
...
modparam("async", "return", 1)
...
</programlisting>
</example>
</section>
Expand Down

0 comments on commit 73321a9

Please sign in to comment.