[sr-dev] git:3.1: dialog(k): Note dependency between dlg_manage() and transactions

[Timo Reimann]

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

Author: Timo Reimann <timo.reimann at 1und1.de>
Committer: Timo Reimann <timo.reimann at 1und1.de>
Date:   Mon Oct 17 11:46:45 2011 +0200

dialog(k): Note dependency between dlg_manage() and transactions
in docs.
(cherry picked from commit 807f07499b4875cf77463c3bdb6a47e099f18f58)

---

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

diff --git a/modules_k/dialog/doc/dialog_admin.xml b/modules_k/dialog/doc/dialog_admin.xml
index 9305b73..649223b 100644
--- a/modules_k/dialog/doc/dialog_admin.xml
+++ b/modules_k/dialog/doc/dialog_admin.xml
@@ -1291,6 +1291,15 @@ dlg_refer("caller", "sip:annoucement at kamailio.org");
 		<para>
 		This function can be used from REQUEST_ROUTE.
 		</para>
+		<para>
+		<b>IMPORTANT</b>: Users of this function should make sure that the
+		dialog created is further processed statefully. Specifically, if a
+		stateless response is sent out after dlg_manage() is called, the
+		dialog cannot be handled properly. So make sure that a transaction
+		exists or create it explicitly using the tm module.<br>This is a
+		shortcoming of the current implementation that may be resolved in a
+		future version hopefully.
+		</para>
 		<example>
 		<title><function>dlg_manage</function> usage</title>
 		<programlisting format="linespecific">