Browse code

cfgutils: updated readme file

Daniel-Constantin Mierla authored on 21/07/2015 12:20:37
Showing 1 changed files
... ...
@@ -32,8 +32,8 @@ Daniel-Constantin Mierla
32 32
 
33 33
    <miconda@gmail.com>
34 34
 
35
-   Copyright (c) 2014, 2013, 2007, 2008, 2004 Edvina AB, 1und1 Internet
36
-   AG, BASIS AudioNet GmbH, Elena-Ramona Modroiu, Juha Heinanen, FhG FOKUS
35
+   Copyright � 2014, 2013, 2007, 2008, 2004 Edvina AB, 1und1 Internet AG,
36
+   BASIS AudioNet GmbH, Elena-Ramona Modroiu, Juha Heinanen, FhG FOKUS
37 37
      __________________________________________________________________
38 38
 
39 39
    Table of Contents
... ...
@@ -357,30 +357,30 @@ rand_reset_prob();
357 357
 ...
358 358
 rand_get_prob();
359 359
 
360
-4.5.  sleep(time)
360
+4.5. sleep(time)
361 361
 
362 362
    Waits "time" seconds.
363 363
 
364 364
    Meaning of the parameters is as follows:
365
-     * time - Time to wait in seconds.
365
+     * time - Time to wait in seconds. It can be an integer or a variable
366
+       holding an integer.
366 367
 
367
-   This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
368
-   FAILURE_ROUTE, BRANCH_ROUTE.
368
+   This function can be used from ANY_ROUTE.
369 369
 
370 370
    Example 1.9. sleep usage
371 371
 ...
372 372
 sleep("1");
373 373
 ...
374 374
 
375
-4.6.  usleep(time)
375
+4.6. usleep(time)
376 376
 
377 377
    Waits "time" micro-seconds.
378 378
 
379 379
    Meaning of the parameters is as follows:
380
-     * time - Time to wait in micro-seconds (1/1000000 of a second).
380
+     * time - Time to wait in micro-seconds (1/1000000 of a second). It
381
+       can be an integer or a variable holding an integer.
381 382
 
382
-   This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE,
383
-   FAILURE_ROUTE, BRANCH_ROUTE.
383
+   This function can be used from ANY_ROUTE.
384 384
 
385 385
    Example 1.10. usleep usage
386 386
 ...
... ...
@@ -388,7 +388,7 @@ sleep("1");
388 388
 usleep("5000");
389 389
 ...
390 390
 
391
-4.7.  abort()
391
+4.7. abort()
392 392
 
393 393
    Debugging function that aborts the server. Depending on the
394 394
    configuration of the server a core dump will be created.
... ...
@@ -401,7 +401,7 @@ usleep("5000");
401 401
 abort();
402 402
 ...
403 403
 
404
-4.8.  pkg_status()
404
+4.8. pkg_status()
405 405
 
406 406
    Debugging function that dumps the status for the private (PKG) memory.
407 407
    This information is logged to the default log facility, depending on
... ...
@@ -416,7 +416,7 @@ abort();
416 416
 pkg_status();
417 417
 ...
418 418
 
419
-4.9.  pkg_summary()
419
+4.9. pkg_summary()
420 420
 
421 421
    Debugging function that dumps the summary for the private (PKG) memory
422 422
    usage. This information is logged to the default log facility,
... ...
@@ -431,7 +431,7 @@ pkg_status();
431 431
 pkg_summary();
432 432
 ...
433 433
 
434
-4.10.  shm_status()
434
+4.10. shm_status()
435 435
 
436 436
    Debugging function that dumps the status for the shared (SHM) memory.
437 437
    This information is logged to the default log facility, depending on
... ...
@@ -446,7 +446,7 @@ pkg_summary();
446 446
 shm_status();
447 447
 ...
448 448
 
449
-4.11.  shm_summary()
449
+4.11. shm_summary()
450 450
 
451 451
    Debugging function that dumps the summary for the shared (SHM) memory
452 452
    usage. This information is logged to the default log facility,
... ...
@@ -632,7 +632,7 @@ $ kamctl fifo rand_set_prob 10
632 632
 
633 633
    This command don't need a parameter.
634 634
 
635
-   Example 1.25.  rand_reset_prob usage
635
+   Example 1.25. rand_reset_prob usage
636 636
 ...
637 637
 $ kamctl fifo rand_reset_prob
638 638
 ...
... ...
@@ -696,7 +696,7 @@ $ kamctl fifo set_gflag 0x3
696 696
    The parameter value must be a bitmask in decimal or hexadecimal format.
697 697
    The bitmask has a 32 bit size.
698 698
 
699
-   Example 1.30.  reset_gflag usage
699
+   Example 1.30. reset_gflag usage
700 700
 ...
701 701
 $ kamctl fifo reset_gflag 1
702 702
 $ kamctl fifo reset_gflag 0x3
... ...
@@ -735,7 +735,7 @@ TRUE
735 735
    Return the bitmap with all flags. The function gets no parameters and
736 736
    returns the bitmap in hexadecimal and decimal format.
737 737
 
738
-   Example 1.32.  get_gflags usage
738
+   Example 1.32. get_gflags usage
739 739
 ...
740 740
 $ kamctl fifo get_gflags
741 741
 0x3039
... ...
@@ -769,7 +769,7 @@ $ kamctl cfgutils.set_gflag s:1
769 769
    The parameter value must be a bitmask in decimal or hexadecimal format.
770 770
    The bitmask has a 32 bit size.
771 771
 
772
-   Example 1.34.  cfgutils.reset_gflag usage
772
+   Example 1.34. cfgutils.reset_gflag usage
773 773
 ...
774 774
 $ kamctl cfgutils.reset_gflag s:0x1
775 775
 ...