[sr-dev] git:master:3a20bb1a: websocket: docs for timer_interval and rm_delay_interval params

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: 3a20bb1ad27b8a85ec932975e14bcec12237437b
URL: https://github.com/kamailio/kamailio/commit/3a20bb1ad27b8a85ec932975e14bcec12237437b

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2018-12-19T14:11:51+01:00

websocket: docs for timer_interval and rm_delay_interval params

---

Modified: src/modules/websocket/doc/websocket_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/3a20bb1ad27b8a85ec932975e14bcec12237437b.diff
Patch: https://github.com/kamailio/kamailio/commit/3a20bb1ad27b8a85ec932975e14bcec12237437b.patch

---

diff --git a/src/modules/websocket/doc/websocket_admin.xml b/src/modules/websocket/doc/websocket_admin.xml
index 338d37ef22..6b6483d73f 100644
--- a/src/modules/websocket/doc/websocket_admin.xml
+++ b/src/modules/websocket/doc/websocket_admin.xml
@@ -477,6 +477,37 @@ end
 	    </example>
 	</section>
 
+	<section id="websocket.p.timer_interval">
+		<title><varname>timer_interval</varname> (integer)</title>
+		<para>The number of seconds between each timer process run
+		</para>
+		<para><emphasis>Default value is 1.</emphasis></para>
+		<example>
+		<title>Set <varname>timer_interval</varname>parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("websocket", "timer_interval", 5)
+...
+</programlisting>
+		</example>
+	</section>
+
+	<section id="websocket.p.rm_delay_interval">
+		<title><varname>rm_delay_interval</varname> (integer)</title>
+		<para>The number of seconds to wait before destroying the websocket
+		connection once put in remove state.
+		</para>
+		<para><emphasis>Default value is 5.</emphasis></para>
+		<example>
+		<title>Set <varname>rm_timer_interval</varname>parameter</title>
+		<programlisting format="linespecific">
+...
+modparam("websocket", "rm_delay_interval", 2)
+...
+</programlisting>
+		</example>
+	</section>
+
 	</section>
 
 	<section>