Module: kamailio
Branch: master
Commit: b4d38c4a1bf40e190628a82db87a2b913abecf22
URL: https://github.com/kamailio/kamailio/commit/b4d38c4a1bf40e190628a82db87a2b9…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2020-03-27T10:31:18+01:00
modules: readme files regenerated - usrloc ... [skip ci]
---
Modified: src/modules/usrloc/README
---
Diff: https://github.com/kamailio/kamailio/commit/b4d38c4a1bf40e190628a82db87a2b9…
Patch: https://github.com/kamailio/kamailio/commit/b4d38c4a1bf40e190628a82db87a2b9…
---
diff --git a/src/modules/usrloc/README b/src/modules/usrloc/README
index 2cc6ddc0f3..4637de5a55 100644
--- a/src/modules/usrloc/README
+++ b/src/modules/usrloc/README
@@ -89,6 +89,10 @@ Carsten Bock
3.47. rm_expired_delay (int)
3.48. server_id_filter (int)
3.49. version_table (int)
+ 3.50. ka_mode (int)
+ 3.51. ka_method (str)
+ 3.52. ka_from (str)
+ 3.53. ka_domain (str)
4. RPC Commands
@@ -185,6 +189,10 @@ Carsten Bock
1.47. Set rm_expired_delay parameter
1.48. Set server_id_filter parameter
1.49. version_table parameter usage
+ 1.50. ka_mode parameter usage
+ 1.51. ka_method parameter usage
+ 1.52. ka_from parameter usage
+ 1.53. ka_domain parameter usage
Chapter 1. Admin Guide
@@ -250,6 +258,10 @@ Chapter 1. Admin Guide
3.47. rm_expired_delay (int)
3.48. server_id_filter (int)
3.49. version_table (int)
+ 3.50. ka_mode (int)
+ 3.51. ka_method (str)
+ 3.52. ka_from (str)
+ 3.53. ka_domain (str)
4. RPC Commands
@@ -378,6 +390,10 @@ Chapter 1. Admin Guide
3.47. rm_expired_delay (int)
3.48. server_id_filter (int)
3.49. version_table (int)
+ 3.50. ka_mode (int)
+ 3.51. ka_method (str)
+ 3.52. ka_from (str)
+ 3.53. ka_domain (str)
3.1. nat_bflag (int)
@@ -1047,6 +1063,77 @@ modparam("usrloc", "server_id_filter", 1)
modparam("usrloc", "version_table", 0)
...
+3.50. ka_mode (int)
+
+ Keepalive mode - control the internal keepalive mechanism. With this
+ feature enable, the module sends periodically (based on timer interval)
+ SIP requests to location contacts and measures the round trip in
+ microseconds (the round trip value can be seen in the response of the
+ RPC command 'ul.dump').
+
+ Its value is a set of flags:
+ * 0 - if the value is zero, no keepalive is sent
+ * 1 - if set to 1, the keepalive is enabled for all contacts
+ * 2 (bit 2 set) - the keepalive is sent only for natted contacts
+ (nat_bflag set)
+ * 4 (bit 3 set) - the keepalive is sent only for UDP contacts
+
+ For example, if set to 6, then keepalive is sent only natted UDP
+ contacs.
+
+ Note: the internal keepalive of usrloc module conflicts in some way
+ with the keepalive done by nathelper module. It is recommended to
+ enable only one.
+
+ Note: the internal keepalive is for the moment implemented only for
+ contact records stored in memory.
+
+ Note: it is recommeder to set 'timer_procs' parameter in order to have
+ dedicated timer processes for usrloc module and off-load the keepalive
+ sending process from the core timers.
+
+ Default value is “0 (keepalive disabled)”.
+
+ Example 1.50. ka_mode parameter usage
+...
+modparam("usrloc", "ka_mode", 1)
+...
+
+3.51. ka_method (str)
+
+ The SIP method type for keepalive requests.
+
+ Default value is “OPTIONS”.
+
+ Example 1.51. ka_method parameter usage
+...
+modparam("usrloc", "ka_method", "NOTIFY")
+...
+
+3.52. ka_from (str)
+
+ The SIP URI to be set in the From header of the keepalive requests.
+
+ Default value is “sip:server@kamailio.org”.
+
+ Example 1.52. ka_from parameter usage
+...
+modparam("usrloc", "ka_from", "sip:server@mydomain.com")
+...
+
+3.53. ka_domain (str)
+
+ The domain to be set in To header URI if the multi-domain is not
+ enabled. If multi-domain is enabled, then the domain from the location
+ record is used and this parameter is ignored.
+
+ Default value is “kamailio.org”.
+
+ Example 1.53. ka_domain parameter usage
+...
+modparam("usrloc", "ka_domain", "mydomain.com")
+...
+
4. RPC Commands
4.1. ul.dump
Module: kamailio
Branch: master
Commit: d1a221af4cac226199365c18a6a121090dc4cf82
URL: https://github.com/kamailio/kamailio/commit/d1a221af4cac226199365c18a6a1210…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2020-03-27T10:16:03+01:00
usrloc: docs for keepalive parameters
---
Modified: src/modules/usrloc/doc/usrloc_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/d1a221af4cac226199365c18a6a1210…
Patch: https://github.com/kamailio/kamailio/commit/d1a221af4cac226199365c18a6a1210…
---
diff --git a/src/modules/usrloc/doc/usrloc_admin.xml b/src/modules/usrloc/doc/usrloc_admin.xml
index 902d0586c1..d4f96db94f 100644
--- a/src/modules/usrloc/doc/usrloc_admin.xml
+++ b/src/modules/usrloc/doc/usrloc_admin.xml
@@ -1267,6 +1267,126 @@ modparam("usrloc", "version_table", 0)
</example>
</section>
+ <section id="usrloc.p.ka_mode">
+ <title><varname>ka_mode</varname> (int)</title>
+ <para>
+ Keepalive mode - control the internal keepalive mechanism. With this feature
+ enable, the module sends periodically (based on timer interval) SIP requests
+ to location contacts and measures the round trip in microseconds (the
+ round trip value can be seen in the response of the RPC command 'ul.dump').
+ </para>
+ <para>
+ Its value is a set of flags:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ 0 - if the value is zero, no keepalive is sent
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ 1 - if set to 1, the keepalive is enabled for all contacts
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ 2 (bit 2 set) - the keepalive is sent only for natted contacts
+ (nat_bflag set)
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ 4 (bit 3 set) - the keepalive is sent only for UDP contacts
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ For example, if set to 6, then keepalive is sent only natted UDP contacs.
+ </para>
+ <para>
+ Note: the internal keepalive of usrloc module conflicts in some way with
+ the keepalive done by nathelper module. It is recommended to enable only
+ one.
+ </para>
+ <para>
+ Note: the internal keepalive is for the moment implemented only for
+ contact records stored in memory.
+ </para>
+ <para>
+ Note: it is recommeder to set 'timer_procs' parameter in order to have
+ dedicated timer processes for usrloc module and off-load the keepalive
+ sending process from the core timers.
+ </para>
+ <para>
+ Default value is <quote>0 (keepalive disabled)</quote>.
+ </para>
+ <example>
+ <title><varname>ka_mode</varname> parameter usage</title>
+ <programlisting format="linespecific">
+...
+modparam("usrloc", "ka_mode", 1)
+...
+ </programlisting>
+ </example>
+ </section>
+
+ <section id="usrloc.p.ka_method">
+ <title><varname>ka_method</varname> (str)</title>
+ <para>
+ The SIP method type for keepalive requests.
+ </para>
+ <para>
+ Default value is <quote>OPTIONS</quote>.
+ </para>
+ <example>
+ <title><varname>ka_method</varname> parameter usage</title>
+ <programlisting format="linespecific">
+...
+modparam("usrloc", "ka_method", "NOTIFY")
+...
+ </programlisting>
+ </example>
+ </section>
+
+ <section id="usrloc.p.from">
+ <title><varname>ka_from</varname> (str)</title>
+ <para>
+ The SIP URI to be set in the From header of the keepalive requests.
+ </para>
+ <para>
+ Default value is <quote>sip:server@kamailio.org</quote>.
+ </para>
+ <example>
+ <title><varname>ka_from</varname> parameter usage</title>
+ <programlisting format="linespecific">
+...
+modparam("usrloc", "ka_from", "sip:server@mydomain.com")
+...
+ </programlisting>
+ </example>
+ </section>
+
+ <section id="usrloc.p.domain">
+ <title><varname>ka_domain</varname> (str)</title>
+ <para>
+ The domain to be set in To header URI if the multi-domain is not enabled.
+ If multi-domain is enabled, then the domain from the location record is
+ used and this parameter is ignored.
+ </para>
+ <para>
+ Default value is <quote>kamailio.org</quote>.
+ </para>
+ <example>
+ <title><varname>ka_domain</varname> parameter usage</title>
+ <programlisting format="linespecific">
+...
+modparam("usrloc", "ka_domain", "mydomain.com")
+...
+ </programlisting>
+ </example>
+ </section>
+
</section>
<section>
Module: kamailio
Branch: 5.3
Commit: d91b5440947884ac00889bfc985d35564699dc8f
URL: https://github.com/kamailio/kamailio/commit/d91b5440947884ac00889bfc985d355…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2020-03-27T08:46:30+01:00
modules: readme files regenerated - modules ... [skip ci]
---
Modified: src/modules/corex/README
Modified: src/modules/pike/README
Modified: src/modules/sst/README
---
Diff: https://github.com/kamailio/kamailio/commit/d91b5440947884ac00889bfc985d355…
Patch: https://github.com/kamailio/kamailio/commit/d91b5440947884ac00889bfc985d355…
---
diff --git a/src/modules/corex/README b/src/modules/corex/README
index a67289bdb5..e9f8045f3a 100644
--- a/src/modules/corex/README
+++ b/src/modules/corex/README
@@ -10,8 +10,6 @@ Daniel-Constantin Mierla
<miconda(a)gmail.com>
-Edited by
-
Muhammad Shahzad Shafi
<shahzad(a)voip-demos.com>
@@ -574,7 +572,15 @@ via_add_srv("1");
Example 1.23. via_add_xavp_params usage
...
-via_add_xavp_params("1");
+xavp_via_params="xvia"
+...
+request_route {
+ ...
+ $xavp(xvia=>srvid) = "1";
+ $xavp(xvia[0]=>myval) = "xyz";
+ via_add_xavp_params("1");
+ ...
+}
...
4.20. via_use_xavp_fields(flags)
@@ -589,7 +595,15 @@ via_add_xavp_params("1");
Example 1.24. via_use_xavp_fields usage
...
-via_use_xavp_fields("1");
+xavp_via_fields="mvia"
+...
+request_route {
+ ...
+ $xavp(mvia=>address) = "10.10.10.10";
+ $xavp(mvia[0]=>port) = "5060";
+ via_use_xavp_fields("1");
+ ...
+}
...
5. RPC Commands
diff --git a/src/modules/pike/README b/src/modules/pike/README
index 34a26d7020..a7f66697e7 100644
--- a/src/modules/pike/README
+++ b/src/modules/pike/README
@@ -247,9 +247,9 @@ Chapter 3. Developer Guide
Example 3.1. Tree of IP addresses
/ 193 - 175 - 132 - 164
-tree root / \ 142
+tree root / \ - 142
\ 195 - 37 - 78 - 163
- \ 79 - 134
+ \ - 79 - 134
To detect the whole address, step by step, from the root to the leafs,
the nodes corresponding to each byte of the ip address are expanded. In
diff --git a/src/modules/sst/README b/src/modules/sst/README
index 725cffc95d..3444863563 100644
--- a/src/modules/sst/README
+++ b/src/modules/sst/README
@@ -219,20 +219,36 @@ modparam("sst", "min_se", 2400)
4.3. timeout_avp (string)
- This parameter MUST be set to the same value as the dialog module
- parameter of the same name. If this parameter is NOT set, the sst
- module will not do anything!
+ This parameter must be set to the same value as the dialog module
+ parameter of the same name, when it is wanted to update dialog timeout
+ using Session-Expires header value. If this parameter is not set, the
+ sst module will not update dialog timeout.
- This is how the sst module knows which avp in the dialog module it has
- to change with the new expire value.
+ With this parameter, the sst module knows which avp is expected by the
+ dialog module to change to a new expire value.
- Default value is “NULL!” it is not set by default.
+ Note that the avp is set only for requests within dialog, not for the
+ initial INVITE. For this one, it can be done using script operations,
+ see the next example for such solution.
+
+ Default value is “NULL” (not set by default).
Example 1.4. Set timeout_avp parameter
...
-modparam("dialog", "timeout_avp", "$avp(i:10)")
+modparam("dialog", "timeout_avp", "$avp(dlgtimeout)")
# Set the sst modules timeout_avp to be the same value
-modparam("sst", "timeout_avp", "$avp(i:10)")
+modparam("sst", "timeout_avp", "$avp(dlgtimeout)")
+...
+request_route {
+ ...
+ # when wanting to use Session-Expires value for initial INVITE
+ if(is_method("INVITE") and !has_totag()) {
+ if(is_present_hf("Session-Expires")) {
+ $avp(dlgtimeout) = $(hdr(Session-Expires){s.int});
+ }
+ }
+ ...
+}
...
4.4. reject_to_small (integer)
### Description
Ability to flush on-demand htable from memory to DB.
### Possible Solutions
Implement a new RPC `htable.flush` command
Flush hash table to database.
Name: dhtable.flush
Parameters:
htable : Name of the hash table to flush
Example:
...
kamcmd htable.flush
...
--
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/issues/2201
Module: kamailio
Branch: master
Commit: de8493232eb6aefa742e038cb3ca6282aadf1a6a
URL: https://github.com/kamailio/kamailio/commit/de8493232eb6aefa742e038cb3ca628…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2020-03-26T22:46:08+01:00
modules: readme files regenerated - lost ... [skip ci]
---
Modified: src/modules/lost/README
---
Diff: https://github.com/kamailio/kamailio/commit/de8493232eb6aefa742e038cb3ca628…
Patch: https://github.com/kamailio/kamailio/commit/de8493232eb6aefa742e038cb3ca628…
---
diff --git a/src/modules/lost/README b/src/modules/lost/README
index 036451cd21..be5e43711c 100644
--- a/src/modules/lost/README
+++ b/src/modules/lost/README
@@ -198,7 +198,8 @@ Chapter 1. Admin Guide
* pidf-lo - the PIDF-LO returned in the HELD locationRequest response
* url - the location reference returned in the HELD locationRequest
response - this reference may be added as Geolocation header value
- and forwarded downstream
+ and forwarded downstream Note: to work properly, it is required to
+ include "locationURI" in the location_type parameter.
* error - any error code returned in the HELD locationRequest
response