|
@@ -11,7 +11,9 @@
|
|
|
|
|
|
<section>
|
|
<section>
|
|
<title>Overview</title>
|
|
<title>Overview</title>
|
|
- <para>This module serves as a storage engine for SCSCF contacts, much like the standard Kamailio module that is usrloc, is a storage engine for standard SIP contacts.</para>
|
|
|
|
|
|
+ <para>This module serves as a storage engine for SCSCF contacts, much like
|
|
|
|
+ the standard Kamailio module that is usrloc, is a storage engine
|
|
|
|
+ for standard SIP contacts.</para>
|
|
</section>
|
|
</section>
|
|
<section>
|
|
<section>
|
|
<title>Dependencies</title>
|
|
<title>Dependencies</title>
|
|
@@ -40,14 +42,17 @@
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>db_url</varname> parameter</title>
|
|
<title>Set <varname>db_url</varname> parameter</title>
|
|
<programlisting format="linespecific">
|
|
<programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "db_url", "mysql//username:password@localhost/scscf")
|
|
modparam("ims_usrloc_scscf", "db_url", "mysql//username:password@localhost/scscf")
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
<section id="ims_usrloc_scscf.p.db_mode">
|
|
<section id="ims_usrloc_scscf.p.db_mode">
|
|
<title><varname>db_mode</varname> (string)</title>
|
|
<title><varname>db_mode</varname> (string)</title>
|
|
- <para>This is the database mode to be used for the SCSCF usrloc data persistent storage. Currently this module supports the Write-Back scheme only.</para>
|
|
|
|
|
|
+ <para>This is the database mode to be used for the SCSCF usrloc data persistent
|
|
|
|
+ storage. Currently this module supports the Write-Back scheme only.</para>
|
|
<itemizedlist>
|
|
<itemizedlist>
|
|
<listitem>
|
|
<listitem>
|
|
<para>
|
|
<para>
|
|
@@ -57,16 +62,19 @@
|
|
</listitem>
|
|
</listitem>
|
|
<listitem>
|
|
<listitem>
|
|
<para>
|
|
<para>
|
|
- 1 - Write-Backend scheme. All changes are made to memory and database synchronization is done in the timer
|
|
|
|
|
|
+ 1 - Write-Backend scheme. All changes are made to memory and database
|
|
|
|
+ synchronization is done in the timer
|
|
</para>
|
|
</para>
|
|
</listitem>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</itemizedlist>
|
|
<para><emphasis> Default value is 0. </emphasis></para>
|
|
<para><emphasis> Default value is 0. </emphasis></para>
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>db_mode</varname> parameter</title>
|
|
<title>Set <varname>db_mode</varname> parameter</title>
|
|
- <programlisting format="linespecific">...
|
|
|
|
|
|
+ <programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "db_mode", 1)
|
|
modparam("ims_usrloc_scscf", "db_mode", 1)
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
<section id="ims_usrloc_scscf.p.maxcontact">
|
|
<section id="ims_usrloc_scscf.p.maxcontact">
|
|
@@ -75,9 +83,11 @@
|
|
<para><emphasis>Default value is 0(max)</emphasis></para>
|
|
<para><emphasis>Default value is 0(max)</emphasis></para>
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>maxcontact</varname> parameter</title>
|
|
<title>Set <varname>maxcontact</varname> parameter</title>
|
|
- <programlisting format="linespecific">...
|
|
|
|
|
|
+ <programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "maxcontact", 10)
|
|
modparam("ims_usrloc_scscf", "maxcontact", 10)
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
<section id="ims_usrloc_scscf.p.maxcontact_3gpp">
|
|
<section id="ims_usrloc_scscf.p.maxcontact_3gpp">
|
|
@@ -86,9 +96,11 @@
|
|
<para><emphasis> Default value is 0.(max) </emphasis></para>
|
|
<para><emphasis> Default value is 0.(max) </emphasis></para>
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>maxcontact_3gpp</varname> parameter</title>
|
|
<title>Set <varname>maxcontact_3gpp</varname> parameter</title>
|
|
- <programlisting format="linespecific">...
|
|
|
|
|
|
+ <programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "maxcontact_3gpp", 0)
|
|
modparam("ims_usrloc_scscf", "maxcontact_3gpp", 0)
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
<section id="ims_usrloc_scscf.p.maxcontact_behaviour">
|
|
<section id="ims_usrloc_scscf.p.maxcontact_behaviour">
|
|
@@ -114,9 +126,11 @@
|
|
<para><emphasis> Default value is 0. </emphasis></para>
|
|
<para><emphasis> Default value is 0. </emphasis></para>
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>maxcontact_behaviour</varname> parameter</title>
|
|
<title>Set <varname>maxcontact_behaviour</varname> parameter</title>
|
|
- <programlisting format="linespecific">...
|
|
|
|
|
|
+ <programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "maxcontact_behaviour", 2)
|
|
modparam("ims_usrloc_scscf", "maxcontact_behaviour", 2)
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
<section id="ims_usrloc_scscf.p.max_subscribes">
|
|
<section id="ims_usrloc_scscf.p.max_subscribes">
|
|
@@ -125,9 +139,11 @@
|
|
<para><emphasis> Default value is 0. </emphasis></para>
|
|
<para><emphasis> Default value is 0. </emphasis></para>
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>max_subscribes</varname> parameter</title>
|
|
<title>Set <varname>max_subscribes</varname> parameter</title>
|
|
- <programlisting format="linespecific">...
|
|
|
|
|
|
+ <programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "max_subscribes", 2)
|
|
modparam("ims_usrloc_scscf", "max_subscribes", 2)
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
<section id="ims_usrloc_scscf.p.sub_dialog_hash_size">
|
|
<section id="ims_usrloc_scscf.p.sub_dialog_hash_size">
|
|
@@ -136,9 +152,11 @@
|
|
<para><emphasis> Default value is 10. </emphasis></para>
|
|
<para><emphasis> Default value is 10. </emphasis></para>
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>sub_dialog_hash_size</varname> parameter</title>
|
|
<title>Set <varname>sub_dialog_hash_size</varname> parameter</title>
|
|
- <programlisting format="linespecific">...
|
|
|
|
|
|
+ <programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "sub_dialog_hash_size", 512)
|
|
modparam("ims_usrloc_scscf", "sub_dialog_hash_size", 512)
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
<section id="ims_usrloc_scscf.p.timer_procs">
|
|
<section id="ims_usrloc_scscf.p.timer_procs">
|
|
@@ -147,9 +165,11 @@
|
|
<para><emphasis> Default value is 0 </emphasis></para>
|
|
<para><emphasis> Default value is 0 </emphasis></para>
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>timer_procs</varname> parameter</title>
|
|
<title>Set <varname>timer_procs</varname> parameter</title>
|
|
- <programlisting format="linespecific">...
|
|
|
|
|
|
+ <programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "timer_procs", 5)
|
|
modparam("ims_usrloc_scscf", "timer_procs", 5)
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
<section id="ims_usrloc_scscf.p.timer_interval">
|
|
<section id="ims_usrloc_scscf.p.timer_interval">
|
|
@@ -159,19 +179,24 @@
|
|
<para><emphasis> Default value is 90 </emphasis></para>
|
|
<para><emphasis> Default value is 90 </emphasis></para>
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>timer_interval</varname> parameter</title>
|
|
<title>Set <varname>timer_interval</varname> parameter</title>
|
|
- <programlisting format="linespecific">...
|
|
|
|
|
|
+ <programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "timer_interval", 120)
|
|
modparam("ims_usrloc_scscf", "timer_interval", 120)
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
<section id="ims_usrloc_scscf.p.desc_time_order">
|
|
<section id="ims_usrloc_scscf.p.desc_time_order">
|
|
<title>desc_time_order (int)</title>
|
|
<title>desc_time_order (int)</title>
|
|
- <para>If the user's contacts should be kept timestamp ordered; otherwise the contact will be ordered based on q value. Non 0 value means true.</para>
|
|
|
|
|
|
+ <para>If the user's contacts should be kept timestamp ordered; otherwise the contact
|
|
|
|
+ will be ordered based on q value. Non 0 value means true.</para>
|
|
<para><emphasis> Default value is timestamp ordering not enabled </emphasis></para>
|
|
<para><emphasis> Default value is timestamp ordering not enabled </emphasis></para>
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>desc_time_order</varname> parameter</title>
|
|
<title>Set <varname>desc_time_order</varname> parameter</title>
|
|
- <programlisting format="linespecific">...
|
|
|
|
|
|
+ <programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "desc_time_order", 1)
|
|
modparam("ims_usrloc_scscf", "desc_time_order", 1)
|
|
|
|
+...
|
|
</programlisting>
|
|
</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
@@ -203,9 +228,11 @@
|
|
<para><emphasis> Default value is 0. </emphasis></para>
|
|
<para><emphasis> Default value is 0. </emphasis></para>
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>matching_mode</varname> parameter</title>
|
|
<title>Set <varname>matching_mode</varname> parameter</title>
|
|
- <programlisting format="linespecific">...
|
|
|
|
|
|
+ <programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "matching_mode", 0)
|
|
modparam("ims_usrloc_scscf", "matching_mode", 0)
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
<section id="ims_usrloc_scscf.p.cseq_delay">
|
|
<section id="ims_usrloc_scscf.p.cseq_delay">
|
|
@@ -214,9 +241,11 @@
|
|
<para><emphasis> Default value is 20. </emphasis></para>
|
|
<para><emphasis> Default value is 20. </emphasis></para>
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>cseq_delay</varname> parameter</title>
|
|
<title>Set <varname>cseq_delay</varname> parameter</title>
|
|
- <programlisting format="linespecific">...
|
|
|
|
|
|
+ <programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "cseq_delay", 20)
|
|
modparam("ims_usrloc_scscf", "cseq_delay", 20)
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
<section id="ims_usrloc_scscf.p.fetch_rows">
|
|
<section id="ims_usrloc_scscf.p.fetch_rows">
|
|
@@ -225,9 +254,11 @@
|
|
<para><emphasis> Default value is 2000. </emphasis></para>
|
|
<para><emphasis> Default value is 2000. </emphasis></para>
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>fetch_rows</varname> parameter</title>
|
|
<title>Set <varname>fetch_rows</varname> parameter</title>
|
|
- <programlisting format="linespecific">...
|
|
|
|
|
|
+ <programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "fetch_rows", 3000)
|
|
modparam("ims_usrloc_scscf", "fetch_rows", 3000)
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
<section id="ims_usrloc_scscf.p.hash_size">
|
|
<section id="ims_usrloc_scscf.p.hash_size">
|
|
@@ -236,9 +267,11 @@
|
|
<para><emphasis> Default value 512</emphasis></para>
|
|
<para><emphasis> Default value 512</emphasis></para>
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>hash_size</varname> parameter</title>
|
|
<title>Set <varname>hash_size</varname> parameter</title>
|
|
- <programlisting format="linespecific">...
|
|
|
|
|
|
+ <programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "hash_size", 512)
|
|
modparam("ims_usrloc_scscf", "hash_size", 512)
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
<section id="ims_usrloc_scscf.p.subs_hash_size">
|
|
<section id="ims_usrloc_scscf.p.subs_hash_size">
|
|
@@ -247,9 +280,11 @@
|
|
<para><emphasis> Default value 512</emphasis></para>
|
|
<para><emphasis> Default value 512</emphasis></para>
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>subs_hash_size</varname> parameter</title>
|
|
<title>Set <varname>subs_hash_size</varname> parameter</title>
|
|
- <programlisting format="linespecific">...
|
|
|
|
|
|
+ <programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "subs_hash_size", 512)
|
|
modparam("ims_usrloc_scscf", "subs_hash_size", 512)
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
<section id="ims_usrloc_scscf.p.contacts_hash_size">
|
|
<section id="ims_usrloc_scscf.p.contacts_hash_size">
|
|
@@ -258,9 +293,11 @@
|
|
<para><emphasis> Default value is 512</emphasis></para>
|
|
<para><emphasis> Default value is 512</emphasis></para>
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>contacts_hash_size</varname> parameter</title>
|
|
<title>Set <varname>contacts_hash_size</varname> parameter</title>
|
|
- <programlisting format="linespecific">...
|
|
|
|
|
|
+ <programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "contacts_hash_size", 512)
|
|
modparam("ims_usrloc_scscf", "contacts_hash_size", 512)
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
<section id="ims_usrloc_scscf.p.nat_bflag">
|
|
<section id="ims_usrloc_scscf.p.nat_bflag">
|
|
@@ -270,8 +307,10 @@
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>nat_bflag</varname> parameter</title>
|
|
<title>Set <varname>nat_bflag</varname> parameter</title>
|
|
<programlisting format="linespecific">
|
|
<programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "nat_bflag", 3)
|
|
modparam("ims_usrloc_scscf", "nat_bflag", 3)
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
<section id="ims_usrloc_scscf.p.contact_delete_delay">
|
|
<section id="ims_usrloc_scscf.p.contact_delete_delay">
|
|
@@ -281,8 +320,10 @@
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>contact_delete_delay</varname>parameter</title>
|
|
<title>Set <varname>contact_delete_delay</varname>parameter</title>
|
|
<programlisting format="linespecific">
|
|
<programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "contact_delete_delay", 32)
|
|
modparam("ims_usrloc_scscf", "contact_delete_delay", 32)
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
<section id="ims_usrloc_scscf.p.support_wildcardPSI">
|
|
<section id="ims_usrloc_scscf.p.support_wildcardPSI">
|
|
@@ -303,8 +344,10 @@
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>unreg_validity</varname> parameter</title>
|
|
<title>Set <varname>unreg_validity</varname> parameter</title>
|
|
<programlisting format="linespecific">
|
|
<programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "unreg_validity", 0)
|
|
modparam("ims_usrloc_scscf", "unreg_validity", 0)
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
<section id="ims_usrloc_scscf.p.user_data_xsd">
|
|
<section id="ims_usrloc_scscf.p.user_data_xsd">
|
|
@@ -314,8 +357,10 @@
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>unreg_validity</varname> parameter</title>
|
|
<title>Set <varname>unreg_validity</varname> parameter</title>
|
|
<programlisting format="linespecific">
|
|
<programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "user_data_xsd", "/usr/local/etc/kamailio/CxDataType_Rel6.xsd")
|
|
modparam("ims_usrloc_scscf", "user_data_xsd", "/usr/local/etc/kamailio/CxDataType_Rel6.xsd")
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
@@ -326,8 +371,10 @@
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>realm</varname> parameter</title>
|
|
<title>Set <varname>realm</varname> parameter</title>
|
|
<programlisting format="linespecific">
|
|
<programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "realm", "kamailio-ims.org")
|
|
modparam("ims_usrloc_scscf", "realm", "kamailio-ims.org")
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
@@ -338,8 +385,10 @@
|
|
<example>
|
|
<example>
|
|
<title>Set <varname>skip_realm</varname> parameter</title>
|
|
<title>Set <varname>skip_realm</varname> parameter</title>
|
|
<programlisting format="linespecific">
|
|
<programlisting format="linespecific">
|
|
|
|
+...
|
|
modparam("ims_usrloc_scscf", "skip_realm", 1)
|
|
modparam("ims_usrloc_scscf", "skip_realm", 1)
|
|
- </programlisting>
|
|
|
|
|
|
+...
|
|
|
|
+</programlisting>
|
|
</example>
|
|
</example>
|
|
</section>
|
|
</section>
|
|
</section>
|
|
</section>
|