[sr-dev] git:4.1: dispatcher: more details on how destination select functions work

[Daniel-Constantin Mierla]

Module: sip-router
Branch: 4.1
Commit: 7a21f21d2e5d48fa83454a4ed2fa4a9671f9d015
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=7a21f21d2e5d48fa83454a4ed2fa4a9671f9d015

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Tue Jan 21 10:13:51 2014 +0100

dispatcher: more details on how destination select functions work

(cherry picked from commit f210c266311498393b93d66b41e8c08d89cbc731)

---

 modules/dispatcher/doc/dispatcher_admin.xml |   14 +++++++++++---
 1 files changed, 11 insertions(+), 3 deletions(-)

diff --git a/modules/dispatcher/doc/dispatcher_admin.xml b/modules/dispatcher/doc/dispatcher_admin.xml
index d375fd0..75debec 100644
--- a/modules/dispatcher/doc/dispatcher_admin.xml
+++ b/modules/dispatcher/doc/dispatcher_admin.xml
@@ -24,7 +24,7 @@
 	</para>
 	<para>
 		The module can be used as a stateless load balancer, it does not
-		depend on any call state tracing module. It requires the TM module if
+		depend on any call state tracking module. It requires the TM module if
 		you enable auto-discovery of active/inactive gateways.
 	</para>
 	<para>
@@ -741,7 +741,15 @@ modparam("dispatcher", "force_dst", 1)
 		</title>
 		<para>
 		The method selects a destination from addresses set. It returns true if
-		a new destination is set.
+		a new destination is set. The selected address is set to dst_uri field
+		(aka the outbound proxy address or the $du variable), not being visible
+		in the SIP request.
+		</para>
+		<para>
+		If the bit 2 in 'flags' parameter is set, the rest of the addresses from
+		the destination set is stored in AVP list. You can use 'ds_next_dst()'
+		to use next address in order to achieve serial forking to all possible
+		destinations.
 		</para>
 		<para>Meaning of the parameters is as follows:</para>
 		<itemizedlist>
@@ -875,7 +883,7 @@ ds_select_dst("1", "$var(a)");
  		<function moreinfo="none">ds_select_domain(set, alg)</function>
  		</title>
  		<para>
- 		The method selects a destination from addresses set  and rewrites the
+ 		The method selects a destination from addresses set and rewrites the
  		host and port from R-URI. The parameters have same meaning as for
  		ds_select_dst().
  		</para>