Browse code

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

Kamailio Dev authored on 04/03/2020 09:46:17
Showing 4 changed files
... ...
@@ -36,16 +36,17 @@ Julien Chavanton
36 36
               3.3. acc_extra (string)
37 37
               3.4. acc_time_mode (integer)
38 38
               3.5. acc_time_format (str)
39
-              3.6. output_mqueue (integer)
40
-              3.7. output_syslog (integer)
39
+              3.6. acc_output_mqueue (integer)
40
+              3.7. acc_output_syslog (integer)
41 41
               3.8. acc_log_facility (integer)
42 42
               3.9. acc_log_level (integer)
43 43
               3.10. cdr_enable (str)
44 44
               3.11. cdr_extra (str)
45 45
               3.12. cdr_expired_dlg_enable (str)
46 46
               3.13. cdr_output_mqueue (integer)
47
-              3.14. cdr_log_facility (integer)
48
-              3.15. cdr_log_level (integer)
47
+              3.14. cdr_output_syslog (integer)
48
+              3.15. cdr_log_facility (integer)
49
+              3.16. cdr_log_level (integer)
49 50
 
50 51
    List of Examples
51 52
 
... ...
@@ -54,8 +55,8 @@ Julien Chavanton
54 55
    1.3. acc_extra example
55 56
    1.4. acc_time_mode example
56 57
    1.5. acc_time_format example
57
-   1.6. output_mqueue usage example
58
-   1.7. output_syslog example
58
+   1.6. acc_output_mqueue usage example
59
+   1.7. acc_output_syslog example
59 60
    1.8. acc_log_facility example
60 61
    1.9. acc_log_level example
61 62
    1.10. cdr_enable example
... ...
@@ -82,16 +83,17 @@ Chapter 1. Admin Guide
82 83
         3.3. acc_extra (string)
83 84
         3.4. acc_time_mode (integer)
84 85
         3.5. acc_time_format (str)
85
-        3.6. output_mqueue (integer)
86
-        3.7. output_syslog (integer)
86
+        3.6. acc_output_mqueue (integer)
87
+        3.7. acc_output_syslog (integer)
87 88
         3.8. acc_log_facility (integer)
88 89
         3.9. acc_log_level (integer)
89 90
         3.10. cdr_enable (str)
90 91
         3.11. cdr_extra (str)
91 92
         3.12. cdr_expired_dlg_enable (str)
92 93
         3.13. cdr_output_mqueue (integer)
93
-        3.14. cdr_log_facility (integer)
94
-        3.15. cdr_log_level (integer)
94
+        3.14. cdr_output_syslog (integer)
95
+        3.15. cdr_log_facility (integer)
96
+        3.16. cdr_log_level (integer)
95 97
 
96 98
 1. Overview
97 99
 
... ...
@@ -129,21 +131,22 @@ Chapter 1. Admin Guide
129 131
    3.3. acc_extra (string)
130 132
    3.4. acc_time_mode (integer)
131 133
    3.5. acc_time_format (str)
132
-   3.6. output_mqueue (integer)
133
-   3.7. output_syslog (integer)
134
+   3.6. acc_output_mqueue (integer)
135
+   3.7. acc_output_syslog (integer)
134 136
    3.8. acc_log_facility (integer)
135 137
    3.9. acc_log_level (integer)
136 138
    3.10. cdr_enable (str)
137 139
    3.11. cdr_extra (str)
138 140
    3.12. cdr_expired_dlg_enable (str)
139 141
    3.13. cdr_output_mqueue (integer)
140
-   3.14. cdr_log_facility (integer)
141
-   3.15. cdr_log_level (integer)
142
+   3.14. cdr_output_syslog (integer)
143
+   3.15. cdr_log_facility (integer)
144
+   3.16. cdr_log_level (integer)
142 145
 
143 146
 3.1. acc_flag (integer)
144 147
 
145 148
    Request flag which needs to be set to account a transaction in
146
-   acc_json. See output_mqueue and output_syslog
149
+   acc_json. See acc_output_mqueue and acc_output_syslog
147 150
 
148 151
    Default value is not-set (no flag).
149 152
 
... ...
@@ -155,7 +158,7 @@ modparam("acc_json", "acc_flag", 2)
155 158
 3.2. acc_missed_flag (integer)
156 159
 
157 160
    Request flag which needs to be set to account missed calls in acc_json.
158
-   See output_mqueue and output_syslog
161
+   See acc_output_mqueue and acc_output_syslog
159 162
 
160 163
    Default value is not-set (no flag).
161 164
 
... ...
@@ -205,7 +208,7 @@ modparam("acc_json", "acc_time_mode", 1)
205 208
 modparam("acc_json", "acc_time_format", "%Y/%m/%d %H:%M:%S")
206 209
 ...
207 210
 
208
-3.6. output_mqueue (integer)
211
+3.6. acc_output_mqueue (integer)
209 212
 
210 213
    Requires the mqueue module. The acc module will queue json acc events
211 214
    in the specified mqueue. Using a rtimer module exec you can access the
... ...
@@ -215,12 +218,12 @@ modparam("acc_json", "acc_time_format", "%Y/%m/%d %H:%M:%S")
215 218
 
216 219
    Default value is not-set mqueue will not be required.
217 220
 
218
-   Example 1.6. output_mqueue usage example
221
+   Example 1.6. acc_output_mqueue usage example
219 222
 ...
220 223
 # example using json_mqueue/http_client to publish to NSQD
