[sr-dev] git:master:7db5d4c4: dialog: docs - documentation for h_id_start and h_id_step parameters

Module: kamailio Branch: master Commit: 7db5d4c4efb2131a7393e638f109ddbe746ffeff URL: https://github.com/kamailio/kamailio/commit/7db5d4c4efb2131a7393e638f109ddb… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2018-04-04T18:37:28+02:00 dialog: docs - documentation for h_id_start and h_id_step parameters - related to GH #1274 --- Modified: src/modules/dialog/doc/dialog_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/7db5d4c4efb2131a7393e638f109ddb… Patch: https://github.com/kamailio/kamailio/commit/7db5d4c4efb2131a7393e638f109ddb… --- diff --git a/src/modules/dialog/doc/dialog_admin.xml b/src/modules/dialog/doc/dialog_admin.xml index 3a5a348abc..d231d9a2f6 100644 --- a/src/modules/dialog/doc/dialog_admin.xml +++ b/src/modules/dialog/doc/dialog_admin.xml @@ -1520,6 +1520,60 @@ end </example> </section> + <section id="dialog.p.h_id_start"> + <title><varname>h_id_start</varname> (int)</title> + <para> + Set the offset to be used for generating dialog internal hash id. + If set to -1, the h_id_start is set to the value of the server_id + global parameter. + </para> + <para> + <emphasis> + Default value is <quote>0</quote>. + </emphasis> + </para> + <example> + <title>Set <varname>h_id_start</varname> parameter</title> + <programlisting format="linespecific"> +... +modparam("dialog", "h_id_start", 5) +... +</programlisting> + </example> + </section> + + <section id="dialog.p.h_id_step"> + <title><varname>h_id_step</varname> (int)</title> + <para> + Set the step to increment the dialog internal hash id. + </para> + <para> + If the value is greater than 1, the internal hash id is generated + with the rule: h_id_start + N * h_id_step. The first value of N is + randomly selected at startup, then incremented by 1 for each new + dialog. Setting h_id_start and h_id_step to non-default values + should be done when using dlg_db_load_callid(...) to load dialog + records generated by another &kamailio; instance, making also sure + that those &kamailio; instances are not going to generate + overalapping dialog hash id values by using different h_id_start + and the same h_id_step (h_id_step has to be greater than the + maximum value of h_id_start). + </para> + <para> + <emphasis> + Default value is <quote>1</quote>. + </emphasis> + </para> + <example> + <title>Set <varname>h_id_step</varname> parameter</title> + <programlisting format="linespecific"> +... +modparam("dialog", "h_id_step", 10) +... +</programlisting> + </example> + </section> + </section>