Module: kamailio
Branch: master
Commit: 7d1e27e945b09674f07bdb56f69947b41e8e945a
URL: https://github.com/kamailio/kamailio/commit/7d1e27e945b09674f07bdb56f69947b…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2020-03-27T18:31:09+01:00
modules: readme files regenerated - usrloc ... [skip ci]
---
Modified: src/modules/usrloc/README
---
Diff: https://github.com/kamailio/kamailio/commit/7d1e27e945b09674f07bdb56f69947b…
Patch: https://github.com/kamailio/kamailio/commit/7d1e27e945b09674f07bdb56f69947b…
---
diff --git a/src/modules/usrloc/README b/src/modules/usrloc/README
index 4637de5a55..5f3592be47 100644
--- a/src/modules/usrloc/README
+++ b/src/modules/usrloc/README
@@ -93,6 +93,7 @@ Carsten Bock
3.51. ka_method (str)
3.52. ka_from (str)
3.53. ka_domain (str)
+ 3.54. ka_filter (int)
4. RPC Commands
@@ -193,6 +194,7 @@ Carsten Bock
1.51. ka_method parameter usage
1.52. ka_from parameter usage
1.53. ka_domain parameter usage
+ 1.54. ka_filter parameter usage
Chapter 1. Admin Guide
@@ -262,6 +264,7 @@ Chapter 1. Admin Guide
3.51. ka_method (str)
3.52. ka_from (str)
3.53. ka_domain (str)
+ 3.54. ka_filter (int)
4. RPC Commands
@@ -394,6 +397,7 @@ Chapter 1. Admin Guide
3.51. ka_method (str)
3.52. ka_from (str)
3.53. ka_domain (str)
+ 3.54. ka_filter (int)
3.1. nat_bflag (int)
@@ -1066,14 +1070,15 @@ 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').
+ feature enabled, 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
+ * 1 (bit 1 set) - 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
@@ -1134,6 +1139,22 @@ modparam("usrloc", "ka_from", "sip:server@mydomain.com")
modparam("usrloc", "ka_domain", "mydomain.com")
...
+3.54. ka_filter (int)
+
+ Set filters for keepalive processing.
+
+ Its value is a set of flags:
+ * 0 - if the value is zero, no filter is enabled for keepalives
+ * 1 (bit 1 set) - keepalives sent only to records matching the
+ server_id global parameter.
+
+ Default value is “0” (no filter).
+
+ Example 1.54. ka_filter parameter usage
+...
+modparam("usrloc", "ka_filter", 1)
+...
+
4. RPC Commands
4.1. ul.dump
Module: kamailio
Branch: master
Commit: 1968b3248acc9d71974f5765e489af82ecf4849a
URL: https://github.com/kamailio/kamailio/commit/1968b3248acc9d71974f5765e489af8…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2020-03-27T18:06:46+01:00
usrloc: docs for ka_filter parameter
---
Modified: src/modules/usrloc/doc/usrloc_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/1968b3248acc9d71974f5765e489af8…
Patch: https://github.com/kamailio/kamailio/commit/1968b3248acc9d71974f5765e489af8…
---
diff --git a/src/modules/usrloc/doc/usrloc_admin.xml b/src/modules/usrloc/doc/usrloc_admin.xml
index d4f96db94f..7b945a76bb 100644
--- a/src/modules/usrloc/doc/usrloc_admin.xml
+++ b/src/modules/usrloc/doc/usrloc_admin.xml
@@ -1229,9 +1229,12 @@ modparam("usrloc", "rm_expired_delay", 30)
<section id="usrloc.p.server_id_filter">
<title><varname>server_id_filter</varname> (int)</title>
<para>
- Enable (1) or disable (0) filter records by server_id on load and during cleaning of expired db records.
- It could be useful when you want to use the same location table for several kamailio instances which are configured to work in db_mode=1 or db_mode=2 (cache modes).
- Otherwise one instance of proxy cleans records made by another proxy and that breaks its cache.
+ Enable (1) or disable (0) filter records by server_id on load and
+ during cleaning of expired db records. It could be useful when you
+ want to use the same location table for several kamailio instances
+ which are configured to work in db_mode=1 or db_mode=2 (cache modes).
+ Otherwise one instance of proxy cleans records made by another proxy
+ and that breaks its cache.
</para>
<para>
<emphasis>
@@ -1271,7 +1274,7 @@ modparam("usrloc", "version_table", 0)
<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
+ enabled, 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>
@@ -1286,7 +1289,7 @@ modparam("usrloc", "version_table", 0)
</listitem>
<listitem>
<para>
- 1 - if set to 1, the keepalive is enabled for all contacts
+ 1 (bit 1 set) - if set to 1, the keepalive is enabled for all contacts
</para>
</listitem>
<listitem>
@@ -1349,7 +1352,7 @@ modparam("usrloc", "ka_method", "NOTIFY")
</example>
</section>
- <section id="usrloc.p.from">
+ <section id="usrloc.p.ka_from">
<title><varname>ka_from</varname> (str)</title>
<para>
The SIP URI to be set in the From header of the keepalive requests.
@@ -1367,7 +1370,7 @@ modparam("usrloc", "ka_from", "sip:server@mydomain.com")
</example>
</section>
- <section id="usrloc.p.domain">
+ <section id="usrloc.p.ka_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.
@@ -1387,6 +1390,40 @@ modparam("usrloc", "ka_domain", "mydomain.com")
</example>
</section>
+ <section id="usrloc.p.ka_filter">
+ <title><varname>ka_filter</varname> (int)</title>
+ <para>
+ Set filters for keepalive processing.
+ </para>
+ <para>
+ Its value is a set of flags:
+ </para>
+ <itemizedlist>
+ <listitem>
+ <para>
+ 0 - if the value is zero, no filter is enabled for keepalives
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ 1 (bit 1 set) - keepalives sent only to records matching the
+ server_id global parameter.
+ </para>
+ </listitem>
+ </itemizedlist>
+ <para>
+ Default value is <quote>0</quote> (no filter).
+ </para>
+ <example>
+ <title><varname>ka_filter</varname> parameter usage</title>
+ <programlisting format="linespecific">
+...
+modparam("usrloc", "ka_filter", 1)
+...
+ </programlisting>
+ </example>
+ </section>
+
</section>
<section>
## Description
### Add RTT metric to usrloc for measuring subscriber latency
This has been discussed several times in the mailing list. As I personally need this too I though it would be a good idea to open this issue for tracking. Unfortunately I'm not aware of the complexity of implementing this and I cannot code it myself, I'm happy to do any testing though or help with any other tasks.
Some threads were this has been commented and some solutions proposed by @miconda:
https://lists.kamailio.org/pipermail/sr-users/2015-April/088031.html (1st post, see complete thread)
https://lists.kamailio.org/pipermail/sr-users/2019-January/104291.html (1st post, see complete thread)
Thanks!
--
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/2223