[sr-dev] git:master:73321a9a: async: docs for return parameter

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 73321a9a56e3772852c3254cc1936cb17d0a635d
URL: https://github.com/kamailio/kamailio/commit/73321a9a56e3772852c3254cc1936cb17d0a635d

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2022-02-18T09:04:27+01:00

async: docs for return parameter

---

Modified: src/modules/async/doc/async_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/73321a9a56e3772852c3254cc1936cb17d0a635d.diff
Patch: https://github.com/kamailio/kamailio/commit/73321a9a56e3772852c3254cc1936cb17d0a635d.patch

---

diff --git a/src/modules/async/doc/async_admin.xml b/src/modules/async/doc/async_admin.xml
index b0e5ec45bd..4955f00036 100644
--- a/src/modules/async/doc/async_admin.xml
+++ b/src/modules/async/doc/async_admin.xml
@@ -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>