221 224
 max_while_loops=100000
222 225
 modparam("mqueue", "mqueue", "name=acc_events;size=100000")
223
-modparam("acc_json", "output_mqueue", "acc_events")
226
+modparam("acc_json", "acc_output_mqueue", "acc_events")
224 227
 modparam("acc_json", "acc_flag", 2)
225 228
 modparam("acc_json", "acc_extra", "caller_ip_port=$avp(caller_ip_port);")
226 229
 modparam("rtimer", "timer", "name=nsqt;interval=1;mode=1;")
... ...
@@ -253,7 +256,7 @@ ts), "$var(nsq_res)");
253 256
 }
254 257
 ...
255 258
 
256
-3.7. output_syslog (integer)
259
+3.7. acc_output_syslog (integer)
257 260
 
258 261
    Control if the output of acc json should be sent to syslog. This is not
259 262
    dependent on Kamailio global logging settings, we can use syslog even
... ...
@@ -261,9 +264,9 @@ ts), "$var(nsq_res)");
261 264
 
262 265
    Default value is not-set (no flag).
263 266
 
264
-   Example 1.7. output_syslog example
267
+   Example 1.7. acc_output_syslog example
265 268
 ...
266
-modparam("acc_json", "output_syslog", 1)
269
+modparam("acc_json", "acc_output_syslog", 1)
267 270
 modparam("acc_json", "acc_log_level", 2)
268 271
 modparam("acc_json", "acc_log_facility", "LOG_DAEMON")
269 272
 ...
... ...
@@ -379,7 +382,11 @@ ts), "$var(nsq_res)");
379 382
 }
380 383
 ...
381 384
 
382
-3.14. cdr_log_facility (integer)
385
+3.14. cdr_output_syslog (integer)
386
+
387
+   The acc module will log json cdr events to syslog.
388
+
389
+3.15. cdr_log_facility (integer)
383 390
 
384 391
    Log facility to which accounting messages are issued to syslog. This
385 392
    allows to easily separate the accounting specific logging from the
... ...
@@ -399,7 +406,7 @@ modparam("acc_json", "cdr_log_facility", "LOG_LOCAL0")
399 406
 # local0.*                      /var/log/json_cdr.log
400 407
 ...
401 408
 
402
-3.15. cdr_log_level (integer)
409
+3.16. cdr_log_level (integer)
403 410
 
404 411
    Log level at which accounting messages are issued to syslog.
405 412
 
... ...
@@ -73,7 +73,7 @@ Daniel-Constantin Mierla
73 73
               3.44. dns_reuse_rcv_socket (boolean)
74 74
               3.45. xavp_contact (string)
75 75
               3.46. event_callback (str)
76
-              3.47. event_callback_lres (str)
76
+              3.47. event_callback_lres_sent (str)
77 77
               3.48. relay_100 (str)
78 78
               3.49. rich_redirect (int)
79 79
 
... ...
@@ -328,7 +328,7 @@ Chapter 1. Admin Guide
328 328
         3.44. dns_reuse_rcv_socket (boolean)
329 329
         3.45. xavp_contact (string)
330 330
         3.46. event_callback (str)
331
-        3.47. event_callback_lres (str)
331
+        3.47. event_callback_lres_sent (str)
332 332
         3.48. relay_100 (str)
333 333
         3.49. rich_redirect (int)
334 334
 
... ...
@@ -700,7 +700,7 @@ failure_route["serial"]
700 700
    3.44. dns_reuse_rcv_socket (boolean)
701 701
    3.45. xavp_contact (string)
702 702
    3.46. event_callback (str)
703
-   3.47. event_callback_lres (str)
703
+   3.47. event_callback_lres_sent (str)
704 704
    3.48. relay_100 (str)
705 705
    3.49. rich_redirect (int)
706 706
 
... ...
@@ -1632,7 +1632,7 @@ function ksr_tm_event(evname)
1632 1632
 end
1633 1633
 ...
1634 1634
 
1635
-3.47. event_callback_lres (str)
1635
+3.47. event_callback_lres_sent (str)
1636 1636
 
1637 1637
    The name of the function in the kemi configuration file (embedded
1638 1638
    scripting language such as Lua, Python, ...) to be executed instead of
... ...
@@ -57,37 +57,38 @@ Carsten Bock
57 57
               3.15. path_column (string)
58 58
               3.16. ruid_column (string)
59 59
               3.17. instance_column (string)
