[sr-dev] git:master:bd2feeae: dispatcher: doc description for relative weight distribution added

[Savolainen Dmitri]

Module: kamailio
Branch: master
Commit: bd2feeae898dd9a40bc2209200e3426d85430500
URL: https://github.com/kamailio/kamailio/commit/bd2feeae898dd9a40bc2209200e3426d85430500

Author: Savolainen Dmitri <savolainen at erinaco.ru>
Committer: Savolainen Dmitri <savolainen at erinaco.ru>
Date: 2015-06-25T19:35:04+03:00

dispatcher: doc description for relative weight distribution added

---

Modified: modules/dispatcher/doc/dispatcher_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/bd2feeae898dd9a40bc2209200e3426d85430500.diff
Patch: https://github.com/kamailio/kamailio/commit/bd2feeae898dd9a40bc2209200e3426d85430500.patch

---

diff --git a/modules/dispatcher/doc/dispatcher_admin.xml b/modules/dispatcher/doc/dispatcher_admin.xml
index ae700ab..b9a0c01 100644
--- a/modules/dispatcher/doc/dispatcher_admin.xml
+++ b/modules/dispatcher/doc/dispatcher_admin.xml
@@ -917,6 +917,24 @@ modparam("dispatcher", "force_dst", 1)
 			</listitem>
 			<listitem>
 				<para>
+				<quote>11</quote> - use relative weight based load distribution.
+				You have to set the attribute 'rweight' per each address in
+				destination set. Active host usage probability is 
+				rweight/(SUM of all active host rweights in destination group). 
+				</para>
+				<para>
+				The major difference from the weight distribution is the
+				probability recalculation according to rweight value in case of 
+				host enabling/disabling
+				</para>
+				<para>
+				For example, 100 calls in 3-hosts group with rweight params 1/2/1  
+				will be distributed as 25/50/25. After third host failing 
+				distribution will be changed to 33/67/0.
+				</para>
+			</listitem>
+			<listitem>
+				<para>
 				<quote>X</quote> - if the algorithm is not implemented, the
 				first entry in set is chosen.
 				</para>
@@ -1450,6 +1468,12 @@ onreply_route {
 					sent to that gateways.
 				</listitem>
 				<listitem>
+					'rweight' - used for relative weight based load 
+					distribution. It must be set to a positive integer value 
+					between 1 and 100 (otherwise host will be excluded from 
+					relative weight distribution type). 
+				</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.