Module: kamailio
Branch: 4.2
Commit: 3271a8f4fad18f525165b7c08037355679b01767
URL:
https://github.com/kamailio/kamailio/commit/3271a8f4fad18f525165b7c08037355679b01767
Author: Olle E. Johansson <o...@edvina.net>
Committer: Daniel-Constantin Mierla <mico...@gmail.com>
Date: 2015-01-28T13:37:22+01:00
async: Clarify difference between modparam("async","workers",x) and
async_workers in core config
(cherry picked from commit 06557a25af96d3de05d0302f202e6c4cbd0b84e9)
---
Modified: modules/async/README
Modified: modules/async/doc/async_admin.xml
---
Diff:
https://github.com/kamailio/kamailio/commit/3271a8f4fad18f525165b7c08037355679b01767.diff
Patch:
https://github.com/kamailio/kamailio/commit/3271a8f4fad18f525165b7c08037355679b01767.patch
---
diff --git a/modules/async/README b/modules/async/README
index 327dc68..ce4daf3 100644
--- a/modules/async/README
+++ b/modules/async/README
@@ -38,7 +38,8 @@ Daniel-Constantin Mierla
1.1. Set workers parameter
1.2. async_route usage
1.3. async_sleep usage
- 1.4. async_task_route usage
+ 1.4. async_workers usage
+ 1.5. async_task_route usage
Chapter 1. Admin Guide
@@ -97,7 +98,7 @@ Chapter 1. Admin Guide
3.1. workers (int)
Number of worker processes to be started to handle the asynchronous
- tasks.
+ tasks for async_route() and async_sleep().
Default value is 1.
@@ -170,6 +171,16 @@ exit;
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(...).
+ To enable the core asynchronous framework, you need to set the
+ async_workers core parameter in the configuration file. See the core
+ cookbook for more information.
+
+ Example 1.4. async_workers usage
+...
+; Enable 8 worker processes used by async and other modules
+async_workers=8
+...
+
In case of internal errors, the function returns false, otherwise the
function exits the execution of the script at that moment (return 0
behaviour).
@@ -184,7 +195,7 @@ exit;
This function can be used from REQUEST_ROUTE.
- Example 1.4. async_task_route usage
+ Example 1.5. async_task_route usage
...
async_task_route("RESUME");
...
diff --git a/modules/async/doc/async_admin.xml
b/modules/async/doc/async_admin.xml
index 18d9388..31ad797 100644
--- a/modules/async/doc/async_admin.xml
+++ b/modules/async/doc/async_admin.xml
@@ -70,7 +70,7 @@
<title><varname>workers</varname> (int)</title>
<para>
Number of worker processes to be started to handle the
asynchronous
- tasks.
+ tasks for async_route() and async_sleep().
</para>
<para>
<emphasis>
@@ -175,6 +175,20 @@ exit;
async_route(...).
</para>
<para>
+ To enable the core asynchronous framework, you need to set the
+ <emphasis>async_workers</emphasis> core parameter in the
configuration
+ file. See the core cookbook for more information.
+ <example>
+ <title><function>async_workers</function> usage</title>
+ <programlisting format="linespecific">
+...
+; Enable 8 worker processes used by async and other modules
+async_workers=8
+...
+</programlisting>
+ </example>
+ </para>
+ <para>
In case of internal errors, the function returns false,
otherwise the
function exits the execution of the script at that moment
(return
0 behaviour).
_______________________________________________
sr-dev mailing list
sr-dev@lists.sip-router.org
http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