60
-              3.18. server_id_column (string)
61
-              3.19. connection_id_column (string)
62
-              3.20. keepalive_column (string)
63
-              3.21. partition_column (string)
64
-              3.22. use_domain (int)
65
-              3.23. desc_time_order (int)
66
-              3.24. timer_interval (int)
67
-              3.25. db_url (string)
68
-              3.26. db_mode (int)
69
-              3.27. db_load (int)
70
-              3.28. db_insert_update (int)
71
-              3.29. matching_mode (int)
72
-              3.30. cseq_delay (int)
73
-              3.31. fetch_rows (int)
74
-              3.32. hash_size (int)
75
-              3.33. preload (string)
76
-              3.34. db_update_as_insert (int)
77
-              3.35. db_check_update (int)
78
-              3.36. timer_procs (int)
79
-              3.37. xavp_contact (string)
80
-              3.38. db_ops_ruid (int)
81
-              3.39. handle_lost_tcp (int)
82
-              3.40. close_expired_tcp (int)
83
-              3.41. expires_type (int)
84
-              3.42. db_raw_fetch_type (int)
85
-              3.43. db_insert_null (int)
86
-              3.44. skip_remote_socket (int)
87
-              3.45. db_timer_clean (int)
88
-              3.46. rm_expired_delay (int)
89
-              3.47. server_id_filter (int)
90
-              3.48. version_table (int)
60
+              3.18. reg_id_column (string)
61
+              3.19. server_id_column (string)
62
+              3.20. connection_id_column (string)
63
+              3.21. keepalive_column (string)
64
+              3.22. partition_column (string)
65
+              3.23. use_domain (int)
66
+              3.24. desc_time_order (int)
67
+              3.25. timer_interval (int)
68
+              3.26. db_url (string)
69
+              3.27. db_mode (int)
70
+              3.28. db_load (int)
71
+              3.29. db_insert_update (int)
72
+              3.30. matching_mode (int)
73
+              3.31. cseq_delay (int)
74
+              3.32. fetch_rows (int)
75
+              3.33. hash_size (int)
76
+              3.34. preload (string)
77
+              3.35. db_update_as_insert (int)
78
+              3.36. db_check_update (int)
79
+              3.37. timer_procs (int)
80
+              3.38. xavp_contact (string)
81
+              3.39. db_ops_ruid (int)
82
+              3.40. handle_lost_tcp (int)
83
+              3.41. close_expired_tcp (int)
84
+              3.42. expires_type (int)
85
+              3.43. db_raw_fetch_type (int)
86
+              3.44. db_insert_null (int)
87
+              3.45. skip_remote_socket (int)
88
+              3.46. db_timer_clean (int)
89
+              3.47. rm_expired_delay (int)
90
+              3.48. server_id_filter (int)
91
+              3.49. version_table (int)
91 92
 
92 93
         4. RPC Commands
93 94
 
... ...
@@ -152,37 +153,38 @@ Carsten Bock
152 153
    1.15. Set path_column parameter
153 154
    1.16. Set ruid_column parameter
154 155
    1.17. Set instance_column parameter
155
-   1.18. Set server_id_column parameter
156
-   1.19. Set connection_id_column parameter
157
-   1.20. Set keepalive_column parameter
158
-   1.21. Set partitioncolumn parameter
159
-   1.22. Set use_domain parameter
160
-   1.23. Set desc_time_order parameter
161
-   1.24. Set timer_interval parameter
162
-   1.25. Set db_url parameter
163
-   1.26. Set db_mode parameter
164
-   1.27. Set db_load parameter
165
-   1.28. Set db_insert_update parameter
166
-   1.29. Set matching_mode parameter
167
-   1.30. Set cseq_delay parameter
168
-   1.31. Set fetch_rows parameter
169
-   1.32. Set hash_size parameter
170
-   1.33. Set preload parameter
171
-   1.34. Set db_update_as_insert parameter
172
-   1.35. Set db_check_update parameter
173
-   1.36. Set timer_procs parameter
174
-   1.37. Set xavp_contact parameter
175
-   1.38. Set db_ops_ruid parameter
176
-   1.39. Set handle_lost_tcp parameter
177
-   1.40. Set close_expired_tcp parameter
178
-   1.41. Set expires_type parameter
179
-   1.42. Set db_raw_fetch_type parameter
180
-   1.43. Set db_insert_null parameter
181
-   1.44. Set skip_remote_socket parameter
182
-   1.45. Set db_timer_clean parameter
183
-   1.46. Set rm_expired_delay parameter
184
-   1.47. Set server_id_filter parameter
185
-   1.48. version_table parameter usage
156
+   1.18. Set reg_id_column parameter
157
+   1.19. Set server_id_column parameter
158
+   1.20. Set connection_id_column parameter
159
+   1.21. Set keepalive_column parameter
160
+   1.22. Set partition_column parameter
161
+   1.23. Set use_domain parameter
162
+   1.24. Set desc_time_order parameter
163
+   1.25. Set timer_interval parameter
164
+   1.26. Set db_url parameter
165
+   1.27. Set db_mode parameter
166
+   1.28. Set db_load parameter
167
+   1.29. Set db_insert_update parameter
168
+   1.30. Set matching_mode parameter
169
+   1.31. Set cseq_delay parameter
170
+   1.32. Set fetch_rows parameter
171
+   1.33. Set hash_size parameter
172
+   1.34. Set preload parameter
173
+   1.35. Set db_update_as_insert parameter
174
+   1.36. Set db_check_update parameter
175
+   1.37. Set timer_procs parameter
176
+   1.38. Set xavp_contact parameter
177
+   1.39. Set db_ops_ruid parameter
178
+   1.40. Set handle_lost_tcp parameter
179
+   1.41. Set close_expired_tcp parameter
180
+   1.42. Set expires_type parameter
181
+   1.43. Set db_raw_fetch_type parameter
182
+   1.44. Set db_insert_null parameter
183
+   1.45. Set skip_remote_socket parameter
184
+   1.46. Set db_timer_clean parameter
185
+   1.47. Set rm_expired_delay parameter
186
+   1.48. Set server_id_filter parameter
187
+   1.49. version_table parameter usage
186 188
 
187 189
 Chapter 1. Admin Guide
188 190
 
... ...
@@ -216,37 +218,38 @@ Chapter 1. Admin Guide
216 218
         3.15. path_column (string)
217 219
         3.16. ruid_column (string)
