Ver código fonte

websocket: docs for timer_interval and rm_delay_interval params

Daniel-Constantin Mierla 6 anos atrás
pai
commit
3a20bb1ad2
1 arquivos alterados com 31 adições e 0 exclusões
  1. 31 0
      src/modules/websocket/doc/websocket_admin.xml

+ 31 - 0
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>