[sr-dev] git:master: Updated generated README with doc changes for is_known_dlg() as well.

[Alex Balashov]

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

Author: Alex Balashov <abalashov at evaristesys.com>
Committer: Alex Balashov <abalashov at evaristesys.com>
Date:   Sun Oct  3 22:08:53 2010 -0400

Updated generated README with doc changes for is_known_dlg() as well.

---

 modules_k/dialog/README |   15 ++++++++++-----
 1 files changed, 10 insertions(+), 5 deletions(-)

diff --git a/modules_k/dialog/README b/modules_k/dialog/README
index 348b694..0cb0730 100644
--- a/modules_k/dialog/README
+++ b/modules_k/dialog/README
@@ -1113,11 +1113,16 @@ if(dlg_get("abcdef", "123", "456"))
 
 6.13.  is_known_dlg()
 
-   This function checks if the dialog module is aware of this dialog,
-   regardless of whether it is in any profiles. The dialog module tracks
-   all dialogs irrespectively of profile usage; as such, this function
-   will return affirmatively if the request corresponds to a dialog that
-   is currently active.
+   This function checks if the current SIP message being processed belongs
+   to any transaction within an active dialog that the dialog module is
+   currently tracking. This is a check for tracking of any kind, without
+   regard to profiles.
+
+   This function has numerous potential applications, among which is that
+   it can be used to strengthen security for loose-routing sequential
+   (in-dialog) requests or responses to them, as by providing a
+   preventative check against spoofing on the proxy level instead of
+   leaving the issue purely to the receiving UA.
 
    This function can be used from REQUEST_ROUTE, BRANCH_ROUTE, REPLY_ROUTE
    and FAILURE_ROUTE.