218 220
         3.17. instance_column (string)
219
-        3.18. server_id_column (string)
220
-        3.19. connection_id_column (string)
221
-        3.20. keepalive_column (string)
222
-        3.21. partition_column (string)
223
-        3.22. use_domain (int)
224
-        3.23. desc_time_order (int)
225
-        3.24. timer_interval (int)
226
-        3.25. db_url (string)
227
-        3.26. db_mode (int)
228
-        3.27. db_load (int)
229
-        3.28. db_insert_update (int)
230
-        3.29. matching_mode (int)
231
-        3.30. cseq_delay (int)
232
-        3.31. fetch_rows (int)
233
-        3.32. hash_size (int)
234
-        3.33. preload (string)
235
-        3.34. db_update_as_insert (int)
236
-        3.35. db_check_update (int)
237
-        3.36. timer_procs (int)
238
-        3.37. xavp_contact (string)
239
-        3.38. db_ops_ruid (int)
240
-        3.39. handle_lost_tcp (int)
241
-        3.40. close_expired_tcp (int)
242
-        3.41. expires_type (int)
243
-        3.42. db_raw_fetch_type (int)
244
-        3.43. db_insert_null (int)
245
-        3.44. skip_remote_socket (int)
246
-        3.45. db_timer_clean (int)
247
-        3.46. rm_expired_delay (int)
248
-        3.47. server_id_filter (int)
249
-        3.48. version_table (int)
221
+        3.18. reg_id_column (string)
222
+        3.19. server_id_column (string)
223
+        3.20. connection_id_column (string)
224
+        3.21. keepalive_column (string)
225
+        3.22. partition_column (string)
226
+        3.23. use_domain (int)
227
+        3.24. desc_time_order (int)
228
+        3.25. timer_interval (int)
229
+        3.26. db_url (string)
230
+        3.27. db_mode (int)
231
+        3.28. db_load (int)
232
+        3.29. db_insert_update (int)
233
+        3.30. matching_mode (int)
234
+        3.31. cseq_delay (int)
235
+        3.32. fetch_rows (int)
236
+        3.33. hash_size (int)
237
+        3.34. preload (string)
238
+        3.35. db_update_as_insert (int)
239
+        3.36. db_check_update (int)
240
+        3.37. timer_procs (int)
241
+        3.38. xavp_contact (string)
242
+        3.39. db_ops_ruid (int)
243
+        3.40. handle_lost_tcp (int)
244
+        3.41. close_expired_tcp (int)
245
+        3.42. expires_type (int)
246
+        3.43. db_raw_fetch_type (int)
247
+        3.44. db_insert_null (int)
248
+        3.45. skip_remote_socket (int)
249
+        3.46. db_timer_clean (int)
250
+        3.47. rm_expired_delay (int)
251
+        3.48. server_id_filter (int)
252
+        3.49. version_table (int)
250 253
 
251 254
    4. RPC Commands
252 255
 
... ...
@@ -305,7 +308,7 @@ Chapter 1. Admin Guide
305 308
        check the Call-ID only (independent of the Contact-Header or Path).
306 309
 
307 310
    To find out how to control/select the contact matching algorithm,
308
-   please see the module parameter matching_mode - Section 3.29,
311
+   please see the module parameter matching_mode - Section 3.30,
309 312
    “matching_mode (int)”.
310 313
 
311 314
 2. Dependencies
... ...
@@ -343,37 +346,38 @@ Chapter 1. Admin Guide
343 346
    3.15. path_column (string)
344 347
    3.16. ruid_column (string)
345 348
    3.17. instance_column (string)
346
-   3.18. server_id_column (string)
347
-   3.19. connection_id_column (string)
348
-   3.20. keepalive_column (string)
349
-   3.21. partition_column (string)
350
-   3.22. use_domain (int)
351
-   3.23. desc_time_order (int)
352
-   3.24. timer_interval (int)
353
-   3.25. db_url (string)
354
-   3.26. db_mode (int)
355
-   3.27. db_load (int)
356
-   3.28. db_insert_update (int)
357
-   3.29. matching_mode (int)
358
-   3.30. cseq_delay (int)
359
-   3.31. fetch_rows (int)
360
-   3.32. hash_size (int)
361
-   3.33. preload (string)
362
-   3.34. db_update_as_insert (int)
363
-   3.35. db_check_update (int)
364
-   3.36. timer_procs (int)
365
-   3.37. xavp_contact (string)
366
-   3.38. db_ops_ruid (int)
367
-   3.39. handle_lost_tcp (int)
368
-   3.40. close_expired_tcp (int)
369
-   3.41. expires_type (int)
370
-   3.42. db_raw_fetch_type (int)
371
-   3.43. db_insert_null (int)
372
-   3.44. skip_remote_socket (int)
373
-   3.45. db_timer_clean (int)
374
-   3.46. rm_expired_delay (int)
375
-   3.47. server_id_filter (int)
376
-   3.48. version_table (int)
349
+   3.18. reg_id_column (string)
350
+   3.19. server_id_column (string)
351
+   3.20. connection_id_column (string)
352
+   3.21. keepalive_column (string)
353
+   3.22. partition_column (string)
354
+   3.23. use_domain (int)
355
+   3.24. desc_time_order (int)
356
+   3.25. timer_interval (int)
357
+   3.26. db_url (string)
358
+   3.27. db_mode (int)
359
+   3.28. db_load (int)
360
+   3.29. db_insert_update (int)
361
+   3.30. matching_mode (int)
362
+   3.31. cseq_delay (int)
363
+   3.32. fetch_rows (int)
364
+   3.33. hash_size (int)
365
+   3.34. preload (string)
366
+   3.35. db_update_as_insert (int)
367
+   3.36. db_check_update (int)
368
+   3.37. timer_procs (int)
369
+   3.38. xavp_contact (string)
370
+   3.39. db_ops_ruid (int)
371
+   3.40. handle_lost_tcp (int)
372
+   3.41. close_expired_tcp (int)
373
+   3.42. expires_type (int)
374
+   3.43. db_raw_fetch_type (int)
375
+   3.44. db_insert_null (int)
376
+   3.45. skip_remote_socket (int)
377
+   3.46. db_timer_clean (int)
378
+   3.47. rm_expired_delay (int)
379
+   3.48. server_id_filter (int)
380
+   3.49. version_table (int)
377 381
 
