[sr-dev] git:master:be1e23de: dispatcher: documentation for dispatcher.hash rpc command

Module: kamailio Branch: master Commit: be1e23defc8c56dc0a1398b009019626f5ea0e0f URL: https://github.com/kamailio/kamailio/commit/be1e23defc8c56dc0a1398b00901962… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2020-05-20T21:48:29+02:00 dispatcher: documentation for dispatcher.hash rpc command --- Modified: src/modules/dispatcher/doc/dispatcher_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/be1e23defc8c56dc0a1398b00901962… Patch: https://github.com/kamailio/kamailio/commit/be1e23defc8c56dc0a1398b00901962… --- diff --git a/src/modules/dispatcher/doc/dispatcher_admin.xml b/src/modules/dispatcher/doc/dispatcher_admin.xml index 30cd6a5ec1..a255b2645d 100644 --- a/src/modules/dispatcher/doc/dispatcher_admin.xml +++ b/src/modules/dispatcher/doc/dispatcher_admin.xml @@ -1960,6 +1960,46 @@ DEST: { &sercmd; dispatcher.remove 2 sip:127.0.0.1:5080 &sercmd; dispatcher.remove 3 sip:127.0.0.1:5075;transport=udp ... +</programlisting> + </section> + <section id="dispatcher.r.hash"> + <title> + <function moreinfo="none">dispatcher.hash</function> + </title> + <para> + Compute the hash id corresponding to the string parameter values. + </para> + <para> + Return the hash id and the corresponding slot, if 'nslots' parameter + is not 0. + </para> + <para> + Name: <emphasis>dispatcher.hash</emphasis> + </para> + <para>Parameters:</para> + <itemizedlist> + <listitem><para>_nslots_: number of slots</para></listitem> + <listitem><para>_val1_: string value</para></listitem> + <listitem><para>_val2_: (optional) string value</para></listitem> + </itemizedlist> + <para> + It can be useful to find what address in a destination group (setid) is + going to be used when hashing a value or a URI. For a URI, the + corresponding username and domain have to be provided as _val1_ and + _val2_. If the URI has a port different than 5060 (or 5061 for TLS), + then the _val2_ has to be 'domain:port'. The _nslots_ has to be the + number of addresses in the group (setid). The returned 'slot' value + represents the index of the address to be used for routing. + </para> + <para> + Example: + </para> +<programlisting format="linespecific"> +... +# prototype: &kamctl; rpc dispatcher.hash _nslots_ _val1_ [_val2_] +&kamctl; rpc dispatcher.hash 0 alice server.com +&kamctl; rpc dispatcher.hash 4 bob server.com +... </programlisting> </section>