|
@@ -16,13 +16,13 @@
|
|
|
<section>
|
|
|
<title>Overview</title>
|
|
|
<para>
|
|
|
- The dialog2 module provides dialog awareness to the &kamailio; proxy. Its
|
|
|
+ The dialog_ng module provides dialog awareness to the &kamailio; proxy. Its
|
|
|
functionality is to keep track of the current dialogs, to offer information
|
|
|
about them (like how many dialogs are active) or to manage them. The module
|
|
|
exports several functions that could be used directly from scripts.
|
|
|
- The dialog2 module extends the original dialog module by providing support
|
|
|
+ The dialog_ng module extends the original dialog module by providing support
|
|
|
for forked calling and early dialog termination. It is the intention that
|
|
|
- the dialog2 module will eventually replace the dialog module.
|
|
|
+ the dialog_ng module will eventually replace the dialog module.
|
|
|
</para>
|
|
|
<para>
|
|
|
The module, via an internal API, also provide the foundation to build on
|
|
@@ -143,7 +143,7 @@
|
|
|
<varname>enable_stats</varname> (integer)
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -175,7 +175,7 @@
|
|
|
</title>
|
|
|
<programlisting format="linespecific">
|
|
|
...
|
|
|
-modparam("dialog2", "hash_size", 1024)
|
|
|
+modparam("dialog_ng", "hash_size", 1024)
|
|
|
...
|
|
|
</programlisting>
|
|
|
</example>
|
|
@@ -201,7 +201,7 @@ modparam("dialog2", "hash_size", 1024)
|
|
|
</title>
|
|
|
<programlisting format="linespecific">
|
|
|
...
|
|
|
-modparam("dialog2", "rr_param", "xyz")
|
|
|
+modparam("dialog_ng", "rr_param", "xyz")
|
|
|
...
|
|
|
</programlisting>
|
|
|
</example>
|
|
@@ -227,7 +227,7 @@ modparam("dialog2", "rr_param", "xyz")
|
|
|
</title>
|
|
|
<programlisting format="linespecific">
|
|
|
...
|
|
|
-modparam("dialog2", "dlg_flag", 4)
|
|
|
+modparam("dialog_ng", "dlg_flag", 4)
|
|
|
...
|
|
|
</programlisting>
|
|
|
</example>
|
|
@@ -254,7 +254,7 @@ modparam("dialog2", "dlg_flag", 4)
|
|
|
</title>
|
|
|
<programlisting format="linespecific">
|
|
|
...
|
|
|
-modparam("dialog2", "timeout_avp", "$avp(i:10)")
|
|
|
+modparam("dialog_ng", "timeout_avp", "$avp(i:10)")
|
|
|
...
|
|
|
</programlisting>
|
|
|
</example>
|
|
@@ -279,7 +279,7 @@ modparam("dialog2", "timeout_avp", "$avp(i:10)")
|
|
|
</title>
|
|
|
<programlisting format="linespecific">
|
|
|
...
|
|
|
-modparam("dialog2", "default_timeout", 21600)
|
|
|
+modparam("dialog_ng", "default_timeout", 21600)
|
|
|
...
|
|
|
</programlisting>
|
|
|
</example>
|
|
@@ -305,7 +305,7 @@ modparam("dialog2", "default_timeout", 21600)
|
|
|
</title>
|
|
|
<programlisting format="linespecific">
|
|
|
...
|
|
|
-modparam("dialog2", "dlg_extra_hdrs", "Hint: credit expired\r\n")
|
|
|
+modparam("dialog_ng", "dlg_extra_hdrs", "Hint: credit expired\r\n")
|
|
|
...
|
|
|
</programlisting>
|
|
|
</example>
|
|
@@ -342,7 +342,7 @@ modparam("dialog2", "dlg_extra_hdrs", "Hint: credit expired\r\n")
|
|
|
</title>
|
|
|
<programlisting format="linespecific">
|
|
|
...
|
|
|
-modparam("dialog2", "detect_spirals", 1)
|
|
|
+modparam("dialog_ng", "detect_spirals", 1)
|
|
|
...
|
|
|
</programlisting>
|
|
|
</example>
|
|
@@ -353,7 +353,7 @@ modparam("dialog2", "detect_spirals", 1)
|
|
|
<varname>db_url</varname> (string)
|
|
|
</title>
|
|
|
<para>
|
|
|
- Db storage not yet supported by dialog2 - this to be done in future.
|
|
|
+ Db storage not yet supported by dialog_ng - this to be done in future.
|
|
|
</para>
|
|
|
</section>
|
|
|
|
|
@@ -362,7 +362,7 @@ modparam("dialog2", "detect_spirals", 1)
|
|
|
<varname>db_mode</varname> (integer)
|
|
|
</title>
|
|
|
<para>
|
|
|
- Db storage not yet supported by dialog2 - this to be done in future.
|
|
|
+ Db storage not yet supported by dialog_ng - this to be done in future.
|
|
|
</para>
|
|
|
</section>
|
|
|
|
|
@@ -371,7 +371,7 @@ modparam("dialog2", "detect_spirals", 1)
|
|
|
<varname>db_update_period</varname> (integer)
|
|
|
</title>
|
|
|
<para>
|
|
|
- Db storage not yet supported by dialog2 - this to be done in future.
|
|
|
+ Db storage not yet supported by dialog_ng - this to be done in future.
|
|
|
</para>
|
|
|
</section>
|
|
|
|
|
@@ -380,7 +380,7 @@ modparam("dialog2", "detect_spirals", 1)
|
|
|
<varname>db_fetch_rows</varname> (integer)
|
|
|
</title>
|
|
|
<para>
|
|
|
- Db storage not yet supported by dialog2 - this to be done in future.
|
|
|
+ Db storage not yet supported by dialog_ng - this to be done in future.
|
|
|
</para>
|
|
|
</section>
|
|
|
|
|
@@ -389,7 +389,7 @@ modparam("dialog2", "detect_spirals", 1)
|
|
|
<varname>table_name</varname> (string)
|
|
|
</title>
|
|
|
<para>
|
|
|
- Db storage not yet supported by dialog2 - this to be done in future.
|
|
|
+ Db storage not yet supported by dialog_ng - this to be done in future.
|
|
|
</para>
|
|
|
</section>
|
|
|
|
|
@@ -774,7 +774,7 @@ redlg_setflag("1");
|
|
|
<function moreinfo="none">dlg_terminate</function>
|
|
|
</title>
|
|
|
<para>
|
|
|
- Terminates a dialog. In dialog2 module this function now
|
|
|
+ Terminates a dialog. In dialog_ng module this function now
|
|
|
includes support for early as well as confirmed dialogs.
|
|
|
</para>
|
|
|
<para>Meaning of the parameters is as follows:</para>
|
|
@@ -812,7 +812,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<function moreinfo="none">dlg_refer(side, address)</function>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -822,7 +822,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<function moreinfo="none">dlg_manage()</function>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This has been deprecated in dialog2. Instead set dialog flag for
|
|
|
+ This has been deprecated in dialog_ng. Instead set dialog flag for
|
|
|
initial INVITE and Route-parameter-callback execution for
|
|
|
within-dialog requests.
|
|
|
</para>
|
|
@@ -833,7 +833,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<function moreinfo="none">dlg_bridge(from, to, op)</function>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -843,7 +843,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<function moreinfo="none">dlg_get(callid, ftag, ttag)</function>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -853,7 +853,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<function moreinfo="none">is_known_dlg()</function>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -868,7 +868,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>active_dialogs</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -877,7 +877,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>early_dialogs</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -886,7 +886,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>processed_dialogs</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -895,7 +895,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>expired_dialogs</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -904,7 +904,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>failed_dialogs</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -921,7 +921,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<para>
|
|
|
Lists the description of a dialog or of all dialogs (calls). If only
|
|
|
one dialogs is to be listed, the dialog identifiers are to be passed
|
|
|
- as parameter (callid and fromtag). In dialog2 module this also now
|
|
|
+ as parameter (callid and fromtag). In dialog_ng module this also now
|
|
|
also lists all dlg_out entries for early dialogs.
|
|
|
|
|
|
</para>
|
|
@@ -967,7 +967,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>dlg_list_ctx</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -977,7 +977,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>dlg_end_dlg</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -987,7 +987,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>dlg_terminate_dlg</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- Terminates a singe dialog, identified by the call_id, ftag, ttag. In dialog2 module this
|
|
|
+ Terminates a singe dialog, identified by the call_id, ftag, ttag. In dialog_ng module this
|
|
|
dialog can be terminated in the early or confirmed states.
|
|
|
</para>
|
|
|
<para>
|
|
@@ -1030,7 +1030,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>profile_get_size</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -1040,7 +1040,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>profile_list_dlgs</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -1050,7 +1050,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>dlg_bridge</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -1065,7 +1065,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>dlg.list</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -1075,7 +1075,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>dlg.list_ctx</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -1085,7 +1085,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>dlg.dlg_list</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -1095,7 +1095,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>dlg.dlg_list_ctx</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -1105,7 +1105,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>dlg.end_dlg</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -1115,7 +1115,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>dlg.profile_get_size</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -1125,7 +1125,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>dlg.profile_list</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -1135,7 +1135,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>dlg.bridge_dlg</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -1151,7 +1151,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>$DLG_count</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -1161,7 +1161,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>$DLG_status</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -1171,7 +1171,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>$DLG_lifetime</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -1180,7 +1180,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>$dlg(...)</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -1189,7 +1189,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>$dlg_ctx(...)</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|
|
@@ -1199,7 +1199,7 @@ dlg_terminate("all", "Insufficient QoS");
|
|
|
<varname>$dlg_var(key)</varname>
|
|
|
</title>
|
|
|
<para>
|
|
|
- This function is currently not supported by the dialog2 module.
|
|
|
+ This function is currently not supported by the dialog_ng module.
|
|
|
To be incorporated in the future.
|
|
|
</para>
|
|
|
</section>
|