Browse Source

modules/dialog: docs updated for timeout_noreset parameter and timeout-noreset property

Federico Cabiddu 11 năm trước cách đây
mục cha
commit
97c3a6ad01
1 tập tin đã thay đổi với 39 bổ sung3 xóa
  1. 39 3
      modules/dialog/doc/dialog_admin.xml

+ 39 - 3
modules/dialog/doc/dialog_admin.xml

@@ -1235,6 +1235,28 @@ modparam("dialog", "ka_interval", 300)
 		</example>
 		</example>
 	</section>
 	</section>
 
 
+	<section>
+		<title><varname>timeout_noreset</varname> (int)</title>
+		<para>
+           If set to 1, the dialog timeout won't be reset each
+			time a sequential request is processed.
+			It is an alternative to dlg_set_property("timeout-noreset") for all dialogs.
+		</para>
+		<para>
+		<emphasis>
+			Default value is <quote>0</quote>.
+		</emphasis>
+		</para>
+		<example>
+		<title>Set <varname>timeout_noreset</varname> parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("dialog", "timeout_noreset", 1)
+...
+</programlisting>
+		</example>
+	</section>
+
 	</section>
 	</section>
 
 
 
 
@@ -1802,8 +1824,17 @@ dlg_set_timeout_by_profile("users", "abc123", "3");
 		<itemizedlist>
 		<itemizedlist>
 		<listitem>
 		<listitem>
 			<para><emphasis>attr</emphasis> - name of property. It can be:
 			<para><emphasis>attr</emphasis> - name of property. It can be:
-				'ka-src' - send keep alive OPTION requests to caller;
-				'ka-dst' - send keep alive OPTION requests to callee.
+				<itemizedlist>
+					<listitem>
+						'ka-src' - send keep alive OPTION requests to caller
+					</listitem>
+					<listitem>
+						'ka-dst' - send keep alive OPTION requests to callee
+					</listitem>
+					<listitem>
+						'timeout-noreset' - don't reset timeout on in-dialog messages reception
+					</listitem>
+				</itemizedlist>
 			</para>
 			</para>
 		</listitem>
 		</listitem>
 		</itemizedlist>
 		</itemizedlist>
@@ -1813,7 +1844,11 @@ dlg_set_timeout_by_profile("users", "abc123", "3");
 			within dialog, with the scope of detecting if the destination is
 			within dialog, with the scope of detecting if the destination is
 			still in the call. If the keep alive request results in a local
 			still in the call. If the keep alive request results in a local
 			timeout or '481 Call Leg/Transaction Does Not Exist', then the
 			timeout or '481 Call Leg/Transaction Does Not Exist', then the
-			dialog is ended from the server.
+            dialog is ended from the server.
+		</para>
+		<para>
+            If 'timeout-noreset' is set, dialog timeout won't be reset upon reception
+            of in-dialog messages (default behavior).
 		</para>
 		</para>
 		<para>
 		<para>
 		This function can be used from ANY_ROUTE.
 		This function can be used from ANY_ROUTE.
@@ -1824,6 +1859,7 @@ dlg_set_timeout_by_profile("users", "abc123", "3");
 ...
 ...
 dlg_set_property("ka-src");
 dlg_set_property("ka-src");
 dlg_set_property("ka-dst");
 dlg_set_property("ka-dst");
+dlg_set_property("timeout-noreset");
 ...
 ...
 </programlisting>
 </programlisting>
 		</example>
 		</example>