Browse code

modules: readme files regenerated - htable ... [skip ci]

Kamailio Dev authored on 23/10/2021 18:31:21
Showing 1 changed files
... ...
@@ -69,10 +69,11 @@ Ovidiu Sas
69 69
               4.13. sht_iterator_rm(iname)
70 70
               4.14. sht_iterator_sets(iname, sval)
71 71
               4.15. sht_iterator_seti(iname, ival)
72
-              4.16. sht_match_name(htable, op, mval)
73
-              4.17. sht_has_name(htable, op, mval)
74
-              4.18. sht_match_str_value(htable, op, mval)
75
-              4.19. sht_has_str_value(htable, op, mval)
72
+              4.16. sht_iterator_setex(iname, exval)
73
+              4.17. sht_match_name(htable, op, mval)
74
+              4.18. sht_has_name(htable, op, mval)
75
+              4.19. sht_match_str_value(htable, op, mval)
76
+              4.20. sht_has_str_value(htable, op, mval)
76 77
 
77 78
         5. Exported pseudo-variables
78 79
         6. RPC Commands
... ...
@@ -129,8 +130,9 @@ Ovidiu Sas
129 130
    1.32. sht_iterator_rm usage
130 131
    1.33. sht_iterator_sets usage
131 132
    1.34. sht_iterator_seti usage
132
-   1.35. sht_match_name usage
133
+   1.35. sht_iterator_setex usage
133 134
    1.36. sht_match_name usage
135
+   1.37. sht_match_name usage
134 136
 
135 137
 Chapter 1. Admin Guide
136 138
 
... ...
@@ -179,10 +181,11 @@ Chapter 1. Admin Guide
179 181
         4.13. sht_iterator_rm(iname)
180 182
         4.14. sht_iterator_sets(iname, sval)
181 183
         4.15. sht_iterator_seti(iname, ival)
182
-        4.16. sht_match_name(htable, op, mval)
183
-        4.17. sht_has_name(htable, op, mval)
184
-        4.18. sht_match_str_value(htable, op, mval)
185
-        4.19. sht_has_str_value(htable, op, mval)
184
+        4.16. sht_iterator_setex(iname, exval)
185
+        4.17. sht_match_name(htable, op, mval)
186
+        4.18. sht_has_name(htable, op, mval)
187
+        4.19. sht_match_str_value(htable, op, mval)
188
+        4.20. sht_has_str_value(htable, op, mval)
186 189
 
187 190
    5. Exported pseudo-variables
188 191
    6. RPC Commands
... ...
@@ -730,10 +733,11 @@ modparam("htable", "event_callback_mode", 1)
730 733
    4.13. sht_iterator_rm(iname)
731 734
    4.14. sht_iterator_sets(iname, sval)
732 735
    4.15. sht_iterator_seti(iname, ival)
733
-   4.16. sht_match_name(htable, op, mval)
734
-   4.17. sht_has_name(htable, op, mval)
735
-   4.18. sht_match_str_value(htable, op, mval)
736
-   4.19. sht_has_str_value(htable, op, mval)
736
+   4.16. sht_iterator_setex(iname, exval)
737
+   4.17. sht_match_name(htable, op, mval)
738
+   4.18. sht_has_name(htable, op, mval)
739
+   4.19. sht_match_str_value(htable, op, mval)
740
+   4.20. sht_has_str_value(htable, op, mval)
737 741
 
738 742
 4.1.  sht_print()
739 743
 
... ...
@@ -980,7 +984,23 @@ sht_iterator_end("i1");
980 984
     sht_iterator_end("i1");
981 985
 ...
982 986
 
983
-4.16.  sht_match_name(htable, op, mval)
987
+4.16.  sht_iterator_setex(iname, exval)
988
+
989
+   Set the expire of the current item to the integer in the exval.
990
+
991
+   The parameters can be dynamic strings or integers with variables.
992
+
993
+   This function can be used from ANY_ROUTE.
994
+
995
+   Example 1.35. sht_iterator_setex usage
996
+...
997
+    sht_iterator_start("i1", "h1");
998
+    sht_iterator_next("i1");
999
+    sht_iterator_setex("i1", "120");
1000
+    sht_iterator_end("i1");
1001
+...
1002
+
1003
+4.17.  sht_match_name(htable, op, mval)
984 1004
 
985 1005
    Return greater than 0 (true) if the htable has an item that matches the
986 1006
    name against the mval parameter.
... ...
@@ -995,18 +1015,18 @@ sht_iterator_end("i1");
995 1015
 
996 1016
    This function can be used from ANY_ROUTE.
997 1017
 
998
-   Example 1.35. sht_match_name usage
1018
+   Example 1.36. sht_match_name usage
999 1019
 ...
1000 1020
 if(sht_match_name("ha", "eq", "alice")) {
1001 1021
   ...
1002 1022
 }
1003 1023
 ...
1004 1024
 
1005
-4.17.  sht_has_name(htable, op, mval)
1025
+4.18.  sht_has_name(htable, op, mval)
1006 1026
 
1007 1027
    Alias for sht_match_name().
1008 1028
 
1009
-4.18.  sht_match_str_value(htable, op, mval)
1029
+4.19.  sht_match_str_value(htable, op, mval)
1010 1030
 
1011 1031
    Return greater than 0 (true) if the htable has an item that matches the
1012 1032
    string value against the mval parameter.
... ...
@@ -1021,14 +1041,14 @@ if(sht_match_name("ha", "eq", "alice")) {
1021 1041
 
1022 1042
    This function can be used from ANY_ROUTE.
1023 1043
 
1024
-   Example 1.36. sht_match_name usage
1044
+   Example 1.37. sht_match_name usage
1025 1045
 ...
1026 1046
 if(sht_match_str_value("ha", "eq", "alice")) {
1027 1047
   ...
1028 1048
 }
1029 1049
 ...
1030 1050
 
1031
-4.19.  sht_has_str_value(htable, op, mval)
1051
+4.20.  sht_has_str_value(htable, op, mval)
1032 1052
 
1033 1053
    Alias for sht_match_str_value().
1034 1054