378 382
 3.1. nat_bflag (int)
379 383
 
... ...
@@ -567,52 +571,63 @@ modparam("usrloc", "ruid_column", "myruid")
567 571
 modparam("usrloc", "instance_column", "myinstance")
568 572
 ...
569 573
 
570
-3.18. server_id_column (string)
574
+3.18. reg_id_column (string)
575
+
576
+   Name of database table column containing the value for reg-id.
577
+
578
+   Default value is “reg_id”.
579
+
580
+   Example 1.18. Set reg_id_column parameter
581
+...
582
+modparam("usrloc", "reg_id_column", "r_id")
583
+...
584
+
585
+3.19. server_id_column (string)
571 586
 
572 587
    Name of database table column containing the value for server id.
573 588
 
574 589
    Default value is “server_id”.
575 590
 
576
-   Example 1.18. Set server_id_column parameter
591
+   Example 1.19. Set server_id_column parameter
577 592
 ...
578 593
 modparam("usrloc", "server_id_column", "srv_id")
579 594
 ...
580 595
 
581
-3.19. connection_id_column (string)
596
+3.20. connection_id_column (string)
582 597
 
583 598
    Name of database table column containing the value for connection id.
584 599
 
585 600
    Default value is “connection_id”.
586 601
 
587
-   Example 1.19. Set connection_id_column parameter
602
+   Example 1.20. Set connection_id_column parameter
588 603
 ...
589 604
 modparam("usrloc", "connection_id_column", "con_id")
590 605
 ...
591 606
 
592
-3.20. keepalive_column (string)
607
+3.21. keepalive_column (string)
593 608
 
594 609
    Name of database table column containing the value for keepalive
595 610
    status.
596 611
 
597 612
    Default value is “keepalive”.
598 613
 
599
-   Example 1.20. Set keepalive_column parameter
614
+   Example 1.21. Set keepalive_column parameter
600 615
 ...
601 616
 modparam("usrloc", "keepalive_column", "kalive")
602 617
 ...
603 618
 
604
-3.21. partition_column (string)
619
+3.22. partition_column (string)
605 620
 
606 621
    Name of database table column containing the value for partition id.
607 622
 
608 623
    Default value is “partition”.
609 624
 
610
-   Example 1.21. Set partitioncolumn parameter
625
+   Example 1.22. Set partition_column parameter
611 626
 ...
612 627
 modparam("usrloc", "partition_column", "part")
613 628
 ...
614 629
 
615
-3.22. use_domain (int)
630
+3.23. use_domain (int)
616 631
 
617 632
    If the domain part of the user should be also saved and used for
618 633
    identifying the user (along with the username part). Useful in multi
... ...
@@ -620,24 +635,24 @@ modparam("usrloc", "partition_column", "part")
620 635
 
621 636
    Default value is “0 (false)”.
622 637
 
623
-   Example 1.22. Set use_domain parameter
638
+   Example 1.23. Set use_domain parameter
624 639
 ...
625 640
 modparam("usrloc", "use_domain", 1)
626 641
 ...
627 642
 
628
-3.23. desc_time_order (int)
643
+3.24. desc_time_order (int)
629 644
 
630 645
    If the user's contacts should be kept timestamp ordered; otherwise the
631 646
    contact will be ordered based on q value. Non 0 value means true.
632 647
 
633 648
    Default value is “0 (false)”.
634 649
 
635
-   Example 1.23. Set desc_time_order parameter
650
+   Example 1.24. Set desc_time_order parameter
636 651
 ...
637 652
 modparam("usrloc", "desc_time_order", 1)
638 653
 ...
639 654
 
640
-3.24. timer_interval (int)
655
+3.25. timer_interval (int)
641 656
 
642 657
    Number of seconds between two timer runs. The module uses a timer to
643 658
    delete expired contacts, synchronize with database and other tasks,
... ...
@@ -645,23 +660,23 @@ modparam("usrloc", "desc_time_order", 1)
645 660
 
646 661
    Default value is 60.
647 662
 
648
-   Example 1.24. Set timer_interval parameter
663
+   Example 1.25. Set timer_interval parameter
649 664
 ...
650 665
 modparam("usrloc", "timer_interval", 120)
651 666
 ...
652 667
 
653
-3.25. db_url (string)
668
+3.26. db_url (string)
654 669
 
655 670
    URL of the database that should be used.
656 671
 
657 672
    Default value is “mysql://kamailio:kamailiorw@localhost/kamailio”.
658 673
 
