<!-- Kamailio Pull Request Template -->
<!--
IMPORTANT:
- for detailed contributing guidelines, read:
https://github.com/kamailio/kamailio/blob/master/.github/CONTRIBUTING.md
- pull requests must be done to master branch, unless they are backports
of fixes from master branch to a stable branch
- backports to stable branches must be done with 'git cherry-pick -x ...'
- code is contributed under BSD for core and main components (tm, sl, auth, tls)
- code is contributed GPLv2 or a compatible license for the other components
- GPL code is contributed with OpenSSL licensing exception
-->
#### Pre-Submission Checklist
<!-- Go over all points below, and after creating the PR, tick all the checkboxes that apply -->
<!-- All points should be verified, otherwise, read the CONTRIBUTING guidelines from above-->
<!-- If you're unsure about any of these, don't hesitate to ask on sr-dev mailing list -->
- [ ] Commit message has the format required by CONTRIBUTING guide
- [ ] Commits are split per component (core, individual modules, libs, utils, ...)
- [ ] Each component has a single commit (if not, squash them into one commit)
- [ ] No commits to README files for modules (changes must be done to docbook files
in `doc/` subfolder, the README file is autogenerated)
#### Type Of Change
- [ ] Small bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds new functionality)
- [ ] Breaking change (fix or feature that would change existing functionality)
#### Checklist:
<!-- Go over all points below, and after creating the PR, tick the checkboxes that apply -->
- [ ] PR should be backported to stable branches
- [ ] Tested changes locally
- [ ] Related to issue #XXXX (replace XXXX with an open issue number)
#### Description
<!-- Describe your changes in detail -->
You can view, comment on, or merge this pull request online at:
https://github.com/kamailio/kamailio/pull/3806
-- Commit Summary --
* pike: fix documentation for reqs_density_per_unit
-- File Changes --
M src/modules/pike/doc/pike_admin.xml (3)
-- Patch Links --
https://github.com/kamailio/kamailio/pull/3806.patchhttps://github.com/kamailio/kamailio/pull/3806.diff
--
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/pull/3806
You are receiving this because you are subscribed to this thread.
Message ID: <kamailio/kamailio/pull/3806(a)github.com>
Module: kamailio
Branch: master
Commit: dd30f8b905a80f85891df72a1f865c9ad1508c9a
URL: https://github.com/kamailio/kamailio/commit/dd30f8b905a80f85891df72a1f865c9…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2024-06-10T13:16:10+02:00
modules: readme files regenerated - dispatcher ... [skip ci]
---
Modified: src/modules/dispatcher/README
---
Diff: https://github.com/kamailio/kamailio/commit/dd30f8b905a80f85891df72a1f865c9…
Patch: https://github.com/kamailio/kamailio/commit/dd30f8b905a80f85891df72a1f865c9…
---
diff --git a/src/modules/dispatcher/README b/src/modules/dispatcher/README
index c095bc201be..1e99229575a 100644
--- a/src/modules/dispatcher/README
+++ b/src/modules/dispatcher/README
@@ -122,7 +122,7 @@ Federico Cabiddu
4.14. ds_load_unset()
4.15. ds_reload()
4.16. ds_dsg_fetch(setid)
- 4.17. ds_oc_set_rate(setid, uri, val)
+ 4.17. ds_oc_set_attrs(setid, uri, rval, tval)
5. RPC Commands
@@ -212,7 +212,7 @@ Federico Cabiddu
1.57. ds_load_unset usage
1.58. ds_reload usage
1.59. ds_dsg_fetch() usage
- 1.60. ds_oc_set_rate() usage
+ 1.60. ds_oc_set_attrs() usage
1.61. dispatcher list file
1.62. Kamailio config script - sample dispatcher usage
@@ -291,7 +291,7 @@ Chapter 1. Admin Guide
4.14. ds_load_unset()
4.15. ds_reload()
4.16. ds_dsg_fetch(setid)
- 4.17. ds_oc_set_rate(setid, uri, val)
+ 4.17. ds_oc_set_attrs(setid, uri, rval, tval)
5. RPC Commands
@@ -1118,7 +1118,7 @@ modparam("dispatcher", "ds_interval_mode", 7200)
4.14. ds_load_unset()
4.15. ds_reload()
4.16. ds_dsg_fetch(setid)
- 4.17. ds_oc_set_rate(setid, uri, val)
+ 4.17. ds_oc_set_attrs(setid, uri, rval, tval)
4.1. ds_select_dst(set, alg[, limit])
@@ -1636,22 +1636,26 @@ onreply_route {
xinfo("set id: 1 - all: $dsg(count); active: $dsg(active)\n");
...
-4.17. ds_oc_set_rate(setid, uri, val)
+4.17. ds_oc_set_attrs(setid, uri, rval, tval)
- Sets the overload control rate for the destination (setid, uri).
+ Sets the overload control rate and time internval limit for the
+ destination (setid, uri).
Description of parameters:
* setid - the set (group) id. The parameter can be an integer or a
variable holding an integer value.
* uri - the URI of the destination.
- * val - the value of the overload control rate (from 1 to 100) - how
+ * rval - the value of the overload control rate (from 1 to 100) - how
many times to skip using this destination in 100 selections.
+ * tval - time interval limit to apply the overload control rate (in
+ milliseconds). If the value is 0 or negative, then the default
+ value 500 is used.
This function can be used from ANY_ROUTE.
- Example 1.60. ds_oc_set_rate() usage
+ Example 1.60. ds_oc_set_attrs() usage
...
- ds_oc_set_rate("1", "sip:127.0.0.1:5080", "30");
+ ds_oc_set_attrs("1", "sip:127.0.0.1:5080", "30", "1000");
...
5. RPC Commands
Module: kamailio
Branch: master
Commit: 244fc84a971d3381e731dab558c19d96e0922f5f
URL: https://github.com/kamailio/kamailio/commit/244fc84a971d3381e731dab558c19d9…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2024-06-10T12:49:42+02:00
dispatcher: docs for ds_oc_set_attrs(...)
---
Modified: src/modules/dispatcher/doc/dispatcher_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/244fc84a971d3381e731dab558c19d9…
Patch: https://github.com/kamailio/kamailio/commit/244fc84a971d3381e731dab558c19d9…
---
diff --git a/src/modules/dispatcher/doc/dispatcher_admin.xml b/src/modules/dispatcher/doc/dispatcher_admin.xml
index e0e8d1beed8..62e212f8744 100644
--- a/src/modules/dispatcher/doc/dispatcher_admin.xml
+++ b/src/modules/dispatcher/doc/dispatcher_admin.xml
@@ -2014,12 +2014,13 @@ onreply_route {
</programlisting>
</example>
</section>
- <section id="dispatcher.f.ds_oc_set_rate">
+ <section id="dispatcher.f.ds_oc_set_attrs">
<title>
- <function moreinfo="none">ds_oc_set_rate(setid, uri, val)</function>
+ <function moreinfo="none">ds_oc_set_attrs(setid, uri, rval, tval)</function>
</title>
<para>
- Sets the overload control rate for the destination (setid, uri).
+ Sets the overload control rate and time internval limit
+ for the destination (setid, uri).
</para>
<para>Description of parameters:</para>
<itemizedlist>
@@ -2032,9 +2033,14 @@ onreply_route {
<para><emphasis>uri</emphasis> - the URI of the destination.</para>
</listitem>
<listitem>
- <para><emphasis>val</emphasis> - the value of the overload control
+ <para><emphasis>rval</emphasis> - the value of the overload control
rate (from 1 to 100) - how many times to skip using this destination
in 100 selections.</para>
+ </listitem>
+ <listitem>
+ <para><emphasis>tval</emphasis> - time interval limit to apply the
+ overload control rate (in milliseconds). If the value is 0 or
+ negative, then the default value 500 is used.</para>
</listitem>
</itemizedlist>
@@ -2042,10 +2048,10 @@ onreply_route {
This function can be used from ANY_ROUTE.
</para>
<example>
- <title><function>ds_oc_set_rate()</function> usage</title>
+ <title><function>ds_oc_set_attrs()</function> usage</title>
<programlisting format="linespecific">
...
- ds_oc_set_rate("1", "sip:127.0.0.1:5080", "30");
+ ds_oc_set_attrs("1", "sip:127.0.0.1:5080", "30", "1000");
...
</programlisting>
</example>