[sr-dev] git:4.0: modules/dialog: improve documentation of DID matching

[Klaus Darilion]

Module: sip-router
Branch: 4.0
Commit: 59adebfe3ae6f18a337833d0df62ee67e161bff5
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=59adebfe3ae6f18a337833d0df62ee67e161bff5

Author: Klaus Darilion <klaus.mailinglists at pernau.at>
Committer: Klaus Darilion <klaus.mailinglists at pernau.at>
Date:   Mon May 27 10:44:03 2013 +0000

modules/dialog: improve documentation of DID matching
(cherry picked from commit 68209cc2b15c2c0674d7cf4529607e148e3fc1b4)

---

 modules/dialog/doc/dialog_admin.xml |    9 +++++++++
 1 files changed, 9 insertions(+), 0 deletions(-)

diff --git a/modules/dialog/doc/dialog_admin.xml b/modules/dialog/doc/dialog_admin.xml
index 125e33c..f0d1626 100644
--- a/modules/dialog/doc/dialog_admin.xml
+++ b/modules/dialog/doc/dialog_admin.xml
@@ -311,6 +311,15 @@ modparam("dialog", "dlg_extra_hdrs", "Hint: credit expired\r\n")
 		elements (as in RFC 3261).
 		</para>
 		<para>
+		Note: DID-based matching does not replace callid/fromtag/totag comparison. It will speed
+		up dialog matching by not iterating over the whole dialog list for callid/fromtag/totag comparison, but
+		instead it uses a hash table to find the respective dialog and then doing only one callid/fromtag/totag 
+		comparison. Thus, there is no security 
+		issue when using DID based matching. Use DID_FALLBACK for maximum interoperability or use DID_ONLY to
+		reject buggy clients or hacking attempts. DID_NONE is only useful, when you want to hide dialog-tracking
+		from the users (preventing the DID Record-Route cookie).
+		</para>
+		<para>
 		The supported modes are:
 		</para>
 		<itemizedlist>