[sr-dev] git:master:1581ef7a: dialog: docs for dlg_filter_mode parameter

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 1581ef7acbd6ac6459956cf8b327cd4fd7a14736
URL: https://github.com/kamailio/kamailio/commit/1581ef7acbd6ac6459956cf8b327cd4fd7a14736

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2022-02-11T16:13:29+01:00

dialog: docs for dlg_filter_mode parameter

---

Modified: src/modules/dialog/doc/dialog_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/1581ef7acbd6ac6459956cf8b327cd4fd7a14736.diff
Patch: https://github.com/kamailio/kamailio/commit/1581ef7acbd6ac6459956cf8b327cd4fd7a14736.patch

---

diff --git a/src/modules/dialog/doc/dialog_admin.xml b/src/modules/dialog/doc/dialog_admin.xml
index 1850a08de6..f8cbfb2e9c 100644
--- a/src/modules/dialog/doc/dialog_admin.xml
+++ b/src/modules/dialog/doc/dialog_admin.xml
@@ -1299,22 +1299,29 @@ modparam("dialog", "send_bye", 1)
 </programlisting>
 		</example>
 	</section>
-	<section id="dialog.p.ignore_non_local_dlg">
-		<title><varname>ignore_non_local_dlg</varname> (int)</title>
+	<section id="dialog.p.dlg_filter_mode">
+		<title><varname>dlg_filter_mode</varname> (int)</title>
 		<para>
-			If set to 1, don't send keepalives and
-			do nothing on timeout if dialog is non local.
+			Set dialog fitering mode, which can specify what dialogs are processed.
+			Its value can be a combination (the sum) of following flags:
 		</para>
+		<itemizedlist>
+			<listitem><para>
+				<emphasis>1</emphasis> - do not send keepalives and do not
+				execute timeout function if dialog is not local (if the
+				associated bind address is not a local socket).
+			</para></listitem>
+		</itemizedlist>
 		<para>
 		<emphasis>
 			Default value is <quote>0</quote>.
 		</emphasis>
 		</para>
 		<example>
-		<title>Set <varname>ignore_non_local_dlg</varname> parameter</title>
+		<title>Set <varname>dlg_filter_mode</varname> parameter</title>
 		<programlisting format="linespecific">
 ...
-modparam("dialog", "ignore_non_local_dlg", 1)
+modparam("dialog", "dlg_filter_mode", 1)
 ...
 </programlisting>
 		</example>