Module: kamailio
Branch: master
Commit: e1c9e07fc129569143063f38fec34f5a01151e26
URL: https://github.com/kamailio/kamailio/commit/e1c9e07fc129569143063f38fec34f5…
Author: Giacomo Vacca <giacomo.vacca(a)gmail.com>
Committer: Giacomo Vacca <giacomo.vacca(a)gmail.com>
Date: 2015-12-17T09:38:32Z
cfgt: improved documentation
- Provide an example of Call-ID to identify a scenario
---
Modified: modules/cfgt/doc/cfgt_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/e1c9e07fc129569143063f38fec34f5…
Patch: https://github.com/kamailio/kamailio/commit/e1c9e07fc129569143063f38fec34f5…
---
diff --git a/modules/cfgt/doc/cfgt_admin.xml b/modules/cfgt/doc/cfgt_admin.xml
index 07b8ea4..e507456 100644
--- a/modules/cfgt/doc/cfgt_admin.xml
+++ b/modules/cfgt/doc/cfgt_admin.xml
@@ -23,7 +23,7 @@
</para>
<para>
In order to identify defferent scenarios a prefix string should be
- used at Call-ID header.
+ used inside the Call-ID header.
</para>
</section>
<section>
@@ -62,7 +62,7 @@
<title><varname>basedir</varname> (string)</title>
<para>
Control where the config reports should be stored. The dir must
- exists and &kamailioname; must have perms to write on it.
+ exist and &kamailioname; must have permissions to write on it.
</para>
<para>
<emphasis>
@@ -126,7 +126,9 @@ modparam("cfgt", "mask", 12)
<title><varname>callid_prefix</varname> (string)</title>
<para>
Prefix used to indentify test scenario messages. Last char of the
- string will be used as delimiter.
+ string will be used as delimiter for the scenario ID. With parameter
+ set to <quote>NGCP%</quote> and Call-ID <quote>NGCP%123%456</quote>
+ the scenario identified will be <quote>123</quote>.
</para>
<para>
<emphasis>
Module: kamailio
Branch: 4.2
Commit: 2a802634cfd176ce6920f827fb3bb2a2749e3d84
URL: https://github.com/kamailio/kamailio/commit/2a802634cfd176ce6920f827fb3bb2a…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2015-12-17T10:27:50+01:00
evapi: readme regenerated
---
Modified: modules/evapi/README
---
Diff: https://github.com/kamailio/kamailio/commit/2a802634cfd176ce6920f827fb3bb2a…
Patch: https://github.com/kamailio/kamailio/commit/2a802634cfd176ce6920f827fb3bb2a…
---
diff --git a/modules/evapi/README b/modules/evapi/README
index 6035cce..4d61f8e 100644
--- a/modules/evapi/README
+++ b/modules/evapi/README
@@ -160,8 +160,16 @@ modparam("evapi", "netstring_format", 0)
4.1. evapi_relay(evdata)
- Relay the event data give as parameter to connected applications. The
- format on the network is netstring with evdata payload.
+ Relay the event data given as parameter to connected applications.
+
+ The format on the network is netstring with evdata payload if
+ netstring_format parameter is set to 1 or bare evdata if
+ netstring_format parameter is set to 0.
+
+ The function is passing the task to evapi dispatcher process, therefore
+ the SIP worker process is not blocked. Also, it doesn't wait for any
+ response, therefore the processing of the configuration continues very
+ fast when executing evapi_relay().
This function can be used from ANY_ROUTE.
@@ -182,10 +190,17 @@ evapi_relay("{ \"event\": \"test\",\n \"data\": { \"fU\": \"$fU\" }\n}");
4.2. evapi_async_relay(evdata)
- Relay the event data give as parameter to connected applications. The
- format on the network is netstring with evdata payload. Before
- evaluating the parameter, the request processing is suspended using tm
- module.
+ Relay the event data given as parameter to connected applications.
+ Before evaluating the parameter, the request processing is suspended
+ using tm module (using the t_suspend()/t_continue() framework). The
+ routing of the SIP request can be continued once
+ event_route[evapi:message-received] is triggered. After
+ evapi_async_relay() returns true, no relaying should happen in
+ request_route(), it should be followed by exit;.
+
+ The format on the network is netstring with evdata payload if
+ netstring_format parameter is set to 1 or bare evdata if
+ netstring_format parameter is set to 0.
This function can be used from REQUEST_ROUTE.