Module: kamailio
Branch: 4.2
Commit: 9bb59f922da4474e3b30e7f47cf841c9e40c3ffd
URL: https://github.com/kamailio/kamailio/commit/9bb59f922da4474e3b30e7f47cf841c…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2014-12-18T00:52:48+01:00
dispatcher: readme file updated
---
Modified: modules/dispatcher/README
---
Diff: https://github.com/kamailio/kamailio/commit/9bb59f922da4474e3b30e7f47cf841c…
Patch: https://github.com/kamailio/kamailio/commit/9bb59f922da4474e3b30e7f47cf841c…
---
diff --git a/modules/dispatcher/README b/modules/dispatcher/README
index 1987823..8f2c96a 100644
--- a/modules/dispatcher/README
+++ b/modules/dispatcher/README
@@ -91,6 +91,10 @@ Carsten Bock
7. Installation and Running
7.1. Destination List File
+
+ 7.1.1. Special Attributes
+ 7.1.2. File Format
+
7.2. Kamailio config file
8. Event routes
@@ -207,6 +211,10 @@ Chapter 1. Admin Guide
7. Installation and Running
7.1. Destination List File
+
+ 7.1.1. Special Attributes
+ 7.1.2. File Format
+
7.2. Kamailio config file
8. Event routes
@@ -1039,6 +1047,10 @@ kamcmd dispatcher.set_state ip 2 sip:127.0.0.1:5080
7. Installation and Running
7.1. Destination List File
+
+ 7.1.1. Special Attributes
+ 7.1.2. File Format
+
7.2. Kamailio config file
7.1. Destination List File
@@ -1056,9 +1068,29 @@ kamcmd dispatcher.set_state ip 2 sip:127.0.0.1:5080
probing destination (sending keep alives);
* priority: sets the priority in destination list (based on it is
done the initial ordering inside the set)
- * attributes: extra filed in form of name1=value1;...;nameN=valueN.
- There are some predefined names that are used of weight and call
- load dispatching.
+ * attributes: extra fields in form of name1=value1;...;nameN=valueN.
+ There are some reserved names for attributes used by the module for
+ specific load balancing algorithms, see the section 'Special
+ Attributes'.
+
+7.1.1. Special Attributes
+
+ There are some predefined names:
+ * 'duid' - used for call load dispatching. It must be an unique value
+ to identify a destination (gateway address). Practically the load
+ within the group is associated with this value.
+ * 'maxload' - used for call load dispatching. It must be a positive
+ integer, defining the upper limit of active calls per destination.
+ When the limit is reached, then the gateway is no longer selected
+ for new calls until an exiting call via that gateway is terminated.
+ If set to 0, then no active call limit is used.
+ * 'weight' - used for weight based load distribution. It must be set
+ to a positive integer value beteen 0 and 100. The value represents
+ the percent of calls to be sent to that gateways.
+ * 'socket' - used to set the sending socket for the gateway. It is
+ used for sending the SIP traffic as well as OPTIONS keepalives.
+
+7.1.2. File Format
Line format is:
...
Module: kamailio
Branch: 4.2
Commit: 3cb767da8e049da87fd4e4c8dd824a59cd10b971
URL: https://github.com/kamailio/kamailio/commit/3cb767da8e049da87fd4e4c8dd824a5…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2014-12-18T00:52:11+01:00
dispatcher: dedicated section for attributes in docs
- file format has it own section too
(cherry picked from commit 610a93ea038f9eb10ac611263891813b734fc7a0)
Conflicts:
modules/dispatcher/doc/dispatcher_admin.xml
---
Modified: modules/dispatcher/doc/dispatcher_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/3cb767da8e049da87fd4e4c8dd824a5…
Patch: https://github.com/kamailio/kamailio/commit/3cb767da8e049da87fd4e4c8dd824a5…
---
diff --git a/modules/dispatcher/doc/dispatcher_admin.xml b/modules/dispatcher/doc/dispatcher_admin.xml
index f4e0eaf..0159189 100644
--- a/modules/dispatcher/doc/dispatcher_admin.xml
+++ b/modules/dispatcher/doc/dispatcher_admin.xml
@@ -1321,11 +1321,48 @@ onreply_route {
is done the initial ordering inside the set)</para>
</listitem>
<listitem>
- <para>attributes: extra filed in form of
- name1=value1;...;nameN=valueN. There are some predefined names
- that are used of weight and call load dispatching.</para>
+ <para>attributes: extra fields in form of
+ name1=value1;...;nameN=valueN. There are some reserved names
+ for attributes used by the module for specific load balancing
+ algorithms, see the section 'Special Attributes'.
+ </para>
</listitem>
</itemizedlist>
+ <section id="dispatcher.ex.attributes">
+ <title>Special Attributes</title>
+ <para>
+ There are some predefined names:
+ <itemizedlist>
+ <listitem>
+ 'duid' - used for call load dispatching. It must be an
+ unique value to identify a destination (gateway address).
+ Practically the load within the group is associated with
+ this value.
+ </listitem>
+ <listitem>
+ 'maxload' - used for call load dispatching. It must be
+ a positive integer, defining the upper limit of active
+ calls per destination. When the limit is reached, then
+ the gateway is no longer selected for new calls until
+ an exiting call via that gateway is terminated. If set
+ to 0, then no active call limit is used.
+ </listitem>
+ <listitem>
+ 'weight' - used for weight based load distribution. It
+ must be set to a positive integer value beteen 0 and
+ 100. The value represents the percent of calls to be
+ sent to that gateways.
+ </listitem>
+ <listitem>
+ 'socket' - used to set the sending socket for the gateway.
+ It is used for sending the SIP traffic as well as
+ OPTIONS keepalives.
+ </listitem>
+ </itemizedlist>
+ </para>
+ </section>
+ <section id="dispatcher.ex.fileforma">
+ <title>File Format</title>
<para>
Line format is:
</para>
@@ -1357,6 +1394,7 @@ setid(int) destination(sip uri) flags(int,opt) priority(int,opt) attrs(str,opt)
</programlisting>
</example>
</section>
+ </section>
<section id="dispatcher.ex.config">
<title>&kamailio; config file</title>
Module: kamailio
Branch: master
Commit: 7bf4c6d72774b521b4e9bbc5375c4e952a224676
URL: https://github.com/kamailio/kamailio/commit/7bf4c6d72774b521b4e9bbc5375c4e9…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2014-12-17T23:34:21+01:00
auth_db: more details for is_subscriber()
---
Modified: modules/auth_db/README
Modified: modules/auth_db/doc/auth_db_admin.xml
---
Diff: https://github.com/kamailio/kamailio/commit/7bf4c6d72774b521b4e9bbc5375c4e9…
Patch: https://github.com/kamailio/kamailio/commit/7bf4c6d72774b521b4e9bbc5375c4e9…
---
diff --git a/modules/auth_db/README b/modules/auth_db/README
index 9e25b08..949878d 100644
--- a/modules/auth_db/README
+++ b/modules/auth_db/README
@@ -463,15 +463,17 @@ if (!auth_check("$fd", "subscriber", "1")) {
(usually subscriber table). The string may contain pseudo
variables.
* flags - set of flags to control the behaviour of the function. If
- it is 1, then the function will use the domain part of the URI to
- perform the database table search.
+ 1st bit is set, then the function will use the domain part of the
+ URI to perform the database table search. If 2nd bit is set, then
+ the credentials are not loaded in variables (a simple check if
+ subscriber exists).
The parameter may be a pseudo variable.
This function can be used from ANY_ROUTE.
Example 1.13. is_subscriber usage
...
-if (!is_subscriber("$ru", "subscriber", "1")) {
+if (!is_subscriber("$ru", "subscriber", "3")) {
# callee is not a local subscriber
...
}
diff --git a/modules/auth_db/doc/auth_db_admin.xml b/modules/auth_db/doc/auth_db_admin.xml
index 74d6d00..1b83296 100644
--- a/modules/auth_db/doc/auth_db_admin.xml
+++ b/modules/auth_db/doc/auth_db_admin.xml
@@ -585,8 +585,10 @@ if (!auth_check("$fd", "subscriber", "1")) {
</listitem>
<listitem>
<para><emphasis>flags</emphasis> - set of flags to control the
- behaviour of the function. If it is 1, then the function will
+ behaviour of the function. If 1st bit is set, then the function will
use the domain part of the URI to perform the database table search.
+ If 2nd bit is set, then the credentials are not loaded in variables
+ (a simple check if subscriber exists).
</para>
<para>
The parameter may be a pseudo variable.
@@ -600,7 +602,7 @@ if (!auth_check("$fd", "subscriber", "1")) {
<title>is_subscriber usage</title>
<programlisting format="linespecific">
...
-if (!is_subscriber("$ru", "subscriber", "1")) {
+if (!is_subscriber("$ru", "subscriber", "3")) {
# callee is not a local subscriber
...
}
Hello,
on Wednesday (Dec 17) late afternoon in Europe (probably starting around
18:00, Berlin time), we plan some maintenance work on kamailio.org
server. Hopefully the downtime will be short and barely noticeable. But
as we know, sometime we have to expect the unexpected, therefore in case
the server is unavailable a bit longer, keep in mind that it is a
scheduled work.
Cheers,
Daniel
--
Daniel-Constantin Mierla
http://twitter.com/#!/miconda - http://www.linkedin.com/in/miconda