[sr-dev] git:5.2:458abbe5: dispatcher: update for module docs (#1804)

[Daniel-Constantin Mierla]

Module: kamailio
Branch: 5.2
Commit: 458abbe5b5d8fbcb814612af3cac90aa784db227
URL: https://github.com/kamailio/kamailio/commit/458abbe5b5d8fbcb814612af3cac90aa784db227

Author: Jurijs I <jurijs.ivolga at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2019-01-14T12:29:03+01:00

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

(cherry picked from commit 14a87383fbae102b430ed6cfdba2559f1768cdd0)

---

Modified: src/modules/dispatcher/doc/dispatcher_admin.xml

---

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

---

diff --git a/src/modules/dispatcher/doc/dispatcher_admin.xml b/src/modules/dispatcher/doc/dispatcher_admin.xml
index 3b40c04622..c0a55b27ad 100644
--- a/src/modules/dispatcher/doc/dispatcher_admin.xml
+++ b/src/modules/dispatcher/doc/dispatcher_admin.xml
@@ -631,12 +631,16 @@ modparam("dispatcher", "force_dst", 1)
 		<itemizedlist>
 		<listitem>
 			<para>Value 0: If set to 0, only the gateways with state PROBING are tested.
-            After a gateway is probed, the PROBING state is cleared in this mode.</para>
+            After a gateway is probed, the PROBING state is cleared in this mode.
+			This means that no probing will be executed at all only if flag in config file is set to 8/PROBING
+			(please check destination list file syntaxis for more details), it will probe only one time at startup or 
+			after dispatcher reload.</para>
 		</listitem>
 		<listitem>
 			<para>Value 1: If set to 1, all gateways are tested.  If set to 1 and
 			there is a failure of keepalive to an active gateway, then it is
-			set to TRYING state.</para>
+			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.</para>
 		</listitem>
 		<listitem>
 			<para>Value 2: if set to 2, only gateways in inactive state with
@@ -1701,8 +1705,21 @@ onreply_route {
 		</para>
         <programlisting  format="linespecific">
 		&sercmd; dispatcher.list
-		</programlisting>
-    </section>
+ ...
+DEST: {
+        URI: sip:192.168.0.1:5060
+        FLAGS: AP
+        PRIORITY: 12
+}
+ ...
+</programlisting>
+<para>FLAGS consist out of 2 letters. First letter describe status of destination: A-active, 
+	I – inactive, T – trying, D – disabled. Second letter might be P or X. P is for probing, 
+	so AP means destination is active and it is tested by SIP options continuously. 
+	X means that there are no probing or sip pinging. So AX means that destination is assumed as active 
+	and it is not tested by SIP options. DX respectively is disabled destination what is not tested and etc.
+</para>
+		</section>
 	<section id="dispatcher.r.reload">
 		<title>
 		<function moreinfo="none">dispatcher.reload</function>