Explorar o código

rtimer: updates to readme for interval attribute

Daniel-Constantin Mierla %!s(int64=13) %!d(string=hai) anos
pai
achega
0fac4fb37e
Modificáronse 2 ficheiros con 13 adicións e 3 borrados
  1. 7 2
      modules_k/rtimer/README
  2. 6 1
      modules_k/rtimer/doc/rtimer_admin.xml

+ 7 - 2
modules_k/rtimer/README

@@ -11,7 +11,7 @@ Daniel-Constantin Mierla
 
    <[email protected]>
 
-   Copyright © 2009 http://www.asipto.com
+   Copyright © 2009 http://www.asipto.com
      __________________________________________________________________
 
    Table of Contents
@@ -88,13 +88,18 @@ Chapter 1. Admin Guide
    configuration file.
      * name - name of the timer.
      * mode - if set to 1, will create a new timer process.
-     * interval - timer interval in seconds.
+     * interval - timer interval in seconds or micro-seconds (the value
+       must be ended in 'u'). For micro-seconds intervals, mode is set
+       always to 1.
 
    Default value is NULL.
 
    Example 1.1. Set timer parameter
 ...
+# time interval set to 10 seconds
 modparam("rtimer", "timer", "name=ta;interval=10;mode=1;")
+# time interval set to 100 mili-seconds
+modparam("rtimer", "timer", "name=ta;interval=100000u;mode=1;")
 ...
 
 3.2. exec (str)

+ 6 - 1
modules_k/rtimer/doc/rtimer_admin.xml

@@ -87,7 +87,9 @@
 		</listitem>
 		<listitem>
 		<para>
-			<emphasis>interval</emphasis> - timer interval in seconds.
+			<emphasis>interval</emphasis> - timer interval in seconds or
+			micro-seconds (the value must be ended in 'u'). For micro-seconds
+			intervals, mode is set always to 1.
 		</para>
 		</listitem>
 		</itemizedlist>
@@ -100,7 +102,10 @@
 		<title>Set <varname>timer</varname> parameter</title>
 		<programlisting format="linespecific">
 ...
+# time interval set to 10 seconds
 modparam("rtimer", "timer", "name=ta;interval=10;mode=1;")
+# time interval set to 100 mili-seconds
+modparam("rtimer", "timer", "name=ta;interval=100000u;mode=1;")
 ...
 </programlisting>
 		</example>