659
-   Example 1.25. Set db_url parameter
674
+   Example 1.26. Set db_url parameter
660 675
 ...
661 676
 modparam("usrloc", "db_url", "dbdriver://username:password@dbhost/dbname")
662 677
 ...
663 678
 
664
-3.26. db_mode (int)
679
+3.27. db_mode (int)
665 680
 
666 681
    The usrloc module can utilize a database for persistent contact
667 682
    storage. If a database is used, the location database (contacts) will
... ...
@@ -707,12 +722,12 @@ Warning
707 722
 
708 723
    Default value is 0.
709 724
 
710
-   Example 1.26. Set db_mode parameter
725
+   Example 1.27. Set db_mode parameter
711 726
 ...
712 727
 modparam("usrloc", "db_mode", 2)
713 728
 ...
714 729
 
715
-3.27. db_load (int)
730
+3.28. db_load (int)
716 731
 
717 732
    Determine if the usrloc module should load contacts from the database
718 733
    storage during module initialization A value of 0 disable the loading
... ...
@@ -720,12 +735,12 @@ modparam("usrloc", "db_mode", 2)
720 735
 
721 736
    Default value is 1.
722 737
 
723
-   Example 1.27. Set db_load parameter
738
+   Example 1.28. Set db_load parameter
724 739
 ...
725 740
 modparam("usrloc", "db_load", 0)
726 741
 ...
727 742
 
728
-3.28. db_insert_update (int)
743
+3.29. db_insert_update (int)
729 744
 
730 745
    Determine if the usrloc module should do an update when a duplicate key
731 746
    is found while inserting A value of 1 will activate update on duplicate
... ...
@@ -733,12 +748,12 @@ modparam("usrloc", "db_load", 0)
733 748
 
734 749
    Default value is 0.
735 750
 
736
-   Example 1.28. Set db_insert_update parameter
751
+   Example 1.29. Set db_insert_update parameter
737 752
 ...
738 753
 modparam("usrloc", "db_insert_update", 1)
739 754
 ...
740 755
 
741
-3.29. matching_mode (int)
756
+3.30. matching_mode (int)
742 757
 
743 758
    What contact matching algorithm to be used. Refer to section ??? for
744 759
    the description of the algorithms.
... ...
@@ -754,12 +769,12 @@ modparam("usrloc", "db_insert_update", 1)
754 769
 
755 770
    Default value is 0 (CONTACT_ONLY).
756 771
 
757
-   Example 1.29. Set matching_mode parameter
772
+   Example 1.30. Set matching_mode parameter
758 773
 ...
759 774
 modparam("usrloc", "matching_mode", 1)
760 775
 ...
761 776
 
762
-3.30. cseq_delay (int)
777
+3.31. cseq_delay (int)
763 778
 
764 779
    Delay (in seconds) for accepting as retransmissions register requests
765 780
    with same Call-ID and Cseq. The delay is calculated starting from the
... ...
@@ -773,12 +788,12 @@ modparam("usrloc", "matching_mode", 1)
773 788
 
774 789
    Default value is “20 seconds”.
775 790
 
776
-   Example 1.30. Set cseq_delay parameter
791
+   Example 1.31. Set cseq_delay parameter
777 792
 ...
778 793
 modparam("usrloc", "cseq_delay", 5)
779 794
 ...
780 795
 
781
-3.31. fetch_rows (int)
796
+3.32. fetch_rows (int)
782 797
 
783 798
    The number of the rows to be fetched at once from database when loading
784 799
    the location records. This value can be used to tune the load time at
... ...
@@ -787,12 +802,12 @@ modparam("usrloc", "cseq_delay", 5)
787 802
 
788 803
    Default value is “2000”.
789 804
 
790
-   Example 1.31. Set fetch_rows parameter
805
+   Example 1.32. Set fetch_rows parameter
791 806
 ...
792 807
 modparam("usrloc", "fetch_rows", 3000)
793 808
 ...
794 809
 
795
-3.32. hash_size (int)
810
+3.33. hash_size (int)
796 811
 
797 812
    The number of entries of the hash table used by usrloc to store the
798 813
    location records is 2^hash_size. For hash_size=4, the number of slots
... ...
@@ -800,12 +815,12 @@ modparam("usrloc", "fetch_rows", 3000)
800 815
 
801 816
    Default value is “10” (1024 slots).
802 817
 
803
-   Example 1.32. Set hash_size parameter
818
+   Example 1.33. Set hash_size parameter
804 819
 ...
805 820
 modparam("usrloc", "hash_size", 12)
806 821
 ...
807 822
 
808
-3.33. preload (string)
823
+3.34. preload (string)
809 824
 
810 825
    Preload location table given as value. A location table is loaded based
811 826
    on fixup of registrar functions, therefore you need to use this
... ...
@@ -814,12 +829,12 @@ modparam("usrloc", "hash_size", 12)
814 829
 
815 830
    Default value is “NULL”.
816 831
 
817
-   Example 1.33. Set preload parameter
832
+   Example 1.34. Set preload parameter
818 833
 ...
819 834
 modparam("usrloc", "preload", "location")
820 835
 ...
821 836
 
822
-3.34. db_update_as_insert (int)
837
+3.35. db_update_as_insert (int)
823 838
 
824 839
    Set this parameter if you want to do INSERT DB operations instead of
825 840
    UPDATE DB operations. It is recommended to set this parameter if you
