Module: kamailio
Branch: master
Commit: 4d045438c4451cfc70e995344a2cfb42eb0ccb30
URL: https://github.com/kamailio/kamailio/commit/4d045438c4451cfc70e995344a2cfb4…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2019-12-19T18:31:12+01:00
modules: readme files regenerated - cnxcc ... [skip ci]
---
Modified: src/modules/cnxcc/README
---
Diff: https://github.com/kamailio/kamailio/commit/4d045438c4451cfc70e995344a2cfb4…
Patch: https://github.com/kamailio/kamailio/commit/4d045438c4451cfc70e995344a2cfb4…
---
diff --git a/src/modules/cnxcc/README b/src/modules/cnxcc/README
index d2e317de72..425a473f16 100644
--- a/src/modules/cnxcc/README
+++ b/src/modules/cnxcc/README
@@ -188,18 +188,32 @@ modparam("cnxcc", "credit_check_period", 1)
Associates the call with a customer id and sets the max credit, connect
cost, cost per second, initial pulse and final pulse. The discount is
- calculated in pulses (30/6, 1/1, etc) and subtracted from the pool of
+ calculated in pulses (1/1, 60/1, etc) and subtracted from the pool of
credit.
The customer value can be provided as a string or a variable holding a
- string.
+ string. This value identifies all calls from the same customer.
+
+ The maxcredit (float) value is the maximum credit available for the
+ current call.
+
+ The connect (float) value is the connect cost for the current call.
+
+ The cps (float) value is the cost per second for the current call.
+
+ The ipuse (integer) value is the initial pulse and establishes the
+ minimum time to be charged. For example, value 1 establishes a charge
+ per second and value 60 sets a charge per minute. If it is taken as
+ value 60, even if the duration is 5 seconds, 1 minute will be charged.
- The maxcredit, connect and cps can be double (float) or integer values,
- they have to be provided as static string values of variables holding
- string values.
+ The fpulse (integer) value is the final pulse and establishes, from the
+ initial pulse, the time range to be charged. For example, the value 1
+ establishes a charge per second, 5 sets a charge in blocks of 5
+ seconds, 60 sets a full minute charge.
- The ipulse and fpulse values are integer values, they can be also given
- via variables holding integers.
+ 1/1 will make a charge per seconds for the entire call. 60/1 will make
+ a charge per seconds with the first full minute. 60/60 always perform a
+ full minute charge.
Return code:
* 1 - successful
@@ -210,12 +224,15 @@ modparam("cnxcc", "credit_check_period", 1)
...
cnxcc_set_max_credit("john-doe", "100", "3.0", "0.5", 60, 1);
...
-$var(customer) = "john-doe-premium"; # customer id
-$var(credit) = "100"; # max credit
-$var(connect) = "3.0"; # connect const
-$var(cps) = "0.5"; # cost per second
-$var(initial_p) = 60; # initial pulse
-$var(final_p) = 1; # final pulse
+$var(customer) = "john-doe"; # customer id
+$var(credit) = "100"; # max credit for all calls with the same
+ # customer id
+$var(connect) = "3.0"; # connect cost or initial cost for the call
+$var(cps) = "0.5"; # cost per second
+$var(initial_p) = 60; # initial pulse (60 = the first minute will be
+ # charged even if the call is shorter)
+$var(final_p) = 1; # final pulse (after the first minute, it will
+ # be charge in ranges of 1 second)
cnxcc_set_max_credit("$var(customer)", "$var(credit)", "$var(connect)",
"$var(cps)", "$var(initial_p)", "$var(final_p)");
...
<!-- 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/2182
-- Commit Summary --
* cnxcc: updated readme file [skip ci]
-- File Changes --
M src/modules/cnxcc/doc/cnxcc_admin.xml (45)
-- Patch Links --
https://github.com/kamailio/kamailio/pull/2182.patchhttps://github.com/kamailio/kamailio/pull/2182.diff
--
You are receiving this because you are subscribed to this thread.
Reply to this email directly or view it on GitHub:
https://github.com/kamailio/kamailio/pull/2182
Module: kamailio
Branch: master
Commit: cea7fa14b0aefc647d28eb1bf56faaec89d90d67
URL: https://github.com/kamailio/kamailio/commit/cea7fa14b0aefc647d28eb1bf56faae…
Author: Jose Luis Verdeguer <pepeluxx(a)gmail.com>
Committer: Jose Luis Verdeguer <pepeluxx(a)gmail.com>
Date: 2019-12-19T18:22:59+01:00
cnxcc: updated readme file [skip ci]
---
Modified: src/modules/cnxcc/doc/cnxcc_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/cea7fa14b0aefc647d28eb1bf56faae…
Patch: https://github.com/kamailio/kamailio/commit/cea7fa14b0aefc647d28eb1bf56faae…
---
diff --git a/src/modules/cnxcc/doc/cnxcc_admin.xml b/src/modules/cnxcc/doc/cnxcc_admin.xml
index 4284437a8b..0c26cb0a58 100644
--- a/src/modules/cnxcc/doc/cnxcc_admin.xml
+++ b/src/modules/cnxcc/doc/cnxcc_admin.xml
@@ -128,21 +128,37 @@ modparam("cnxcc", "credit_check_period", 1)
<para>
Associates the call with a customer id and sets the max credit,
connect cost, cost per second, initial pulse and final pulse. The discount
- is calculated in pulses (30/6, 1/1, etc) and subtracted from the pool
+ is calculated in pulses (1/1, 60/1, etc) and subtracted from the pool
of credit.
</para>
<para>
The customer value can be provided as a string or a variable holding
- a string.
+ a string. This value identifies all calls from the same customer.
+ </para>
+ <para>
+ The maxcredit (float) value is the maximum credit available for the current call.
+ </para>
+ <para>
+ The connect (float) value is the connect cost for the current call.
+ </para>
+ <para>
+ The cps (float) value is the cost per second for the current call.
+ </para>
+ <para>
+ The ipuse (integer) value is the initial pulse and establishes the minimum
+ time to be charged. For example, value 1 establishes a charge per second
+ and value 60 sets a charge per minute. If it is taken as value 60, even
+ if the duration is 5 seconds, 1 minute will be charged.
</para>
<para>
- The maxcredit, connect and cps can be double (float) or integer values, they
- have to be provided as static string values of variables holding string
- values.
+ The fpulse (integer) value is the final pulse and establishes, from the initial
+ pulse, the time range to be charged. For example, the value 1 establishes a charge
+ per second, 5 sets a charge in blocks of 5 seconds, 60 sets a full minute charge.
</para>
<para>
- The ipulse and fpulse values are integer values, they can be also
- given via variables holding integers.
+ 1/1 will make a charge per seconds for the entire call. 60/1 will make a
+ charge per seconds with the first full minute. 60/60 always perform
+ a full minute charge.
</para>
<para>
<emphasis>Return code:</emphasis>
@@ -173,12 +189,15 @@ modparam("cnxcc", "credit_check_period", 1)
...
cnxcc_set_max_credit("john-doe", "100", "3.0", "0.5", 60, 1);
...
-$var(customer) = "john-doe-premium"; # customer id
-$var(credit) = "100"; # max credit
-$var(connect) = "3.0"; # connect const
-$var(cps) = "0.5"; # cost per second
-$var(initial_p) = 60; # initial pulse
-$var(final_p) = 1; # final pulse
+$var(customer) = "john-doe"; # customer id
+$var(credit) = "100"; # max credit for all calls with the same
+ # customer id
+$var(connect) = "3.0"; # connect cost or initial cost for the call
+$var(cps) = "0.5"; # cost per second
+$var(initial_p) = 60; # initial pulse (60 = the first minute will be
+ # charged even if the call is shorter)
+$var(final_p) = 1; # final pulse (after the first minute, it will
+ # be charge in ranges of 1 second)
cnxcc_set_max_credit("$var(customer)", "$var(credit)", "$var(connect)",
"$var(cps)", "$var(initial_p)", "$var(final_p)");
...
Module: kamailio
Branch: 5.2
Commit: 9d8be519bb0cc97a20360652085da6aaed94e86e
URL: https://github.com/kamailio/kamailio/commit/9d8be519bb0cc97a20360652085da6a…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2019-12-19T17:46:43+01:00
modules: readme files regenerated - modules ... [skip ci]
---
Modified: src/modules/dispatcher/README
---
Diff: https://github.com/kamailio/kamailio/commit/9d8be519bb0cc97a20360652085da6a…
Patch: https://github.com/kamailio/kamailio/commit/9d8be519bb0cc97a20360652085da6a…
---
diff --git a/src/modules/dispatcher/README b/src/modules/dispatcher/README
index 446055571c..ace384e35f 100644
--- a/src/modules/dispatcher/README
+++ b/src/modules/dispatcher/README
@@ -698,7 +698,7 @@ Note
set to TRYING state. This means that probing will be executed all
the time, but you can skip some servers with flag 4 in destination
list file, for example.
- * Value 2: if set to 2, only gateways in inactive state with probing
+ * Value 2: if set to 2, only gateways in INACTIVE state with PROBING
mode set are tested.
* Value 3: If set to 3, any gateway with state PROBING is continually
probed without modifying/removing the PROBING state. This allows
Module: kamailio
Branch: 5.3
Commit: 7fa917eef3c1940bb9a178b5e538fd9931dd431c
URL: https://github.com/kamailio/kamailio/commit/7fa917eef3c1940bb9a178b5e538fd9…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2019-12-19T17:46:29+01:00
modules: readme files regenerated - modules ... [skip ci]
---
Modified: src/modules/dispatcher/README
---
Diff: https://github.com/kamailio/kamailio/commit/7fa917eef3c1940bb9a178b5e538fd9…
Patch: https://github.com/kamailio/kamailio/commit/7fa917eef3c1940bb9a178b5e538fd9…
---
diff --git a/src/modules/dispatcher/README b/src/modules/dispatcher/README
index 4f6f3c6b83..fee1d2f27a 100644
--- a/src/modules/dispatcher/README
+++ b/src/modules/dispatcher/README
@@ -710,7 +710,7 @@ Note
set to TRYING state. This means that probing will be executed all
the time, but you can skip some servers with flag 4 in destination
list file, for example.
- * Value 2: if set to 2, only gateways in inactive state with probing
+ * Value 2: if set to 2, only gateways in INACTIVE state with PROBING
mode set are tested.
* Value 3: If set to 3, any gateway with state PROBING is continually
probed without modifying/removing the PROBING state. This allows
Module: kamailio
Branch: master
Commit: 42bad429680d4dbf1201394de1a5579573bcac74
URL: https://github.com/kamailio/kamailio/commit/42bad429680d4dbf1201394de1a5579…
Author: Kamailio Dev <kamailio.dev(a)kamailio.org>
Committer: Kamailio Dev <kamailio.dev(a)kamailio.org>
Date: 2019-12-19T17:46:13+01:00
modules: readme files regenerated - dispatcher ... [skip ci]
---
Modified: src/modules/dispatcher/README
---
Diff: https://github.com/kamailio/kamailio/commit/42bad429680d4dbf1201394de1a5579…
Patch: https://github.com/kamailio/kamailio/commit/42bad429680d4dbf1201394de1a5579…
---
diff --git a/src/modules/dispatcher/README b/src/modules/dispatcher/README
index 7408b51713..bdb27f57c7 100644
--- a/src/modules/dispatcher/README
+++ b/src/modules/dispatcher/README
@@ -714,7 +714,7 @@ Note
set to TRYING state. This means that probing will be executed all
the time, but you can skip some servers with flag 4 in destination
list file, for example.
- * Value 2: if set to 2, only gateways in inactive state with probing
+ * Value 2: if set to 2, only gateways in INACTIVE state with PROBING
mode set are tested.
* Value 3: If set to 3, any gateway with state PROBING is continually
probed without modifying/removing the PROBING state. This allows
Module: kamailio
Branch: 5.3
Commit: e57e8e9e9301982078005ca5fdd9ad9c6310de64
URL: https://github.com/kamailio/kamailio/commit/e57e8e9e9301982078005ca5fdd9ad9…
Author: Henning Westerholt <hw(a)skalatan.de>
Committer: Henning Westerholt <hw(a)skalatan.de>
Date: 2019-12-19T17:44:25+01:00
dispatcher: small style fix in ds_probing_mode docs
(cherry picked from commit faccbb1cf62bfb625d0bcc9d1a52727dcdd962ff)
---
Modified: src/modules/dispatcher/doc/dispatcher_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/e57e8e9e9301982078005ca5fdd9ad9…
Patch: https://github.com/kamailio/kamailio/commit/e57e8e9e9301982078005ca5fdd9ad9…
---
diff --git a/src/modules/dispatcher/doc/dispatcher_admin.xml b/src/modules/dispatcher/doc/dispatcher_admin.xml
index 75d26de330..f1cf9b7214 100644
--- a/src/modules/dispatcher/doc/dispatcher_admin.xml
+++ b/src/modules/dispatcher/doc/dispatcher_admin.xml
@@ -644,8 +644,8 @@ modparam("dispatcher", "force_dst", 1)
but you can skip some servers with flag 4 in destination list file, for example.</para>
</listitem>
<listitem>
- <para>Value 2: if set to 2, only gateways in inactive state with
- probing mode set are tested.</para>
+ <para>Value 2: if set to 2, only gateways in INACTIVE state with
+ PROBING mode set are tested.</para>
</listitem>
<listitem>
<para>Value 3: If set to 3, any gateway with state PROBING is continually probed
Module: kamailio
Branch: 5.2
Commit: fdd8bd3cce007e6256be5373d84413ffdeff802e
URL: https://github.com/kamailio/kamailio/commit/fdd8bd3cce007e6256be5373d84413f…
Author: Henning Westerholt <hw(a)skalatan.de>
Committer: Henning Westerholt <hw(a)skalatan.de>
Date: 2019-12-19T17:43:48+01:00
dispatcher: small style fix in ds_probing_mode docs
(cherry picked from commit faccbb1cf62bfb625d0bcc9d1a52727dcdd962ff)
---
Modified: src/modules/dispatcher/doc/dispatcher_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/fdd8bd3cce007e6256be5373d84413f…
Patch: https://github.com/kamailio/kamailio/commit/fdd8bd3cce007e6256be5373d84413f…
---
diff --git a/src/modules/dispatcher/doc/dispatcher_admin.xml b/src/modules/dispatcher/doc/dispatcher_admin.xml
index bcfa4a95c9..ed8b1808ad 100644
--- a/src/modules/dispatcher/doc/dispatcher_admin.xml
+++ b/src/modules/dispatcher/doc/dispatcher_admin.xml
@@ -644,8 +644,8 @@ modparam("dispatcher", "force_dst", 1)
but you can skip some servers with flag 4 in destination list file, for example.</para>
</listitem>
<listitem>
- <para>Value 2: if set to 2, only gateways in inactive state with
- probing mode set are tested.</para>
+ <para>Value 2: if set to 2, only gateways in INACTIVE state with
+ PROBING mode set are tested.</para>
</listitem>
<listitem>
<para>Value 3: If set to 3, any gateway with state PROBING is continually probed