[sr-dev] git:master: Improved documentation for is_known_dlg() function and added some

Module: sip-router Branch: master Commit: 8c0bdbd5f70d9a6f61b206ecc918404c880fdf24 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=8c0bdbd… Author: Alex Balashov - Diminuendo-2 &lt;evariste-admins(a)evaristesys.com&gt; Committer: Alex Balashov - Diminuendo-2 &lt;evariste-admins(a)evaristesys.com&gt; Date: Sun Oct 3 20:52:35 2010 -0400 Improved documentation for is_known_dlg() function and added some clarifications, and also tested my commit rights. --- modules_k/dialog/doc/dialog_admin.xml | 17 ++++++++++++----- 1 files changed, 12 insertions(+), 5 deletions(-) diff --git a/modules_k/dialog/doc/dialog_admin.xml b/modules_k/dialog/doc/dialog_admin.xml index ec80223..d6ecfe2 100644 --- a/modules_k/dialog/doc/dialog_admin.xml +++ b/modules_k/dialog/doc/dialog_admin.xml @@ -1394,11 +1394,18 @@ if(dlg_get("abcdef", "123", "456")) <function moreinfo="none">is_known_dlg()</function> </title> <para> - 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. + </para> + <para> + 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. </para> <para> This function can be used from REQUEST_ROUTE, BRANCH_ROUTE,