... ...
@@ -827,12 +842,12 @@ modparam("usrloc", "preload", "location")
827 842
 
828 843
    Default value is “0”.
829 844
 
830
-   Example 1.34. Set db_update_as_insert parameter
845
+   Example 1.35. Set db_update_as_insert parameter
831 846
 ...
832 847
 modparam("usrloc", "db_update_as_insert", 1)
833 848
 ...
834 849
 
835
-3.35. db_check_update (int)
850
+3.36. db_check_update (int)
836 851
 
837 852
    Set this parameter to 1 if you want to do DB INSERT if the number of
838 853
    affected rows by contact DB UPDATE operation is 0. The database module
... ...
@@ -842,32 +857,31 @@ modparam("usrloc", "db_update_as_insert", 1)
842 857
 
843 858
    Default value is “0” (no DB INSERT).
844 859
 
845
-   Example 1.35. Set db_check_update parameter
860
+   Example 1.36. Set db_check_update parameter
846 861
 ...
847 862
 modparam("usrloc", "db_check_update", 1)
848 863
 ...
849 864
 
850
-3.36. timer_procs (int)
865
+3.37. timer_procs (int)
851 866
 
852 867
    Number of timer processes to be started by module. Timer processes take
853 868
    care of checking expired records and synchronization with database. If
854 869
    set to 0, no dedicated timer is started, the one from core will be
855 870
    used.
856 871
 
857
-   If the number of timer processes is greater than 1, the workload 
858
-   of synchronization and record expiration is split up among the 
859
-   multiple processes. (Each process is assigned a range of slots 
860
-   from the internal hash table, and is responsible for cleanup and
861
-   storage on those slots.)
872
+   If the number of timer processes is greater than 1, the workload of
873
+   synchronization and record expiration is split up among the multiple
874
+   processes. (Each process is assigned a range of slots from the internal
875
+   hash table, and is responsible for cleanup and storage on those slots.)
862 876
 
863 877
    Default value is “0”.
864 878
 
865
-   Example 1.36. Set timer_procs parameter
879
+   Example 1.37. Set timer_procs parameter
866 880
 ...
867 881
 modparam("usrloc", "timer_procs", 4)
868 882
 ...
869 883
 
870
-3.37. xavp_contact (string)
884
+3.38. xavp_contact (string)
871 885
 
872 886
    The name of XAVP storing the attributes per contact. They are saved in
873 887
    location record and restored at lookup. The tm module parameter
... ...
@@ -876,12 +890,12 @@ modparam("usrloc", "timer_procs", 4)
876 890
 
877 891
    Default value is “NULL”.
878 892
 
879
-   Example 1.37. Set xavp_contact parameter
893
+   Example 1.38. Set xavp_contact parameter
880 894
 ...
881 895
 modparam("tm|usrloc", "xavp_contact", "ulattrs")
882 896
 ...
883 897
 
884
-3.38. db_ops_ruid (int)
898
+3.39. db_ops_ruid (int)
885 899
 
886 900
    If set to 1, database queries for update or delete are done using ruid
887 901
    value. If it is set to 0, the old style using aor, contact and call-id
... ...
@@ -889,12 +903,12 @@ modparam("tm|usrloc", "xavp_contact", "ulattrs")
889 903
 
890 904
    Default value is “1”.
891 905
 
892
-   Example 1.38. Set db_ops_ruid parameter
906
+   Example 1.39. Set db_ops_ruid parameter
893 907
 ...
894 908
 modparam("usrloc", "db_ops_ruid", 0)
895 909
 ...
896 910
 
897
-3.39. handle_lost_tcp (int)
911
+3.40. handle_lost_tcp (int)
898 912
 
899 913
    If set to 1, Kamailio will remove location records made via
900 914
    TCP/TLS/WS/WSS transports when it looses corresponding tcp connections.
... ...
@@ -902,24 +916,24 @@ modparam("usrloc", "db_ops_ruid", 0)
902 916
 
903 917
    Default value is “0”.
904 918
 
905
-   Example 1.39. Set handle_lost_tcp parameter
919
+   Example 1.40. Set handle_lost_tcp parameter
906 920
 ...
907 921
 modparam("usrloc", "handle_lost_tcp", 1)
908 922
 ...
909 923
 
910
-3.40. close_expired_tcp (int)
924
+3.41. close_expired_tcp (int)
911 925
 
912 926
    If set to 1, Kamailio will close the TCP connection when a contact has
913 927
    expired, if the corresponding transport is TCP/TLS/WS/WSS.
914 928
 
915 929
    Default value is “0”.
916 930
 
917
-   Example 1.40. Set close_expired_tcp parameter
931
+   Example 1.41. Set close_expired_tcp parameter
918 932
 ...
919 933
 modparam("usrloc", "close_expired_tcp", 1)
920 934
 ...
921 935
 
922
-3.41. expires_type (int)
936
+3.42. expires_type (int)
923 937
 
924 938
    If set to 1, Kamailio expects to deal with BIGINT type on database
925 939
    columns for expires and last modified values. It allows to handle
... ...
@@ -929,12 +943,12 @@ modparam("usrloc", "close_expired_tcp", 1)
929 943
 
930 944
    Default value is “0”.
931 945
 
932
-   Example 1.41. Set expires_type parameter
946
+   Example 1.42. Set expires_type parameter
933 947
 ...
934 948
 modparam("usrloc", "expires_type", 1)
935 949
 ...
936 950
 
