Module: kamailio
Branch: master
Commit: e792de60d24386cdd3816b67d4778f4eba33b0f0
URL:
https://github.com/kamailio/kamailio/commit/e792de60d24386cdd3816b67d4778f4…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2022-03-30T08:46:20+02:00
modules: readme files regenerated - evrexec ... [skip ci]
---
Modified: src/modules/evrexec/README
---
Diff:
https://github.com/kamailio/kamailio/commit/e792de60d24386cdd3816b67d4778f4…
Patch:
https://github.com/kamailio/kamailio/commit/e792de60d24386cdd3816b67d4778f4…
---
diff --git a/src/modules/evrexec/README b/src/modules/evrexec/README
index f7363c4c43..4d80d4c006 100644
--- a/src/modules/evrexec/README
+++ b/src/modules/evrexec/README
@@ -57,11 +57,12 @@ Chapter 1. Admin Guide
1. Overview
The module executes event route blocks or KEMI functions on dedicated
- processes at startup. The execution can be delayed for a specified
- interval of time.
+ processes at startup, upon an RPC command or data received on a custom
+ UDP socket.
- The actions in the event route should be a loop or other tasks that run
- forever.
+ For startup event route, the execution can be delayed for a specified
+ interval of time. The actions in the event route should be a loop or
+ other tasks that run forever.
2. Dependencies
@@ -87,7 +88,8 @@ Chapter 1. Admin Guide
The definition of an exec task. The value of the parameter must have
the following format:
- * "name=_string_;wait=_number_;workers=_number_"
+ * "name=_string_;wait=_number_;workers=_number_;sockaddr=_udp_socket_
+ "
The parameter can be set multiple times to get more exec tasks in same
configuration file.
@@ -97,15 +99,20 @@ Chapter 1. Admin Guide
will retrieve the index of the works in string format.
* workers - if set to 0 or 1 the task is executed in a dedicated
process. Any number > 1 will create more dedicated processes, each
- of them executing the task.
+ of them executing the startup task. For UDP data execution (when
+ 'sockaddr' is set), only 1 worker process is created.
* wait - timer interval in micro-seconds to wait inside the dedicated
process before executing the task.
+ * sockaddr - full UDP socket address in format 'udp:ip:port'
+ (example: 'udp:127.0.0.1:54321').
Default value is NULL.
Example 1.1. Set exec parameter
...
modparam("evrexec", "exec",
"name=evrexec:timer;wait=1000;workers=1;")
+modparam("evrexec", "exec",
"name=evrexec:udp;sockaddr=udp:127.0.0.1:4444;worker
+s=1;")
...
event_route[evrexec:timer] {
$var(x) = 0;
@@ -115,6 +122,11 @@ event_route[evrexec:timer] {
sleep("600");
}
}
+
+event_route[evrexec:udp] {
+ xinfo("udp socket data: [$evr(data)]\n");
+}
+
...
4. RPC Commands