Module: kamailio
Branch: 5.2
Commit: 3dd154faeead29f54145843d14367c5b28a4fb7b
URL:
https://github.com/kamailio/kamailio/commit/3dd154faeead29f54145843d14367c5…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2019-01-14T12:27:35+01:00
dialog: docs - more info about using the flag and dlg_manage()
(cherry picked from commit e4dfe3587943d69d556b15df3492cf38c3b21a5f)
---
Modified: src/modules/dialog/doc/dialog_admin.xml
---
Diff:
https://github.com/kamailio/kamailio/commit/3dd154faeead29f54145843d14367c5…
Patch:
https://github.com/kamailio/kamailio/commit/3dd154faeead29f54145843d14367c5…
---
diff --git a/src/modules/dialog/doc/dialog_admin.xml
b/src/modules/dialog/doc/dialog_admin.xml
index 2240a72c85..901c2b79c0 100644
--- a/src/modules/dialog/doc/dialog_admin.xml
+++ b/src/modules/dialog/doc/dialog_admin.xml
@@ -45,9 +45,10 @@
<section>
<title>How it works</title>
<para>
- To create the dialog associated with an initial request, the flag
- <quote>dlg_flag</quote> (<xref linkend="dialog.p.flag"/>)
must be set before
- creating the corresponding transaction.
+ To create the dialog associated with an initial INVITE request, execute
+ the function <quote>dlg_manage()</quote> or set the flag specified by
+ parameter <quote>dlg_flag</quote> (<xref
linkend="dialog.p.flag"/>)
+ before creating the corresponding transaction.
</para>
<para>
The dialog is automatically destroyed when a <quote>BYE</quote> is
@@ -256,6 +257,12 @@ modparam("dialog", "rr_param", "xyz")
current request (this make sense only for initial requests).
</para>
<para>
+ Note: it is not needed to set this parameter and its corresponding flag
+ for initial request in case the <quote>dlg_manage()</quote> function
+ is used. In other words, using <quote>dlg_manage()</quote> alone is
+ enough.
+ </para>
+ <para>
<emphasis>
Default value is <quote>none</quote>.
</emphasis>