Browse code

htable: readme file was regenerated

Daniel-Constantin Mierla authored on 13/11/2015 08:20:42
Showing 1 changed files
... ...
@@ -49,10 +49,9 @@ Ovidiu Sas
49 49
               3.8. array_size_suffix (str)
50 50
               3.9. fetch_rows (integer)
51 51
               3.10. timer_interval (integer)
52
-              3.11. timer_mode (integer)
53
-              3.12. db_expires (integer)
54
-              3.13. enable_dmq (integer)
55
-              3.14. timer_procs (integer)
52
+              3.11. db_expires (integer)
53
+              3.12. enable_dmq (integer)
54
+              3.13. timer_procs (integer)
56 55
 
57 56
         4. Functions
58 57
 
... ...
@@ -104,19 +103,18 @@ Ovidiu Sas
104 104
    1.11. Set array_size_suffix parameter
105 105
    1.12. Set fetch_rows parameter
106 106
    1.13. Set timer_interval parameter
107
-   1.14. Set timer_mode parameter
108
-   1.15. Set db_expires parameter
109
-   1.16. Set enable_dmq parameter
110
-   1.17. Set timer_procs parameter
111
-   1.18. sht_print usage
112
-   1.19. sht_rm_name_re usage
113
-   1.20. sht_rm_value_re usage
114
-   1.21. sht_reset usage
115
-   1.22. sht_lock usage
116
-   1.23. sht_unlock usage
117
-   1.24. sht_iterator_start usage
118
-   1.25. sht_iterator_end usage
119
-   1.26. sht_iterator_next usage
107
+   1.14. Set db_expires parameter
108
+   1.15. Set enable_dmq parameter
109
+   1.16. Set timer_procs parameter
110
+   1.17. sht_print usage
111
+   1.18. sht_rm_name_re usage
112
+   1.19. sht_rm_value_re usage
113
+   1.20. sht_reset usage
114
+   1.21. sht_lock usage
115
+   1.22. sht_unlock usage
116
+   1.23. sht_iterator_start usage
117
+   1.24. sht_iterator_end usage
118
+   1.25. sht_iterator_next usage
120 119
 
121 120
 Chapter 1. Admin Guide
122 121
 
... ...
@@ -141,10 +139,9 @@ Chapter 1. Admin Guide
141 141
         3.8. array_size_suffix (str)
142 142
         3.9. fetch_rows (integer)
143 143
         3.10. timer_interval (integer)
144
-        3.11. timer_mode (integer)
145
-        3.12. db_expires (integer)
146
-        3.13. enable_dmq (integer)
147
-        3.14. timer_procs (integer)
144
+        3.11. db_expires (integer)
145
+        3.12. enable_dmq (integer)
146
+        3.13. timer_procs (integer)
148 147
 
149 148
    4. Functions
150 149
 
... ...
@@ -414,10 +411,9 @@ $ kamcmd htable.dump htable
414 414
    3.8. array_size_suffix (str)
415 415
    3.9. fetch_rows (integer)
416 416
    3.10. timer_interval (integer)
417
-   3.11. timer_mode (integer)
418
-   3.12. db_expires (integer)
419
-   3.13. enable_dmq (integer)
420
-   3.14. timer_procs (integer)
417
+   3.11. db_expires (integer)
418
+   3.12. enable_dmq (integer)
419
+   3.13. timer_procs (integer)
421 420
 
422 421
 3.1. htable (str)
423 422
 
... ...
@@ -566,19 +562,7 @@ modparam("htable", "fetch_rows", 1000)
566 566
 modparam("htable", "timer_interval", 10)
567 567
 ...
568 568
 
569
-3.11. timer_mode (integer)
570
-
571
-   If set to 1, the module will start a new timer process. If set to 0
572
-   will use the default timer process to check for expired htable values.
573
-
574
-   Default value is 0.
575
-
576
-   Example 1.14. Set timer_mode parameter
577
-...
578
-modparam("htable", "timer_mode", 1)
579
-...
580
-
581
-3.12. db_expires (integer)
569
+3.11. db_expires (integer)
582 570
 
583 571
    If set to 1, the module will load/save the expires values of the items
584 572
    in hash table from/to database. It applies only to hash tables that
... ...
@@ -586,12 +570,12 @@ modparam("htable", "timer_mode", 1)
586 586
 
587 587
    Default value is 0.
588 588
 
589
-   Example 1.15. Set db_expires parameter
589
+   Example 1.14. Set db_expires parameter
590 590
 ...
591 591
 modparam("htable", "db_expires", 1)
592 592
 ...
593 593
 
594
-3.13. enable_dmq (integer)
594
+3.12. enable_dmq (integer)
595 595
 
596 596
    If set to 1, will enable DMQ replication of actions performed upon
597 597
    entries in all tables having "dmqreplicate" parameter set. Any update
