diff --git a/modules/dispatcher/doc/dispatcher_admin.xml b/modules/dispatcher/doc/dispatcher_admin.xml index b5908c32c51..c9dffffe38f 100644 --- a/modules/dispatcher/doc/dispatcher_admin.xml +++ b/modules/dispatcher/doc/dispatcher_admin.xml @@ -10,7 +10,7 @@ - + &adminguide;
@@ -29,7 +29,7 @@ It is very lightweight, therefore suitable for handling heavy SIP - traffic. As the module has a small footprint and the ability to load + traffic. As the module has a small footprint and the ability to load balancing rules from a plain text file, it is suitable for embedded systems.
@@ -537,11 +537,11 @@ modparam("dispatcher", "force_dst", 1) ... - +
<varname>ds_ping_from</varname> (string) - With this Method you can define the "From:"-Line for the request, sent to the failed gateways. + With this Method you can define the "From:"-Line for the request, sent to the failed gateways. This method is only available, if compiled with the probing of failed gateways enabled. @@ -557,7 +557,7 @@ modparam("dispatcher", "force_dst", 1) ... -
+
<varname>ds_ping_interval</varname> (int) @@ -580,8 +580,8 @@ modparam("dispatcher", "force_dst", 1) ... -
- + +
<varname>ds_probing_threshold</varname> (int) @@ -640,7 +640,7 @@ modparam("dispatcher", "force_dst", 1) PING-Method are not only the ones generated from the remote servers, but also those that are generated locally. E.g.: setting code=408 or class=400 will never set a backend down even if it is, because internally the Kamailio transaction layer - generates a 408 in the case of no response from the remote server, and this + generates a 408 in the case of no response from the remote server, and this internal code 408 is accepted as valid value. @@ -656,11 +656,11 @@ modparam("dispatcher", "force_dst", 1) ... -
+
<varname>ds_probing_mode</varname> (int) - Controls what gateways are tested to see if they are reachable. + Controls what gateways are tested to see if they are reachable. @@ -827,7 +827,7 @@ modparam("dispatcher", "force_dst", 1) <varname>ds_timer_mode</varname> (int) Specify the timer process to be used by the module for - keepalives and active dialogs tracking. + keepalives and active dialogs tracking. It can be set to: @@ -984,17 +984,17 @@ modparam("dispatcher", "force_dst", 1) 11 - 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). + destination set. Active host usage probability is + rweight/(SUM of all active host rweights in destination group). The major difference from the weight distribution is the - probability recalculation according to rweight value in case of + probability recalculation according to rweight value in case of host enabling/disabling - 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 + 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. @@ -1314,7 +1314,7 @@ onreply_route { ds_set_state - Sets the status for a destination address (can be use to mark the destination + Sets the status for a destination address (can be use to mark the destination as active or inactive). @@ -1325,17 +1325,17 @@ onreply_route { _state_ : state of the destination address a: active - i: inactive - t: trying - d: disabled + i: inactive + t: trying + d: disabled The states a, i or t can be followed by p to set probing mode (e.g. 'ap', 'ip' or 'tp'). - + _group_: destination group id - + _address_: address of the destination in the _group_ @@ -1568,10 +1568,10 @@ onreply_route { sent to that gateways. - '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). + '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). 'socket' - used to set the sending socket for the gateway. @@ -1615,11 +1615,11 @@ setid(int) destination(sip uri) flags(int,opt) priority(int,opt) attrs(str,opt)
- +
&kamailio; config file - Next picture shows a sample usage of the dispatcher module. + Next listing shows a sample config for using the dispatcher module. &kamailio; config script - sample dispatcher usage