[sr-dev] git:master: rtimer: updates to readme for interval attribute

[Daniel-Constantin Mierla]

Module: sip-router
Branch: master
Commit: 0fac4fb37ed2fdfeb388af0c67a80408f8b5d97e
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=0fac4fb37ed2fdfeb388af0c67a80408f8b5d97e

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Fri Dec 16 22:33:56 2011 +0100

rtimer: updates to readme for interval attribute

---

 modules_k/rtimer/README               |    9 +++++++--
 modules_k/rtimer/doc/rtimer_admin.xml |    7 ++++++-
 2 files changed, 13 insertions(+), 3 deletions(-)

diff --git a/modules_k/rtimer/README b/modules_k/rtimer/README
index 9e1d886..ce5dc3d 100644
--- a/modules_k/rtimer/README
+++ b/modules_k/rtimer/README
@@ -11,7 +11,7 @@ Daniel-Constantin Mierla
 
    <miconda at gmail.com>
 
-   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)
diff --git a/modules_k/rtimer/doc/rtimer_admin.xml b/modules_k/rtimer/doc/rtimer_admin.xml
index 7bc874b..73ee0e4 100644
--- a/modules_k/rtimer/doc/rtimer_admin.xml
+++ b/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>