... ...
@@ -609,23 +593,23 @@ modparam("htable", "db_expires", 1)
609 609
 
610 610
    Default value is 0.
611 611
 
612
-   Example 1.16. Set enable_dmq parameter
612
+   Example 1.15. Set enable_dmq parameter
613 613
 ...
614 614
 modparam("htable", "enable_dmq", 1)
615 615
 ...
616 616
 
617
-3.14. timer_procs (integer)
617
+3.13. timer_procs (integer)
618 618
 
619
-   If set to 1, the module will create its own timer process to scan for
620
-   expired items in hash tables. If set to zero, it will use the core
621
-   timer for this task. Set it to 1 if you store a lot of items with
622
-   autoexpire property.
619
+   If set to 1 or greater, the module will create its own timer processes
620
+   to scan for expired items in hash tables. If set to zero, it will use
621
+   the core timer for this task. Set it to 1 if you store a lot of items
622
+   with autoexpire property.
623 623
 
624 624
    Default value is 0.
625 625
 
626
-   Example 1.17. Set timer_procs parameter
626
+   Example 1.16. Set timer_procs parameter
627 627
 ...
628
-modparam("htable", "timer_procs", 1)
628
+modparam("htable", "timer_procs", 4)
629 629
 ...
630 630
 
631 631
 4. Functions
... ...
@@ -648,7 +632,7 @@ modparam("htable", "timer_procs", 1)
648 648
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
649 649
    ONREPLY_ROUTE, BRANCH_ROUTE.
650 650
 
651
-   Example 1.18. sht_print usage
651
+   Example 1.17. sht_print usage
652 652
 ...
653 653
 sht_print();
654 654
 ...
... ...
@@ -661,7 +645,7 @@ sht_print();
661 661
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
662 662
    ONREPLY_ROUTE, BRANCH_ROUTE.
663 663
 
664
-   Example 1.19. sht_rm_name_re usage
664
+   Example 1.18. sht_rm_name_re usage
665 665
 ...
666 666
 sht_rm_name_re("ha=>.*");
667 667
 ...
... ...
@@ -674,7 +658,7 @@ sht_rm_name_re("ha=>.*");
674 674
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
675 675
    ONREPLY_ROUTE, BRANCH_ROUTE.
676 676
 
677
-   Example 1.20. sht_rm_value_re usage
677
+   Example 1.19. sht_rm_value_re usage
678 678
 ...
679 679
 sht_rm_value_re("ha=>.*");
680 680
 ...
... ...
@@ -686,7 +670,7 @@ sht_rm_value_re("ha=>.*");
686 686
 
687 687
    This function can be used from ANY_ROUTE.
688 688
 
689
-   Example 1.21. sht_reset usage
689
+   Example 1.20. sht_reset usage
690 690
 ...
691 691
 sht_reset("ha$var(x)");
692 692
 ...
... ...
@@ -699,7 +683,7 @@ sht_reset("ha$var(x)");
699 699
 
700 700
    This function can be used from ANY_ROUTE.
701 701
 
702
-   Example 1.22. sht_lock usage
702
+   Example 1.21. sht_lock usage
703 703
 ...
704 704
 sht_lock("ha=>test");
705 705
 ...
... ...
@@ -712,7 +696,7 @@ sht_lock("ha=>test");
712 712
 
713 713
    This function can be used from ANY_ROUTE.
714 714
 
715
-   Example 1.23. sht_unlock usage
715
+   Example 1.22. sht_unlock usage
716 716
 ...
717 717
 sht_lock("ha=>test");
718 718
 $sht(ha=>test) = $sht(ha=>test) + 10;
... ...
@@ -734,7 +718,7 @@ sht_unlock("ha=>test");
734 734
 
735 735
    This function can be used from ANY_ROUTE.
736 736
 
737
-   Example 1.24. sht_iterator_start usage
737
+   Example 1.23. sht_iterator_start usage
738 738
 ...
739 739
 sht_iterator_start("i1", "h1");
740 740
 ...
... ...
@@ -749,7 +733,7 @@ sht_iterator_start("i1", "h1");
749 749
 
750 750
    This function can be used from ANY_ROUTE.
751 751
 
752
-   Example 1.25. sht_iterator_end usage
752
+   Example 1.24. sht_iterator_end usage
753 753
 ...
754 754
 sht_iterator_end("i1");
755 755
 ...
... ...
@@ -771,7 +755,7 @@ sht_iterator_end("i1");
771 771
 
772 772
    This function can be used from ANY_ROUTE.
773 773
 
774
-   Example 1.26. sht_iterator_next usage
774
+   Example 1.25. sht_iterator_next usage
775 775
 ...
776 776
     sht_iterator_start("i1", "h1");
777 777
     while(sht_iterator_next("i1")) {