Browse code

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

Kamailio Dev authored on 11/09/2020 20:16:12
Showing 1 changed files
... ...
@@ -94,8 +94,9 @@ Carsten Bock
94 94
               3.52. ka_from (str)
95 95
               3.53. ka_domain (str)
96 96
               3.54. ka_filter (int)
97
-              3.55. ka_loglevel (int)
98
-              3.56. ka_logmsg (str)
97
+              3.55. ka_timeout (int)
98
+              3.56. ka_loglevel (int)
99
+              3.57. ka_logmsg (str)
99 100
 
100 101
         4. RPC Commands
101 102
 
... ...
@@ -197,8 +198,9 @@ Carsten Bock
197 198
    1.52. ka_from parameter usage
198 199
    1.53. ka_domain parameter usage
199 200
    1.54. ka_filter parameter usage
200
-   1.55. ka_loglevel parameter usage
201
-   1.56. ka_logmsg parameter usage
201
+   1.55. Set ka_timeout parameter
202
+   1.56. ka_loglevel parameter usage
203
+   1.57. ka_logmsg parameter usage
202 204
 
203 205
 Chapter 1. Admin Guide
204 206
 
... ...
@@ -269,8 +271,9 @@ Chapter 1. Admin Guide
269 271
         3.52. ka_from (str)
270 272
         3.53. ka_domain (str)
271 273
         3.54. ka_filter (int)
272
-        3.55. ka_loglevel (int)
273
-        3.56. ka_logmsg (str)
274
+        3.55. ka_timeout (int)
275
+        3.56. ka_loglevel (int)
276
+        3.57. ka_logmsg (str)
274 277
 
275 278
    4. RPC Commands
276 279
 
... ...
@@ -404,8 +407,9 @@ Chapter 1. Admin Guide
404 407
    3.52. ka_from (str)
405 408
    3.53. ka_domain (str)
406 409
    3.54. ka_filter (int)
407
-   3.55. ka_loglevel (int)
408
-   3.56. ka_logmsg (str)
410
+   3.55. ka_timeout (int)
411
+   3.56. ka_loglevel (int)
412
+   3.57. ka_logmsg (str)
409 413
 
410 414
 3.1. nat_bflag (int)
411 415
 
... ...
@@ -683,8 +687,8 @@ modparam("usrloc", "desc_time_order", 1)
683 687
 3.25. timer_interval (int)
684 688
 
685 689
    Number of seconds between two timer runs. The module uses a timer to
686
-   delete expired contacts, synchronize with database and other tasks,
687
-   that need to be run periodically.
690
+   delete expired contacts, synchronize with database, send keepalives and
691
+   other tasks, that need to be run periodically.
688 692
 
689 693
    Default value is 60.
690 694
 
... ...
@@ -1163,19 +1167,38 @@ modparam("usrloc", "ka_domain", "mydomain.com")
1163 1167
 modparam("usrloc", "ka_filter", 1)
1164 1168
 ...
1165 1169
 
1166
-3.55. ka_loglevel (int)
1170
+3.55. ka_timeout (int)
1171
+
1172
+   The parameter sets the interval in seconds after which a contact is
1173
+   removed from location table if it does not reply to SIP keepalives
1174
+   (usually OPTIONS ping requests).
1175
+
1176
+   The features is available only for contacts that are stored in memory
1177
+   (not working for db only mode of the usrloc module).
1178
+
1179
+   Keepalives are sent stateless, not using TM module. The value of this
1180
+   parameter has to be few times higher than timer interval.
1181
+
1182
+   Default value is “0” (feature disabled).
1183
+
1184
+   Example 1.55. Set ka_timeout parameter
1185
+...
1186
+modparam("usrloc", "ka_timeout", 120)
1187
+...
1188
+
1189
+3.56. ka_loglevel (int)
1167 1190
 
1168 1191
    The level to print the log message when the keepalive response is
1169 1192
    received. It should be a value between -5 (L_ALERT) and 3 (L_DBG).
1170 1193
 
1171 1194
    Default value is “255” (disabled).
1172 1195
 
1173
-   Example 1.55. ka_loglevel parameter usage
1196
+   Example 1.56. ka_loglevel parameter usage
1174 1197
 ...
1175 1198
 modparam("usrloc", "ka_loglevel", 1)
1176 1199
 ...
1177 1200
 
1178
-3.56. ka_logmsg (str)
1201
+3.57. ka_logmsg (str)
1179 1202
 
1180 1203
    The formatted log specification to be added to the message printed when
1181 1204
    the keepalive is received and roundtrip time is computed. The log
... ...
@@ -1187,7 +1210,7 @@ modparam("usrloc", "ka_loglevel", 1)
1187 1210
 
1188 1211
    Default value is “ to-uri: [$tu] remote-addr: [$sas]”.
1189 1212
 
1190
-   Example 1.56. ka_logmsg parameter usage
1213
+   Example 1.57. ka_logmsg parameter usage
1191 1214
 ...
1192 1215
 modparam("usrloc", "ka_logmsg", " to-uri: [$tu] remote-addr: [$sas]")
1193 1216
 ...