Browse code

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

Kamailio Dev authored on 16/07/2019 09:23:08
Showing 9 changed files
... ...
@@ -22,8 +22,6 @@ Bogdan-Andrei Iancu
22 22
    Voice Sistem SRL
23 23
    <bogdan@voice-system.ro>
24 24
 
25
-Edited by
26
-
27 25
 Sven Knoblich
28 26
 
29 27
    1&1 Internet AG
... ...
@@ -849,6 +847,13 @@ modparam("acc", "log_flag", 2)
849 847
 6.11. log_missed_flag (integer)
850 848
 
851 849
    Request flag which needs to be set to account missed calls via syslog.
850
+   This can be used to e.g. account failures during the call setup phase
851
+   from the callee side, for example if you do forking to several
852
+   destinations.
853
+
854
+   Keep in mind that this flag is reset after processing. Therefore it is
855
+   necessary to set it again e.g. in a failure_route if you do serial
856
+   forking and want to log all attempts.
852 857
 
853 858
    Default value is not-set (no flag).
854 859
 
... ...
@@ -1464,52 +1469,52 @@ Chapter 2. Frequently Asked Questions
1464 1469
 
1465 1470
    2.1.
1466 1471
 
1467
-       What happened with old log_fmt parameter
1472
+   What happened with old log_fmt parameter
1468 1473
 
1469
-       The parameter became obsolete with the restructure of the data logged
1470
-       by ACC module (refer to the Overview chapter). For similar behaviour
1471
-       you can use the extra accounting (see the corresponding chapter).
1474
+   The parameter became obsolete with the restructure of the data logged
1475
+   by ACC module (refer to the Overview chapter). For similar behaviour
1476
+   you can use the extra accounting (see the corresponding chapter).
1472 1477
 
1473 1478
    2.2.
1474 1479
 
1475
-       What happened with old multi_leg_enabled parameter
1480
+   What happened with old multi_leg_enabled parameter
1476 1481
 
1477
-       The parameter became obsolete by the addition of the new multi_leg_info
1478
-       parameter. The multi-leg accounting is automatically enabled when
1479
-       multi_leg_info is defined.
1482
+   The parameter became obsolete by the addition of the new multi_leg_info
1483
+   parameter. The multi-leg accounting is automatically enabled when
1484
+   multi_leg_info is defined.
1480 1485
 
1481 1486
    2.3.
1482 1487
 
1483
-       What happened with old src_leg_avp_id and dst_leg_avp_id parameters
1488
+   What happened with old src_leg_avp_id and dst_leg_avp_id parameters
1484 1489
 
1485
-       The parameter was replaced by the more generic new parameter
1486
-       multi_leg_info. This allows logging (per-leg) of more information than
1487
-       just dst and src.
1490
+   The parameter was replaced by the more generic new parameter
1491
+   multi_leg_info. This allows logging (per-leg) of more information than
1492
+   just dst and src.
1488 1493
 
1489 1494
    2.4.
1490 1495
 
1491
-       Where can I find more about Kamailio?
1496
+   Where can I find more about Kamailio?
1492 1497
 
1493
-       Take a look at https://www.kamailio.org/.
1498
+   Take a look at https://www.kamailio.org/.
1494 1499
 
1495 1500
    2.5.
1496 1501
 
1497
-       Where can I post a question about this module?
1502
+   Where can I post a question about this module?
1498 1503
 
1499
-       First at all check if your question was already answered on one of our
1500
-       mailing lists:
1501
-         * User Mailing List -
1502
-           https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users
1503
-         * Developer Mailing List -
1504
-           https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev
1504
+   First at all check if your question was already answered on one of our
1505
+   mailing lists:
1506
+     * User Mailing List -
1507
+       https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-users
1508
+     * Developer Mailing List -
1509
+       https://lists.kamailio.org/cgi-bin/mailman/listinfo/sr-dev
1505 1510
 
1506
-       E-mails regarding any stable Kamailio release should be sent to
1507
-       <sr-users@lists.kamailio.org> and e-mails regarding development
1508
-       versions should be sent to <sr-dev@lists.kamailio.org>.
1511
+   E-mails regarding any stable Kamailio release should be sent to
1512
+   <sr-users@lists.kamailio.org> and e-mails regarding development
1513
+   versions should be sent to <sr-dev@lists.kamailio.org>.
1509 1514
 
1510 1515
    2.6.
1511 1516
 
1512
-       How can I report a bug?
1517
+   How can I report a bug?
1513 1518
 
1514
-       Please follow the guidelines provided at:
1515
-       https://github.com/kamailio/kamailio/issues.
1519
+   Please follow the guidelines provided at:
1520
+   https://github.com/kamailio/kamailio/issues.
... ...
@@ -1,2325 +1,2 @@
1
-dialog Module
2 1
 
3
-Bogdan-Andrei Iancu
4 2
 
