[sr-dev] git:master:cd8f551f: dispatcher: docs for ds_oc_set_rate(...) function

Module: kamailio Branch: master Commit: cd8f551f40c6d3a3c30d7bb9d96e601c0c3087ae URL: https://github.com/kamailio/kamailio/commit/cd8f551f40c6d3a3c30d7bb9d96e601… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: 2024-06-07T12:18:21+02:00 dispatcher: docs for ds_oc_set_rate(...) function --- Modified: src/modules/dispatcher/doc/dispatcher_admin.xml --- Diff: https://github.com/kamailio/kamailio/commit/cd8f551f40c6d3a3c30d7bb9d96e601… Patch: https://github.com/kamailio/kamailio/commit/cd8f551f40c6d3a3c30d7bb9d96e601… --- diff --git a/src/modules/dispatcher/doc/dispatcher_admin.xml b/src/modules/dispatcher/doc/dispatcher_admin.xml index 979b59798af..cdd1ebc896e 100644 --- a/src/modules/dispatcher/doc/dispatcher_admin.xml +++ b/src/modules/dispatcher/doc/dispatcher_admin.xml @@ -2011,6 +2011,42 @@ onreply_route { ds_dsg_fetch("1"); xinfo("set id: 1 - all: $dsg(count); active: $dsg(active)\n"); ... +</programlisting> + </example> + </section> + <section id="dispatcher.f.ds_oc_set_rate"> + <title> + <function moreinfo="none">ds_oc_set_rate(setid, uri, val)</function> + </title> + <para> + Sets the overload control rate for the destination (setid, uri). + </para> + <para>Description of parameters:</para> + <itemizedlist> + <listitem> + <para><emphasis>setid</emphasis> - the set (group) id. The parameter + can be an integer or a variable holding an integer value. + </para> + </listitem> + <listitem> + <para><emphasis>uri</emphasis> - the URI of the destination.</para> + </listitem> + <listitem> + <para><emphasis>val</emphasis> - the valie of the overload control + rate (from 1 to 100) - how many times to skip using this destination + in 100 selections.</para> + </listitem> + </itemizedlist> + + <para> + This function can be used from ANY_ROUTE. + </para> + <example> + <title><function>ds_oc_set_rate()</function> usage</title> + <programlisting format="linespecific"> +... + ds_oc_set_rate("1", "sip:127.0.0.1:5080", "30"); +... </programlisting> </example> </section>