937
-3.42. db_raw_fetch_type (int)
951
+3.43. db_raw_fetch_type (int)
938 952
 
939 953
    This affect DB-only mode and controls what kind of raw query is used to
940 954
    fetch the contacts from database for specific needs (e.g., sending NAT
... ...
@@ -944,12 +958,12 @@ modparam("usrloc", "expires_type", 1)
944 958
 
945 959
    Default value is “0”.
946 960
 
947
-   Example 1.42. Set db_raw_fetch_type parameter
961
+   Example 1.43. Set db_raw_fetch_type parameter
948 962
 ...
949 963
 modparam("usrloc", "db_raw_fetch_type", 1)
950 964
 ...
951 965
 
952
-3.43. db_insert_null (int)
966
+3.44. db_insert_null (int)
953 967
 
954 968
    If set to 1, the insert operation to database will add null values in
955 969
    the statement. It has to be set to 1 for the database systems that do
... ...
@@ -962,12 +976,12 @@ modparam("usrloc", "db_raw_fetch_type", 1)
962 976
 
963 977
    Default value is “0” (don't add null fields in insert statement).
964 978
 
965
-   Example 1.43. Set db_insert_null parameter
979
+   Example 1.44. Set db_insert_null parameter
966 980
 ...
967 981
 modparam("usrloc", "db_insert_null", 1)
968 982
 ...
969 983
 
970
-3.44. skip_remote_socket (int)
984
+3.45. skip_remote_socket (int)
971 985
 
972 986
    If set to 1, Kamailio will skip location record when loading from
973 987
    database, if socket value of the record does not in kamailio listening
... ...
@@ -975,12 +989,12 @@ modparam("usrloc", "db_insert_null", 1)
975 989
 
976 990
    Default value is “0”.
977 991
 
978
-   Example 1.44. Set skip_remote_socket parameter
992
+   Example 1.45. Set skip_remote_socket parameter
979 993
 ...
980 994
 modparam("usrloc", "skip_remote_socket", 1)
981 995
 ...
982 996
 
983
-3.45. db_timer_clean (int)
997
+3.46. db_timer_clean (int)
984 998
 
985 999
    Enable (1) or disable (0) cleaning of expired db records on timer basis
986 1000
    for db_mode WRITE-BACK and WRITE-THROUGH. It uses the secondary timer
... ...
@@ -988,24 +1002,24 @@ modparam("usrloc", "skip_remote_socket", 1)
988 1002
 
989 1003
    Default value is “0”.
990 1004
 
991
-   Example 1.45. Set db_timer_clean parameter
1005
+   Example 1.46. Set db_timer_clean parameter
992 1006
 ...
993 1007
 modparam("usrloc", "db_timer_clean", 1)
994 1008
 ...
995 1009
 
996
-3.46. rm_expired_delay (int)
1010
+3.47. rm_expired_delay (int)
997 1011
 
998 1012
    Specify the number of seconds to delay the removal of expired records.
999 1013
    For now it works for DB_ONLY mode (db_mode=3).
1000 1014
 
1001 1015
    Default value is “0”.
1002 1016
 
1003
-   Example 1.46. Set rm_expired_delay parameter
1017
+   Example 1.47. Set rm_expired_delay parameter
1004 1018
 ...
1005 1019
 modparam("usrloc", "rm_expired_delay", 30)
1006 1020
 ...
1007 1021
 
1008
-3.47. server_id_filter (int)
1022
+3.48. server_id_filter (int)
1009 1023
 
1010 1024
    Enable (1) or disable (0) filter records by server_id on load and
1011 1025
    during cleaning of expired db records. It could be useful when you want
... ...
@@ -1016,19 +1030,19 @@ modparam("usrloc", "rm_expired_delay", 30)
1016 1030
 
1017 1031
    Default value is “0”.
1018 1032
 
1019
-   Example 1.47. Set server_id_filter parameter
1033
+   Example 1.48. Set server_id_filter parameter
1020 1034
 ...
1021 1035
 modparam("usrloc", "server_id_filter", 1)
1022 1036
 ...
1023 1037
 
1024
-3.48. version_table (int)
1038
+3.49. version_table (int)
1025 1039
 
1026 1040
    If set to 0, the module will skip checking the version for location
1027 1041
    table.
1028 1042
 
1029 1043
    Default value is “1 (check for table version)”.
1030 1044
 
1031
-   Example 1.48. version_table parameter usage
1045
+   Example 1.49. version_table parameter usage
1032 1046
 ...
1033 1047
 modparam("usrloc", "version_table", 0)
1034 1048
 ...
... ...
@@ -73,7 +73,7 @@ Peter Dunkley
73 73
    1.10. Set verbose_list parameter
74 74
    1.11. Set event_callback parameter
75 75
    1.12. Set timer_intervalparameter
76
-   1.13. Set rm_timer_intervalparameter
76
+   1.13. Set rm_delay_intervalparameter
77 77
    1.14. ws_handle_handshake usage
78 78
    1.15. ws_close usage
79 79
    1.16. event_route[websocket:closed] usage
... ...
@@ -511,7 +511,7 @@ modparam("websocket", "timer_interval", 5)
511 511
 
512 512
    Default value is 5.
513 513
 
514
-   Example 1.13. Set rm_timer_intervalparameter
514
+   Example 1.13. Set rm_delay_intervalparameter
515 515
 ...
516 516
 modparam("websocket", "rm_delay_interval", 2)
517 517
 ...