5
-   Voice Sistem SRL
6
-
7
-Carsten Bock
8
-
9
-   ng-voice.com
10
-
11
-Edited by
12
-
13
-Bogdan-Andrei Iancu
14
-
15
-Edited by
16
-
17
-Carsten Bock
18
-
19
-Edited by
20
-
21
-Alex Balashov
22
-
23
-   <abalashov@evaristesys.com>
24
-
25
-Edited by
26
-
27
-Olle E. Johansson
28
-
29
-   <oej@edvina.net>
30
-
31
-Edited by
32
-
33
-Surendra Tiwari
34
-
35
-   <surendratiwari3@gmail.com>
36
-
37
-   Copyright © 2006 Voice Sistem SRL
38
-
39
-   Copyright © 2011 Carsten Bock, http://www.ng-voice.com
40
-     __________________________________________________________________
41
-
42
-   Table of Contents
43
-
44
-   1. Admin Guide
45
-
46
-        1. Overview
47
-        2. How it works
48
-        3. Dialog states
49
-        4. Dialog profiling
50
-        5. Dependencies
51
-
52
-              5.1. Kamailio Modules
53
-              5.2. External Libraries or Applications
54
-
55
-        6. Parameters
56
-
57
-              6.1. enable_stats (integer)
58
-              6.2. hash_size (integer)
59
-              6.3. rr_param (string)
60
-              6.4. dlg_flag (integer)
61
-              6.5. timeout_avp (string)
62
-              6.6. default_timeout (integer)
63
-              6.7. early_timeout (integer)
64
-              6.8. noack_timeout (integer)
65
-              6.9. end_timeout (integer)
66
-              6.10. dlg_extra_hdrs (string)
67
-              6.11. dlg_match_mode (integer)
68
-              6.12. detect_spirals (integer)
69
-              6.13. db_url (string)
70
-              6.14. db_mode (integer)
71
-              6.15. db_update_period (integer)
72
-              6.16. db_fetch_rows (integer)
73
-              6.17. db_skip_load (integer)
74
-              6.18. table_name (string)
75
-              6.19. call_id_column (string)
76
-              6.20. from_uri_column (string)
77
-              6.21. from_tag_column (string)
78
-              6.22. to_uri_column (string)
79
-              6.23. to_tag_column (string)
80
-              6.24. from_cseq_column (string)
81
-              6.25. to_cseq_column (string)
82
-              6.26. from_route_column (string)
83
-              6.27. to_route_column (string)
84
-              6.28. from_contact_column (string)
85
-              6.29. to_contact_column (string)
86
-              6.30. from_sock_column (string)
87
-              6.31. to_sock_column (string)
88
-              6.32. h_id_column (string)
89
-              6.33. h_entry_column (string)
90
-              6.34. state_column (string)
91
-              6.35. start_time_column (string)
92
-              6.36. timeout_column (string)
93
-              6.37. sflags_column (string)
94
-              6.38. toroute_name_column (string)
95
-              6.39. vars_table_name (string)
96
-              6.40. vars_h_id_column (string)
97
-              6.41. vars_h_entry_column (string)
98
-              6.42. vars_key_column (string)
99
-              6.43. vars_value_column (string)
100
-              6.44. profiles_with_value (string)
101
-              6.45. profiles_no_value (string)
102
-              6.46. bridge_controller (string)
103
-              6.47. bridge_contact (string)
104
-              6.48. initial_cbs_inscript (int)
105
-              6.49. send_bye (int)
106
-              6.50. wait_ack (int)
107
-              6.51. ka_timer (int)
108
-              6.52. ka_interval (int)
109
-              6.53. ka_failed_limit (int)
110
-              6.54. timeout_noreset (int)
111
-              6.55. timer_procs (int)
112
-              6.56. enable_dmq (int)
113
-              6.57. track_cseq_updates (int)
114
-              6.58. lreq_callee_headers (string)
115
-              6.59. event_callback (str)
116
-              6.60. h_id_start (int)
117
-              6.61. h_id_step (int)
118
-
119
-        7. Functions
120
-
121
-              7.1. set_dlg_profile(profile,[value])
122
-              7.2. unset_dlg_profile(profile,[value])
123
-              7.3. is_in_profile(profile,[value])
124
-              7.4. get_profile_size(profile,[value],size)
125
-              7.5. dlg_isflagset(flag)
126
-              7.6. dlg_setflag(flag)
127
-              7.7. dlg_resetflag(flag)
128
-              7.8. dlg_bye(side)
129
-              7.9. dlg_refer(side, address)
130
-              7.10. dlg_manage()
131
-              7.11. dlg_bridge(from, to, op)
132
-              7.12. dlg_get(callid, ftag, ttag)
133
-              7.13. is_known_dlg()
134
-              7.14. dlg_set_timeout(timeout [, h_entry, h_id])
135
-              7.15. dlg_set_timeout_by_profile(profile, [value], timeout)
136
-              7.16. dlg_set_property(attr)
137
-              7.17. dlg_remote_profile(cmd, profile, value, uid, expires)
138
-              7.18. dlg_set_ruri()
139
-              7.19. dlg_db_load_callid(cival)
140
-              7.20. dlg_db_load_extra()
141
-
142
-        8. Statistics
143
-
144
-              8.1. active_dialogs
145
-              8.2. early_dialogs
146
-              8.3. processed_dialogs
147
-              8.4. expired_dialogs
148
-              8.5. failed_dialogs
149
-
150
-        9. RPC Commands
151
-
152
-              9.1. dlg.list
153
-              9.2. dlg.list_ctx
154
-              9.3. dlg.list_match
155
-              9.4. dlg.list_match_ctx
156
-              9.5. dlg.dlg_list
157
-              9.6. dlg.dlg_list_ctx
158
-              9.7. dlg.terminate_dlg
159
-              9.8. dlg.end_dlg
160
-              9.9. dlg.profile_get_size
161
-              9.10. dlg.profile_list
162
-              9.11. dlg.bridge_dlg
163
-              9.12. dlg.stats_active
164
-              9.13. dlg.is_alive
165
-
166
-        10. Exported Variables
167
-
168
-              10.1. $DLG_count
169
-              10.2. $DLG_status
170
-              10.3. $DLG_lifetime
171
-              10.4. $dlg(...)
172
-              10.5. $dlg_ctx(...)
173
-              10.6. $dlg_var(key)
174
-
175
-        11. Event Routes
176
-
177
-              11.1. event_route[dialog:start]
178
-              11.2. event_route[dialog:end]
179
-              11.3. event_route[dialog:failed]
180
-
181
-   2. Developer Guide
182
-
183
-        1. Available Functions
184
-
185
-              1.1. register_dlgcb (dialog, type, cb, param, free_param_cb)
186
-
187
-              1.2. terminate_dlg (dlg, hdrs)
188
-
189
-   3. Frequently Asked Questions
190
-
191
-   List of Examples
192
-
193
-   1.1. Set enable_stats parameter
194
-   1.2. Set hash_size parameter
195
-   1.3. Set rr_param parameter
196
-   1.4. Set dlg_flag parameter
197
-   1.5. Set timeout_avp parameter
198
-   1.6. Set default_timeout parameter
199
-   1.7. Set early_timeout parameter
200
-   1.8. Set noack_timeout parameter
201
-   1.9. Set end_timeout parameter
202
-   1.10. Set dlf_extra_hdrs parameter
203
-   1.11. Set dlg_match_mode parameter
204
-   1.12. Set detect_spirals parameter
205
-   1.13. Set db_url parameter
206
-   1.14. Set db_mode parameter
207
-   1.15. Set db_update_period parameter
208
-   1.16. Set db_fetch_rows parameter
209
-   1.17. Set db_skip_load parameter
210
-   1.18. Set table_name parameter
211
-   1.19. Set call_id_column parameter
212
-   1.20. Set from_uri_column parameter
213
-   1.21. Set from_tag_column parameter
214
-   1.22. Set to_uri_column parameter
215
-   1.23. Set to_tag_column parameter
216
-   1.24. Set from_cseq_column parameter
217
-   1.25. Set to_cseq_column parameter
218
-   1.26. Set from_route_column parameter
219
-   1.27. Set to_route_column parameter
220
-   1.28. Set from_contact_column parameter
221
-   1.29. Set to_contact_column parameter
222
-   1.30. Set from_sock_column parameter
223
-   1.31. Set to_sock_column parameter
224
-   1.32. Set h_id_column parameter
225
-   1.33. Set h_entry_column parameter
226
-   1.34. Set state_column parameter
227
-   1.35. Set start_time_column parameter
228
-   1.36. Set timeout_column parameter
229
-   1.37. Set sflags_column parameter
230
-   1.38. Set toroute_name_column parameter
231
-   1.39. Set vars_table_name parameter
232
-   1.40. Set vars_h_id_column parameter
233
-   1.41. Set vars_h_entry_column parameter
234
-   1.42. Set vars_key_column parameter
235
-   1.43. Set vars_value_column parameter
236
-   1.44. Set profiles_with_value parameter
237
-   1.45. Set profiles_no_value parameter
238
-   1.46. Set bridge_controller parameter
239
-   1.47. Set bridge_contact parameter
240
-   1.48. Set initial_cbs_inscript parameter
241
-   1.49. Set send_bye parameter
242
-   1.50. Set wait_ack parameter
243
-   1.51. Set ka_timer parameter
244
-   1.52. Set ka_interval parameter
245
-   1.53. Set ka_failed_limit parameter
246
-   1.54. Set timeout_noreset parameter
247
-   1.55. Set timer_procs parameter
248
-   1.56. Set enable_dmq parameter
249
-   1.57. Set track_cseq_updates parameter
250
-   1.58. Set lreq_callee_headers parameter
251
-   1.59. Set event_callback parameter
252
-   1.60. Set h_id_start parameter
253
-   1.61. Set h_id_step parameter
254
-   1.62. set_dlg_profile usage
255
-   1.63. unset_dlg_profile usage
256
-   1.64. is_in_profile usage
257
-   1.65. get_profile_size usage
258
-   1.66. dlg_isflagset usage
259
-   1.67. dlg_setflag usage
260
-   1.68. dlg_resetflag usage
261
-   1.69. dlg_bye usage
262
-   1.70. dlg_refer usage
263
-   1.71. dlg_manage usage
264
-   1.72. dlg_bridge usage
265
-   1.73. dlg_get usage
266
-   1.74. is_known_dlg() usage
267
-   1.75. dlg_set_timeout usage
268
-   1.76. dlg_set_timeout_by_profile usage
269
-   1.77. dlg_set_property usage
270
-   1.78. dlg_remote_profile usage
271
-   1.79. dlg_set_ruri() usage
272
-   1.80. dlg_db_load_callid() usage
273
-   1.81. dlg_db_load_extra() usage
274
-
275
-Chapter 1. Admin Guide
276
-
277
-   Table of Contents
278
-
279
-   1. Overview
280
-   2. How it works
281
-   3. Dialog states
282
-   4. Dialog profiling
283
-   5. Dependencies
284
-
285
-        5.1. Kamailio Modules
286
-        5.2. External Libraries or Applications
287
-
288
-   6. Parameters
289
-
290
-        6.1. enable_stats (integer)
291
-        6.2. hash_size (integer)
292
-        6.3. rr_param (string)
293
-        6.4. dlg_flag (integer)
294
-        6.5. timeout_avp (string)
295
-        6.6. default_timeout (integer)
296
-        6.7. early_timeout (integer)
297
-        6.8. noack_timeout (integer)
298
-        6.9. end_timeout (integer)
299
-        6.10. dlg_extra_hdrs (string)
300
-        6.11. dlg_match_mode (integer)
301
-        6.12. detect_spirals (integer)
302
-        6.13. db_url (string)
303
-        6.14. db_mode (integer)
304
-        6.15. db_update_period (integer)
305
-        6.16. db_fetch_rows (integer)
306
-        6.17. db_skip_load (integer)
307
-        6.18. table_name (string)
308
-        6.19. call_id_column (string)
309
-        6.20. from_uri_column (string)
310
-        6.21. from_tag_column (string)
311
-        6.22. to_uri_column (string)
312
-        6.23. to_tag_column (string)
313
-        6.24. from_cseq_column (string)
314
-        6.25. to_cseq_column (string)
315
-        6.26. from_route_column (string)
316
-        6.27. to_route_column (string)
317
-        6.28. from_contact_column (string)
318
-        6.29. to_contact_column (string)
319
-        6.30. from_sock_column (string)
320
-        6.31. to_sock_column (string)
321
-        6.32. h_id_column (string)
322
-        6.33. h_entry_column (string)
323
-        6.34. state_column (string)
324
-        6.35. start_time_column (string)
325
-        6.36. timeout_column (string)
326
-        6.37. sflags_column (string)
327
-        6.38. toroute_name_column (string)
328
-        6.39. vars_table_name (string)
329
-        6.40. vars_h_id_column (string)
330
-        6.41. vars_h_entry_column (string)
331
-        6.42. vars_key_column (string)
332
-        6.43. vars_value_column (string)
333
-        6.44. profiles_with_value (string)
334
-        6.45. profiles_no_value (string)
335
-        6.46. bridge_controller (string)
336
-        6.47. bridge_contact (string)
337
-        6.48. initial_cbs_inscript (int)
338
-        6.49. send_bye (int)
339
-        6.50. wait_ack (int)
340
-        6.51. ka_timer (int)
341
-        6.52. ka_interval (int)
342
-        6.53. ka_failed_limit (int)
343
-        6.54. timeout_noreset (int)
344
-        6.55. timer_procs (int)
345
-        6.56. enable_dmq (int)
346
-        6.57. track_cseq_updates (int)
347
-        6.58. lreq_callee_headers (string)
348
-        6.59. event_callback (str)
349
-        6.60. h_id_start (int)
350
-        6.61. h_id_step (int)
351
-
352
-   7. Functions
353
-
354
-        7.1. set_dlg_profile(profile,[value])
355
-        7.2. unset_dlg_profile(profile,[value])
356
-        7.3. is_in_profile(profile,[value])
357
-        7.4. get_profile_size(profile,[value],size)
358
-        7.5. dlg_isflagset(flag)
359
-        7.6. dlg_setflag(flag)
360
-        7.7. dlg_resetflag(flag)
361
-        7.8. dlg_bye(side)
362
-        7.9. dlg_refer(side, address)
363
-        7.10. dlg_manage()
364
-        7.11. dlg_bridge(from, to, op)
365
-        7.12. dlg_get(callid, ftag, ttag)
366
-        7.13. is_known_dlg()
367
-        7.14. dlg_set_timeout(timeout [, h_entry, h_id])
368
-        7.15. dlg_set_timeout_by_profile(profile, [value], timeout)
369
-        7.16. dlg_set_property(attr)
370
-        7.17. dlg_remote_profile(cmd, profile, value, uid, expires)
371
-        7.18. dlg_set_ruri()
372
-        7.19. dlg_db_load_callid(cival)
373
-        7.20. dlg_db_load_extra()
374
-
375
-   8. Statistics
376
-
377
-        8.1. active_dialogs
378
-        8.2. early_dialogs
379
-        8.3. processed_dialogs
380
-        8.4. expired_dialogs
381
-        8.5. failed_dialogs
382
-
383
-   9. RPC Commands
384
-
385
-        9.1. dlg.list
386
-        9.2. dlg.list_ctx
387
-        9.3. dlg.list_match
388
-        9.4. dlg.list_match_ctx
389
-        9.5. dlg.dlg_list
390
-        9.6. dlg.dlg_list_ctx
391
-        9.7. dlg.terminate_dlg
392
-        9.8. dlg.end_dlg
393
-        9.9. dlg.profile_get_size
394
-        9.10. dlg.profile_list
395
-        9.11. dlg.bridge_dlg
396
-        9.12. dlg.stats_active
397
-        9.13. dlg.is_alive
398
-
399
-   10. Exported Variables
400
-
401
-        10.1. $DLG_count
402
-        10.2. $DLG_status
403
-        10.3. $DLG_lifetime
404
-        10.4. $dlg(...)
405
-        10.5. $dlg_ctx(...)
406
-        10.6. $dlg_var(key)
407
-
408
-   11. Event Routes
409
-
410
-        11.1. event_route[dialog:start]
411
-        11.2. event_route[dialog:end]
412
-        11.3. event_route[dialog:failed]
413
-
414
-1. Overview
415
-
416
-   Kamailio can behave as a stateful proxy through the TM module. However,
417
-   "stateful" in this context refers to transaction state, not dialog
418
-   state. Certain applications may benefit from an awareness of "calls" in
419
-   the proxy, not just SIP transactions.
420
-
421
-   For example, a common need is to limit the number of calls that can be
422
-   made concurrently by an endpoint, account, user group, etc. In order to
423
-   count the number of calls in progress, it is necessary for the proxy to
424
-   be aware of whole dialogs, not just transactions, and to provide some
425
-   means of programmatically classifying these dialogs. This is just one
426
-   common application discussed for illustrative purposes; there are many
427
-   others.
428
-
429
-   The dialog module provides dialog awareness for the Kamailio proxy.
430
-   It's functionality is to keep track of the current dialogs, to offer
431
-   information about them (e.g. how many dialogs are active), and to
432
-   manage various characteristics of dialogs. The module exports several
433
-   functions that can be used directly from the configuration route script
434
-   as well as functions for the RPC interface.
435
-
436
-   This module also provides a API foundation on which to build more
437
-   complex dialog-oriented functionality in other Kamailio modules.
438
-
439
-2. How it works
440
-
441
-   To create the dialog associated with an initial INVITE request, execute
442
-   the function “dlg_manage()” or set the flag specified by parameter
443
-   “dlg_flag” (Section 6.4, “dlg_flag (integer)”) before creating the
444
-   corresponding transaction.
445
-
446
-   The dialog is automatically destroyed when a “BYE” is received. In case
447
-   of no “BYE”, the dialog lifetime is controlled via the default timeout
448
-   (see “default_timeout” - Section 6.6, “default_timeout (integer)”) and
449
-   custom timeout (see “timeout_avp” - Section 6.5, “timeout_avp
450
-   (string)”). The dialog timeout is reset each time a sequential request
451
-   is processed.
452
-
453
-3. Dialog states
454
-
455
-   Dialogs have states that are shown in the RPC interface as well as
456
-   stored in the database.
457
-     * 1 : Unconfirmed dialog
458
-     * 2 : Early dialog (ringing)
459
-     * 3 : Confirmed dialog (waiting for ACK)
460
-     * 4 : Confirmed dialog (active call)
461
-     * 5 : Deleted dialog
462
-
463
-   The early and deleted dialog states are not updated in database
464
-   storage.
465
-
466
-4. Dialog profiling
467
-
468
-   Dialog profiling is a mechanism that helps in classifying, sorting and
469
-   keeping track of certain types of dialogs. The classification criteria
470
-   can be any attributes desired by the administrator; it can be SIP
471
-   message attributes, other pseudo-variables, custom values, etc. Dialogs
472
-   can be dynamically added into one or more profile tables. Logically,
473
-   each profile table can have a special meaning (like dialogs outside the
474
-   domain, dialogs terminated to the PSTN, etc.).
475
-
476
-   There are two types of profiles:
477
-     * with no value - a dialog simply belongs to a profile (for instance,
478
-       an outbound calls profile). There is no other additional
479
-       information to describe the dialog beyond its membership in the
480
-       profile per se.
481
-     * with value - a dialog belongs to a profile having a certain value
482
-       (like in a caller profile, where the value is the caller ID). The
483
-       membership of the dialog in the profile is strictly related to the
484
-       value. For example, if the account ID of the caller is stored in
485
-       the pseudo-variable $var(account_id), you can use $var(account_id)
486
-       as a value/key by which to group dialogs so that you can count the
487
-       number of open dialogs for each account, enforce concurrent call
488
-       limits as necessary, etc.
489
-
490
-   A dialog can be added to multiple profiles at the same time.
491
-
492
-   Profiles are visible (at the moment) in the request route (for initial
493
-   and sequential requests) and in the branch, failure and reply routes of
494
-   the original request.
495
-
496
-5. Dependencies
497
-
498
-   5.1. Kamailio Modules
499
-   5.2. External Libraries or Applications
500
-
501
-5.1. Kamailio Modules
502
-
503
-   The following modules must be loaded before this module:
504
-     * TM - Transaction module
505
-     * RR - Record-Route module
506
-     * PV - Pseudovariables module
507
-
508
-5.2. External Libraries or Applications
509
-
510
-   The following libraries or applications must be installed before
511
-   running Kamailio with this module loaded:
512
-     * None.
513
-
514
-6. Parameters
515
-
516
-   6.1. enable_stats (integer)
517
-   6.2. hash_size (integer)
518
-   6.3. rr_param (string)
519
-   6.4. dlg_flag (integer)
520
-   6.5. timeout_avp (string)
521
-   6.6. default_timeout (integer)
522
-   6.7. early_timeout (integer)
523
-   6.8. noack_timeout (integer)
524
-   6.9. end_timeout (integer)
525
-   6.10. dlg_extra_hdrs (string)
526
-   6.11. dlg_match_mode (integer)
527
-   6.12. detect_spirals (integer)
528
-   6.13. db_url (string)
529
-   6.14. db_mode (integer)
530
-   6.15. db_update_period (integer)
531
-   6.16. db_fetch_rows (integer)
532
-   6.17. db_skip_load (integer)
533
-   6.18. table_name (string)
534
-   6.19. call_id_column (string)
535
-   6.20. from_uri_column (string)
536
-   6.21. from_tag_column (string)
537
-   6.22. to_uri_column (string)
538
-   6.23. to_tag_column (string)
539
-   6.24. from_cseq_column (string)
540
-   6.25. to_cseq_column (string)
541
-   6.26. from_route_column (string)
542
-   6.27. to_route_column (string)
543
-   6.28. from_contact_column (string)
544
-   6.29. to_contact_column (string)
545
-   6.30. from_sock_column (string)
546
-   6.31. to_sock_column (string)
547
-   6.32. h_id_column (string)
548
-   6.33. h_entry_column (string)
549
-   6.34. state_column (string)
550
-   6.35. start_time_column (string)
551
-   6.36. timeout_column (string)
552
-   6.37. sflags_column (string)
553
-   6.38. toroute_name_column (string)
554
-   6.39. vars_table_name (string)
555
-   6.40. vars_h_id_column (string)
556
-   6.41. vars_h_entry_column (string)
557
-   6.42. vars_key_column (string)
558
-   6.43. vars_value_column (string)
559
-   6.44. profiles_with_value (string)
560
-   6.45. profiles_no_value (string)
561
-   6.46. bridge_controller (string)
562
-   6.47. bridge_contact (string)
563
-   6.48. initial_cbs_inscript (int)
564
-   6.49. send_bye (int)
565
-   6.50. wait_ack (int)
566
-   6.51. ka_timer (int)
567
-   6.52. ka_interval (int)
568
-   6.53. ka_failed_limit (int)
569
-   6.54. timeout_noreset (int)
570
-   6.55. timer_procs (int)
571
-   6.56. enable_dmq (int)
572
-   6.57. track_cseq_updates (int)
573
-   6.58. lreq_callee_headers (string)
574
-   6.59. event_callback (str)
575
-   6.60. h_id_start (int)
576
-   6.61. h_id_step (int)
577
-
578
-6.1. enable_stats (integer)
579
-
580
-   If statistics support should be enabled or not. Via statistics
581
-   variables, the module provide information about the dialog processing.
582
-   Set it to zero to disable or to non-zero to enable it.
583
-
584
-   Default value is “1 (enabled)”.
585
-
586
-   Example 1.1. Set enable_stats parameter
587
-...
588
-modparam("dialog", "enable_stats", 0)
589
-...
590
-
591
-6.2. hash_size (integer)
592
-
593
-   The size of the hash table internally used to keep the dialogs. A
594
-   larger table is much faster but consumes more memory. The hash size
595
-   must be a power of two.
596
-
597
-   IMPORTANT: If dialog information should be stored in a database, a
598
-   constant hash_size should be used, otherwise the restoring process will
599
-   not take place. If you really want to modify the hash_size, you must
600
-   delete all table's rows before restarting the server.
601
-
602
-   Default value is “4096”.
603
-
604
-   Example 1.2. Set hash_size parameter
605
-...
606
-modparam("dialog", "hash_size", 1024)
607
-...
608
-
609
-6.3. rr_param (string)
610
-
611
-   Name of the Record-Route parameter used to store the dialog cookie. It
612
-   is used for the fast matching of sequential requests to tracked
613
-   dialogs.
614
-
615
-   Default value is “did”.
616
-
617
-   Example 1.3. Set rr_param parameter
618
-...
619
-modparam("dialog", "rr_param", "xyz")
620
-...
621
-
622
-6.4. dlg_flag (integer)
623
-
624
-   Flag to be used for marking if a dialog should be constructed for the
625
-   current request (this make sense only for initial requests).
626
-
627
-   Note: it is not needed to set this parameter and its corresponding flag
628
-   for initial request in case the “dlg_manage()” function is used. In
629
-   other words, using “dlg_manage()” alone is enough.
630
-
631
-   Default value is “none”.
632
-
633
-   Example 1.4. Set dlg_flag parameter
634
-...
635
-modparam("dialog", "dlg_flag", 4)
636
-...
637
-
638
-6.5. timeout_avp (string)
639
-
640
-   The specification of an AVP that contains a custom timeout value (in
641
-   seconds) for the dialog. It may be used only in a request (initial or
642
-   sequential) context.
643
-
644
-   Default value is “none”.
645
-
646
-   Example 1.5. Set timeout_avp parameter
647
-...
648
-modparam("dialog", "timeout_avp", "$avp(i:10)")
649
-...
650
-
651
-6.6. default_timeout (integer)
652
-
653
-   The default dialog timeout (in seconds), in the absence of a custom
654
-   value provided in an AVP.
655
-
656
-   Default value is “43200 (12 hours)”.
657
-
658
-   Example 1.6. Set default_timeout parameter
659
-...
660
-modparam("dialog", "default_timeout", 21600)
661
-...
662
-
663
-6.7. early_timeout (integer)
664
-
665
-   The timeout (in seconds) after which the dialogs in unconfirmed or
666
-   early state (no final response received) are destroyed.
667
-
668
-   Default value is “300 (5 minutes)”.
669
-
670
-   Example 1.7. Set early_timeout parameter
671
-...
672
-modparam("dialog", "early_timeout", 180)
673
-...
674
-
675
-6.8. noack_timeout (integer)
676
-
677
-   The timeout (in seconds) after which the dialogs which were answered
678
-   with 200ok but didn't receive the ACK are marked for termination (the
679
-   lifetime is set to 10 more seconds).
680
-
681
-   Default value is “60 (1 minute)”.
682
-
683
-   Example 1.8. Set noack_timeout parameter
684
-...
685
-modparam("dialog", "noack_timeout", 90)
686
-...
687
-
688
-6.9. end_timeout (integer)
689
-
690
-   The timeout (in seconds) after which the dialogs in terminated state
691
-   are destroyed.
692
-
693
-   Default value is “300 (5 minutes)”.
694
-
695
-   Example 1.9. Set end_timeout parameter
696
-...
697
-modparam("dialog", "end_timeout", 180)
698
-...
699
-
700
-6.10. dlg_extra_hdrs (string)
701
-
702
-   A string containing the extra headers (full format, with EOH) to be
703
-   added to requests generated locally by the module (like BYEs).
704
-
705
-   Default value is “NULL”.
706
-
707
-   Example 1.10. Set dlf_extra_hdrs parameter
708
-...
709
-modparam("dialog", "dlg_extra_hdrs", "Hint: credit expired\r\n")
710
-...
711
-
712
-6.11. dlg_match_mode (integer)
713
-
714
-   How the sequential requests should be matched against the known
715
-   dialogs. The modes are a combination of matching based on a cookie
716
-   (DID) stored as cookie in Record-Route header and matching based on SIP
717
-   elements (as in RFC 3261).
718
-
719
-   Note: DID-based matching does not replace callid/fromtag/totag
720
-   comparison. It will speed up dialog matching by not iterating over the
721
-   whole dialog list for callid/fromtag/totag comparison, but instead it
722
-   uses a hash table to find the respective dialog and then doing only one
723
-   callid/fromtag/totag comparison. Thus, there is no security issue when
724
-   using DID based matching. Use DID_FALLBACK for maximum interoperability
725
-   or use DID_ONLY to reject buggy clients or hacking attempts. DID_NONE
726
-   is only useful, when you want to hide dialog-tracking from the users
727
-   (preventing the DID Record-Route cookie).
728
-
729
-   The supported modes are:
730
-     * 0 - DID_ONLY - the match is done exclusively based on DID;
731
-     * 1 - DID_FALLBACK - the match is first tried based on DID and if not
732
-       present, it will fall back to SIP matching;
733
-     * 2 - DID_NONE - the match is done exclusively based on SIP elements;
734
-       no DID information is added in RR.
735
-
736
-   Default value is “0 (DID_ONLY)”.
737
-
738
-   Example 1.11. Set dlg_match_mode parameter
739
-...
740
-modparam("dialog", "dlg_match_mode", 1)
741
-...
742
-
743
-6.12. detect_spirals (integer)
744
-
745
-   Whether spirals (i.e., messages routed through the proxy multiple
746
-   times) should be detected.
747
-
748
-   If set to 0, spirals will not be detected and result in the generation
749
-   of a new, possibly dangling dialog structure per occurring spiral. If
750
-   set to 1, spirals are detected and internally mapped to existing dialog
751
-   structures.
752
-
753
-   Default value is 1.
754
-
755
-   Example 1.12. Set detect_spirals parameter
756
-...
757
-modparam("dialog", "detect_spirals", 1)
758
-...
759
-
760
-6.13. db_url (string)
761
-
762
-   In order to store information about dialogs in a database, a database
763
-   URL must be specified.
764
-
765
-   Default value is “mysql://kamailio:kamailiorw@localhost/kamailio”.
766
-
767
-   Example 1.13. Set db_url parameter
768
-...
769
-modparam("dialog", "db_url", "dbdriver://username:password@dbhost/dbname")
770
-...
771
-
772
-6.14. db_mode (integer)
773
-
774
-   Mode of synchronisation of dialog information from memory to an
775
-   underlying database (if desired):
776
-
777
-   The supported modes are:
778
-     * 0 - NO_DB - the memory content is not flushed into DB;
779
-     * 1 - REALTIME - any dialog information changes will be reflected
780
-       into the database immediately.
781
-     * 2 - DELAYED - the dialog information changes will be flushed into
782
-       DB periodically, based on a timer routine.
783
-     * 3 - SHUTDOWN - the dialog information will be flushed into DB only
784
-       at shutdown - no runtime updates.
785
-
786
-   Default value is “0”.
787
-
788
-   Example 1.14. Set db_mode parameter
789
-...
790
-modparam("dialog", "db_mode", 1)
791
-...
792
-
793
-6.15. db_update_period (integer)
794
-
795
-   The interval (seconds) at which to update dialogs' information, if the
796
-   server is configured to store the dialog information at a given
797
-   interval. Too short an interval will generate intensive database
798
-   operations, while an excessively long one will miss dialogs with a
799
-   short lifetime.
800
-
801
-   Default value is “60” seconds.
802
-
803
-   Example 1.15. Set db_update_period parameter
804
-...
805
-modparam("dialog", "db_update_period", 120)
806
-...
807
-
808
-6.16. db_fetch_rows (integer)
809
-
810
-   The number of the rows to be fetched at once from database when loading
811
-   the dialog records at startup from the database. This value can be used
812
-   to tune the load time at startup. For 1MB of private memory (default),
813
-   it should be below 400. The database driver must support the
814
-   fetch_result() capability. A value of 0 means the database fetch is not
815
-   limited.
816
-
817
-   Default value is “200”.
818
-
819
-   Example 1.16. Set db_fetch_rows parameter
820
-...
821
-modparam("dialog", "db_fetch_rows", 500)
822
-...
823
-
824
-6.17. db_skip_load (integer)
825
-
826
-   Set db_skip_load to 1, to skip the loading of dialog data from the
827
-   database.
828
-
829
-   Default value is “0” ( not skipped ).
830
-
831
-   Example 1.17. Set db_skip_load parameter
832
-...
833
-modparam("dialog", "db_skip_load", 1)
834
-...
835
-
836
-6.18. table_name (string)
837
-
838
-   Database table name used for storing dialog information.
839
-
840
-   Default value is “dialog”.
841
-
842
-   Example 1.18. Set table_name parameter
843
-...
844
-modparam("dialog", "table_name", "my_dialog")
845
-...
846
-
847
-6.19. call_id_column (string)
848
-
849
-   The column name in the database to store the dialog call-id.
850
-
851
-   Default value is “callid”.
852
-
853
-   Example 1.19. Set call_id_column parameter
854
-...
855
-modparam("dialog", "call_id_column", "callid_c_name")
856
-...
857
-
858
-6.20. from_uri_column (string)
859
-
860
-   The column name in the database to store the caller's SIP address
861
-   (URI).
862
-
863
-   Default value is “from_uri”.
864
-
865
-   Example 1.20. Set from_uri_column parameter
866
-...
867
-modparam("dialog", "from_uri_column", "from_uri_c_name")
868
-...
869
-
870
-6.21. from_tag_column (string)
871
-
872
-   The column name in the database to store the From header tag from the
873
-   INVITE request.
874
-
875
-   Default value is “from_tag”.
876
-
877
-   Example 1.21. Set from_tag_column parameter
878
-...
879
-modparam("dialog", "from_tag_column", "from_tag_c_name")
880
-...
881
-
882
-6.22. to_uri_column (string)
883
-
884
-   The column name in the database to store the callee's SIP address
885
-   (URI).
886
-
887
-   Default value is “to_uri”.
888
-
889
-   Example 1.22. Set to_uri_column parameter
890
-...
891
-modparam("dialog", "to_uri_column", "to_uri_c_name")
892
-...
893
-
894
-6.23. to_tag_column (string)
895
-
896
-   The column name in the database to store the To header tag from the 200
897
-   OK response to the INVITE request, if present.
898
-
899
-   Default value is “to_tag”.
900
-
901
-   Example 1.23. Set to_tag_column parameter
902
-...
903
-modparam("dialog", "to_tag_column", "to_tag_c_name")
904
-...
905
-
906
-6.24. from_cseq_column (string)
907
-
908
-   The column name in the database to store the Cseq from caller side.
909
-
910
-   Default value is “caller_cseq”.
911
-
912
-   Example 1.24. Set from_cseq_column parameter
913
-...
914
-modparam("dialog", "from_cseq_column", "from_cseq")
915
-...
916
-
917
-6.25. to_cseq_column (string)
918
-
919
-   The column name in the database to store the cseq from callee side.
920
-
921
-   Default value is “callee_cseq”.
922
-
923
-   Example 1.25. Set to_cseq_column parameter
924
-...
925
-modparam("dialog", "to_cseq_column", "to_cseq")
926
-...
927
-
928
-6.26. from_route_column (string)
929
-
930
-   The column name in the database to store the route records from caller
931
-   side (proxy to caller).
932
-
933
-   Default value is “caller_route_set”.
934
-
935
-   Example 1.26. Set from_route_column parameter
936
-...
937
-modparam("dialog", "from_route_column", "rroute_from")
938
-...
939
-
940
-6.27. to_route_column (string)
941
-
942
-   The column name in the database to store the route records from callee
943
-   side (proxy to callee).
944
-
945
-   Default value is “callee_route_set”.
946
-
947
-   Example 1.27. Set to_route_column parameter
948
-...
949
-modparam("dialog", "to_route_column", "rroute_to")
950
-...
951
-
952
-6.28. from_contact_column (string)
953
-
954
-   The column name in the database to store the caller's contact uri.
955
-
956
-   Default value is “caller_contact”.
957
-
958
-   Example 1.28. Set from_contact_column parameter
959
-...
960
-modparam("dialog", "from_contact_column", "from_contact_uri")
961
-...
962
-
963
-6.29. to_contact_column (string)
964
-
965
-   The column name in the database to store the callee's contact uri.
966
-
967
-   Default value is “callee_contact”.
968
-
969
-   Example 1.29. Set to_contact_column parameter
970
-...
971
-modparam("dialog", "to_contact_column", "to_contact_uri")
972
-...
973
-
974
-6.30. from_sock_column (string)
975
-
976
-   The column name in the database to store the information about the
977
-   local interface receiving the traffic from caller.
978
-
979
-   Default value is “caller_sock”.
980
-
981
-   Example 1.30. Set from_sock_column parameter
982
-...
983
-modparam("dialog", "from_sock_column", "socket_from")
984
-...
985
-
986
-6.31. to_sock_column (string)
987
-
988
-   The column name in the database to store information about the local
989
-   interface receiving the traffic from callee.
990
-
991
-   Default value is “callee_sock”.
992
-
993
-   Example 1.31. Set to_sock_column parameter
994
-...
995
-modparam("dialog", "to_sock_column", "socket_to")
996
-...
997
-
998
-6.32. h_id_column (string)
999
-
1000
-   The column name in the database to store the dialogs' hash id
1001
-   information.
1002
-
1003
-   Default value is “hash_id”.
1004
-
1005
-   Example 1.32. Set h_id_column parameter
1006
-...
1007
-modparam("dialog", "h_id_column", "hash_id_c_name")
1008
-...
1009
-
1010
-6.33. h_entry_column (string)
1011
-
1012
-   The column name in the database to store the dialog's hash entry
1013
-   information.
1014
-
1015
-   Default value is “hash_entry”.
1016
-
1017
-   Example 1.33. Set h_entry_column parameter
1018
-...
1019
-modparam("dialog", "h_entry_column", "h_entry_c_name")
1020
-...
1021
-
1022
-6.34. state_column (string)
1023
-
1024
-   The column name in the database to store the dialog's state
1025
-   information.
1026
-
1027
-   Default value is “state”.
1028
-
1029
-   Example 1.34. Set state_column parameter
1030
-...
1031
-modparam("dialog", "state_column", "state_c_name")
1032
-...
1033
-
1034
-6.35. start_time_column (string)
1035
-
1036
-   The column name in the database to store the dialog's start time
1037
-   information.
1038
-
1039
-   Default value is “start_time”.
1040
-
1041
-   Example 1.35. Set start_time_column parameter
1042
-...
1043
-modparam("dialog", "start_time_column", "start_time_c_name")
1044
-...
1045
-
1046
-6.36. timeout_column (string)
1047
-
1048
-   The column name in the database to store the dialog's timeout.
1049
-
1050
-   Default value is “timeout”.
1051
-
1052
-   Example 1.36. Set timeout_column parameter
1053
-...
1054
-modparam("dialog", "timeout_column", "timeout_c_name")
1055
-...
1056
-
1057
-6.37. sflags_column (string)
1058
-
1059
-   The column name in the database to store the dialog script flags.
1060
-
1061
-   Default value is “sflags”.
1062
-
1063
-   Example 1.37. Set sflags_column parameter
1064
-...
1065
-modparam("dialog", "sflags_column", "s_flags")
1066
-...
1067
-
1068
-6.38. toroute_name_column (string)
1069
-
1070
-   The column name in the database to store the index of the route to be
1071
-   executed at timeout.
1072
-
1073
-   Default value is “toroute_name”.
1074
-
1075
-   Example 1.38. Set toroute_name_column parameter
1076
-...
1077
-modparam("dialog", "toroute_name_column", "timeout_route")
1078
-...
1079
-
1080
-6.39. vars_table_name (string)
1081
-
1082
-   If you want to store the dialog variables (“$dlg_var(name)”) for a
1083
-   dialog in a database a table name must be specified.
1084
-
1085
-   Default value is “dialog_vars”.
1086
-
1087
-   Example 1.39. Set vars_table_name parameter
1088
-...
1089
-modparam("dialog", "vars_table_name", "my_dialog_vars")
1090
-...
1091
-
1092
-6.40. vars_h_id_column (string)
1093
-
1094
-   The column name in the database to store the dialog's hash id
1095
-   information (as a reference to the dialog table).
1096
-
1097
-   Default value is “hash_id”.
1098
-
1099
-   Example 1.40. Set vars_h_id_column parameter
1100
-...
1101
-modparam("dialog", "vars_h_id_column", "vars_h_id_name")
1102
-...
1103
-
1104
-6.41. vars_h_entry_column (string)
1105
-
1106
-   The column name in the database to store the dialog's hash entry
1107
-   information (as a reference to the dialog table).
1108
-
1109
-   Default value is “hash_entry”.
1110
-
1111
-   Example 1.41. Set vars_h_entry_column parameter
1112
-...
1113
-modparam("dialog", "vars_h_entry_column", "vars_h_entry_name")
1114
-...
1115
-
1116
-6.42. vars_key_column (string)
1117
-
1118
-   The column name in the database to store the names (keys) of a dialog
1119
-   variable.
1120
-
1121
-   Default value is “dialog_key”.
1122
-
1123
-   Example 1.42. Set vars_key_column parameter
1124
-...
1125
-modparam("dialog", "vars_key_column", "vars_key_name")
1126
-...
1127
-
1128
-6.43. vars_value_column (string)
1129
-
1130
-   The column name in the database to store the values of a dialog
1131
-   variable.
1132
-
1133
-   Default value is “dialog_value”.
1134
-
1135
-   Example 1.43. Set vars_value_column parameter
1136
-...
1137
-modparam("dialog", "vars_value_column", "vars_value_name")
1138
-...
1139
-
1140
-6.44. profiles_with_value (string)
1141
-
1142
-   List of names for profiles with values, separated with semi-colon ";".
1143
-
1144
-   Default value is “empty”.
1145
-
1146
-   Example 1.44. Set profiles_with_value parameter
1147
-...
1148
-modparam("dialog", "profiles_with_value", "caller ; my_profile")
1149
-...
1150
-
1151
-6.45. profiles_no_value (string)
1152
-
1153
-   List of names for profiles without values, separated with semi-colon
1154
-   ";".
1155
-
1156
-   Default value is “empty”.
1157
-
1158
-   Example 1.45. Set profiles_no_value parameter
1159
-...
1160
-modparam("dialog", "profiles_no_value", "inbound ; outbound")
1161
-...
1162
-
1163
-6.46. bridge_controller (string)
1164
-
1165
-   SIP address to be used in From header when initiating a call bridge.
1166
-
1167
-   Default value is “sip:controller@kamailio.org”.
1168
-
1169
-   Example 1.46. Set bridge_controller parameter
1170
-...
1171
-modparam("dialog", "bridge_controller", "sip:ctd@kamailio.org")
1172
-...
1173
-
1174
-6.47. bridge_contact (string)
1175
-
1176
-   SIP address to be used in Contact header when doing a call bridge.
1177
-
1178
-   Default value is “sip:controller@kamailio.org:5060”.
1179
-
1180
-   Example 1.47. Set bridge_contact parameter
1181
-...
1182
-modparam("dialog", "bridge_contact", "sip:ctd@127.0.0.1:5060")
1183
-...
1184
-
1185
-6.48. initial_cbs_inscript (int)
1186
-
1187
-   If the initial dialog callbacks (i.e., DLGCB_CREATED and
1188
-   DLGCB_SPIRALED) should be executed in-script or post-script. If
1189
-   dlg_manage() is not used, the setting of this parameter does not
1190
-   matter; otherwise, initial callbacks will be executed directly after
1191
-   dlg_manage() is called if this parameter is enabled. If it is disabled,
1192
-   initial callback execution will be postponed until configuration script
1193
-   execution completes.
1194
-
1195
-   The supported values are:
1196
-     * 0 - POST-SCRIPT - execute initial callbacks after the script
1197
-       completes;
1198
-     * 1 - IN-SCRIPT - execute initial callbacks during script execution,
1199
-       i.e., right after dlg_manage() is called;
1200
-
1201
-   Default value is “1”.
1202
-
1203
-   Example 1.48. Set initial_cbs_inscript parameter
1204
-...
1205
-modparam("dialog", "initial_cbs_inscript", 0)
1206
-...
1207
-
1208
-6.49. send_bye (int)
1209
-
1210
-   If set to 1, BYE requests will be sent out for each dialog that timed
1211
-   out. It is an alternative to $dlg_ctx(timeout_bye)=1 for all dialogs.
1212
-
1213
-   Default value is “0”.
1214
-
1215
-   Example 1.49. Set send_bye parameter
1216
-...
1217
-modparam("dialog", "send_bye", 1)
1218
-...
1219
-
1220
-6.50. wait_ack (int)
1221
-
1222
-   If set to 1, dialog will be kept a bit longer in memory in order to
1223
-   absorb the ACK negative replies of initial INVITE. If not, the dialog
1224
-   is destroyed when negative reply is sent out (less internal
1225
-   complexity).
1226
-
1227
-   Default value is “1”.
1228
-
1229
-   Example 1.50. Set wait_ack parameter
1230
-...
1231
-modparam("dialog", "wait_ack", 0)
1232
-...
1233
-
1234
-6.51. ka_timer (int)
1235
-
1236
-   Keep-alive timer step - how often to execute the callback to send
1237
-   dialog keep alives (SIP OPTIONS requests within dialog). The value
1238
-   represents the number of seconds.
1239
-
1240
-   Default value is “0” (no keep alive).
1241
-
1242
-   Example 1.51. Set ka_timer parameter
1243
-...
1244
-modparam("dialog", "ka_timer", 10)
1245
-...
1246
-
1247
-6.52. ka_interval (int)
1248
-
1249
-   The interval between keep alives within dialog (SIP OPTIONS requests),
1250
-   sent to caller or callee. The keep alive request will be sent by the
1251
-   first callback fired by KA timer after the ka_interval elapsed from
1252
-   dialog setup or previous keep-alive. The value represents the number of
1253
-   seconds.
1254
-
1255
-   If the requests times out (generating a 408) or if the UA responds with
1256
-   481 the lifetime is set to 10 seconds. When lifetime expires the dialog
1257
-   will be terminated. Any other response (including error responses) will
1258
-   reset the timers.
1259
-
1260
-   Default value is “0” (no keep alive). The lowest settable interval is
1261
-   30 seconds.
1262
-
1263
-   Example 1.52. Set ka_interval parameter
1264
-...
1265
-modparam("dialog", "ka_interval", 300)
1266
-...
1267
-
1268
-6.53. ka_failed_limit (int)
1269
-
1270
-   The number of failed keep-alive requests that is accepted before
1271
-   generating a dialog timeout.
1272
-
1273
-   Default value is “1”.
1274
-
1275
-   Example 1.53. Set ka_failed_limit parameter
1276
-...
1277
-modparam("dialog", "ka_failed_limit", 5)
1278
-...
1279
-
1280
-6.54. timeout_noreset (int)
1281
-
1282
-   If set to 1, the dialog timeout won't be reset each time a sequential
1283
-   request is processed. It is an alternative to
1284
-   dlg_set_property("timeout-noreset") for all dialogs.
1285
-
1286
-   Default value is “0”.
1287
-
1288
-   Example 1.54. Set timeout_noreset parameter
1289
-...
1290
-modparam("dialog", "timeout_noreset", 1)
1291
-...
1292
-
1293
-6.55. timer_procs (int)
1294
-
1295
-   If set to 1, the dialog module will start a separate dialog timer
1296
-   process to execute dialog timeout tasks. The default is to use the core
1297
-   timer process.
1298
-
1299
-   Default value is “0” (use core timer process).
1300
-
1301
-   Example 1.55. Set timer_procs parameter
1302
-...
1303
-modparam("dialog", "timer_procs", 1)
1304
-...