[sr-dev] git:master:5f590180: async: docs for async_task_group_route(routename, groupname)

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 5f590180c3acc5f786c1d0667997c1b3b8924ed9
URL: https://github.com/kamailio/kamailio/commit/5f590180c3acc5f786c1d0667997c1b3b8924ed9

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2022-02-15T08:10:54+01:00

async: docs for async_task_group_route(routename, groupname)

---

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

---

Diff:  https://github.com/kamailio/kamailio/commit/5f590180c3acc5f786c1d0667997c1b3b8924ed9.diff
Patch: https://github.com/kamailio/kamailio/commit/5f590180c3acc5f786c1d0667997c1b3b8924ed9.patch

---

diff --git a/src/modules/async/doc/async_admin.xml b/src/modules/async/doc/async_admin.xml
index a56c60d7d2..1db4d60e9e 100644
--- a/src/modules/async/doc/async_admin.xml
+++ b/src/modules/async/doc/async_admin.xml
@@ -287,8 +287,8 @@ route[REQUESTSHAPER] {
 		</title>
 		<para>
 		Continue the processing of the SIP request with the route[routename]
-		in one of the processes from core asynchronous framework. The core
-		parameter async_workers has to be set to enable asynchronous
+		in one of the processes from first group of core asynchronous framework.
+		The core parameter async_workers has to be set to enable asynchronous
 		framework. The task is executed as soon as a process from asynchronous
 		framework is idle, there is no wait time for the task like for
 		async_route(...).
@@ -339,6 +339,37 @@ route[RESUME] {
    exit;
 }
 ...
+</programlisting>
+	</example>
+	</section>
+	<section id="async.f.async_task_group_route">
+		<title>
+		<function moreinfo="none">async_task_group_route(routename, groupname)</function>
+		</title>
+		<para>
+		Similar to async_task_route(), but allows to specify the name of the group
+		for asynchronous workers. See also 'async_workers_group' core global
+		parameter.
+		</para>
+		<para>
+		This function can be used from REQUEST_ROUTE.
+		</para>
+		<example>
+		<title><function>async_task_group_route</function> usage</title>
+		<programlisting format="linespecific">
+...
+async_workers_group="name=abc;workers=4;nonblock=0;usleep=0"
+...
+request_route {
+    ...
+    async_task_route("RESUME", "abc");
+    ...
+}
+route[RESUME] {
+   t_relay();
+   exit;
+}
+...
 </programlisting>
 	</example>
 	</section>