Browse code

cfgutils: updated docs to specify correct time unit for usleep

- it is microseconds, pointed by David K

Daniel-Constantin Mierla authored on 06/06/2013 09:47:10
Showing 2 changed files
... ...
@@ -355,17 +355,18 @@ sleep("1");
355 355
 
356 356
 4.6. usleep(time)
357 357
 
358
-   Waits "time" milli-seconds.
358
+   Waits "time" micro-seconds.
359 359
 
360 360
    Meaning of the parameters is as follows:
361
-     * time - Time to wait in milli-seconds.
361
+     * time - Time to wait in micro-seconds (1/1000000 of a second).
362 362
 
363 363
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
364 364
    FAILURE_ROUTE, BRANCH_ROUTE.
365 365
 
366 366
    Example 1.10. usleep usage
367 367
 ...
368
-usleep("500");
368
+# wait 5 miliseconds
369
+usleep("5000");
369 370
 ...
370 371
 
371 372
 4.7. abort()
... ...
@@ -266,12 +266,13 @@ sleep("1");
266 266
 			<function moreinfo="none">usleep(time)</function>
267 267
 		</title>
268 268
 		<para>
269
-			Waits "time" milli-seconds.
269
+			Waits "time" micro-seconds.
270 270
 		</para>
271 271
 		<para>Meaning of the parameters is as follows:</para>
272 272
 		<itemizedlist>
273 273
 			<listitem>
274
-				<para><emphasis>time</emphasis> - Time to wait in milli-seconds.
274
+				<para><emphasis>time</emphasis> - Time to wait in micro-seconds
275
+					(1/1000000 of a second).
275 276
 				</para>
276 277
 			</listitem>
277 278
 		</itemizedlist>
... ...
@@ -283,7 +284,8 @@ sleep("1");
283 284
 			<title><function>usleep</function> usage</title>
284 285
 			<programlisting format="linespecific">
285 286
 ...
286
-usleep("500");
287
+# wait 5 miliseconds
288
+usleep("5000");
287 289
 ...
288 290
 			</programlisting>
289 291
 		</example>