Browse code

dispatcher: update for module docs (#1804)

- update for module docs (#1804)
- Some minor comments for dispatcher module were added
- Additionally a description were added, what the several states means when dispatcher list are executed

Jurijs I authored on 10/01/2019 20:49:58
Showing 1 changed files
... ...
@@ -631,12 +631,16 @@ modparam("dispatcher", "force_dst", 1)
631 631
 		<itemizedlist>
632 632
 		<listitem>
633 633
 			<para>Value 0: If set to 0, only the gateways with state PROBING are tested.
634
-            After a gateway is probed, the PROBING state is cleared in this mode.</para>
634
+            After a gateway is probed, the PROBING state is cleared in this mode.
635
+			This means that no probing will be executed at all only if flag in config file is set to 8/PROBING
636
+			(please check destination list file syntaxis for more details), it will probe only one time at startup or 
637
+			after dispatcher reload.</para>
635 638
 		</listitem>
636 639
 		<listitem>
637 640
 			<para>Value 1: If set to 1, all gateways are tested.  If set to 1 and
638 641
 			there is a failure of keepalive to an active gateway, then it is
639
-			set to TRYING state.</para>
642
+			set to TRYING state. This means that probing will be executed all the time,
643
+			but you can skip some servers with flag 4 in destination list file, for example.</para>
640 644
 		</listitem>
641 645
 		<listitem>
642 646
 			<para>Value 2: if set to 2, only gateways in inactive state with
... ...
@@ -1701,8 +1705,21 @@ onreply_route {
1701 1701
 		</para>
1702 1702
         <programlisting  format="linespecific">
1703 1703
 		&sercmd; dispatcher.list
1704
-		</programlisting>
1705
-    </section>
1704
+ ...
1705
+DEST: {
1706
+        URI: sip:192.168.0.1:5060
1707
+        FLAGS: AP
1708
+        PRIORITY: 12
1709
+}
1710
+ ...
1711
+</programlisting>
1712
+<para>FLAGS consist out of 2 letters. First letter describe status of destination: A-active, 
1713
+	I – inactive, T – trying, D – disabled. Second letter might be P or X. P is for probing, 
1714
+	so AP means destination is active and it is tested by SIP options continuously. 
1715
+	X means that there are no probing or sip pinging. So AX means that destination is assumed as active 
1716
+	and it is not tested by SIP options. DX respectively is disabled destination what is not tested and etc.
1717
+</para>
1718
+		</section>
1706 1719
 	<section id="dispatcher.r.reload">
1707 1720
 		<title>
1708 1721
 		<function moreinfo="none">dispatcher.reload</function>