/
README
2360 lines (1793 loc) · 77 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
dialog Module
__________________________________________________________
Table of Contents
1. Admin Guide
1.1. Overview
1.2. How it works
1.3. Dialog profiling
1.4. Dialog clustering
1.5. Dependencies
1.5.1. OpenSIPS Modules
1.5.2. External Libraries or Applications
1.6. Exported Parameters
1.6.1. enable_stats (integer)
1.6.2. hash_size (integer)
1.6.3. log_profile_hash_size (integer)
1.6.4. rr_param (string)
1.6.5. default_timeout (integer)
1.6.6. dlg_extra_hdrs (string)
1.6.7. dlg_match_mode (integer)
1.6.8. db_url (string)
1.6.9. db_mode (integer)
1.6.10. db_update_period (integer)
1.6.11. options_ping_interval (integer)
1.6.12. reinvite_ping_interval (integer)
1.6.13. table_name (string)
1.6.14. call_id_column (string)
1.6.15. from_uri_column (string)
1.6.16. from_tag_column (string)
1.6.17. to_uri_column (string)
1.6.18. to_tag_column (string)
1.6.19. from_cseq_column (string)
1.6.20. to_cseq_column (string)
1.6.21. from_route_column (string)
1.6.22. to_route_column (string)
1.6.23. from_contact_column (string)
1.6.24. to_contact_column (string)
1.6.25. from_sock_column (string)
1.6.26. to_sock_column (string)
1.6.27. dlg_id_column (string)
1.6.28. state_column (string)
1.6.29. start_time_column (string)
1.6.30. timeout_column (string)
1.6.31. profiles_column (string)
1.6.32. vars_column (string)
1.6.33. sflags_column (string)
1.6.34. mflags_column (string)
1.6.35. flags_column (string)
1.6.36. profiles_with_value (string)
1.6.37. profiles_no_value (string)
1.6.38. db_flush_vals_profiles (int)
1.6.39. timer_bulk_del_no (int)
1.6.40. race_condition_timeout (int)
1.6.41. cachedb_url (string)
1.6.42. profile_value_prefix (string)
1.6.43. profile_no_value_prefix (string)
1.6.44. profile_size_prefix (string)
1.6.45. profile_timeout (int)
1.6.46. dialog_replication_cluster (int)
1.6.47. profile_replication_cluster (int)
1.6.48. replicate_profiles_buffer (string)
1.6.49. replicate_profiles_check (string)
1.6.50. replicate_profiles_timer (string)
1.6.51. replicate_profiles_expire (string)
1.7. Exported Functions
1.7.1. create_dialog([flags])
1.7.2. match_dialog([dlg_match_mode])
1.7.3. validate_dialog()
1.7.4. fix_route_dialog()
1.7.5. get_dialog_info(attr,avp,key,key_val,no_dlgs)
1.7.6. get_dialog_vals(names,vals,callid)
1.7.7.
get_dialogs_by_val(name,value,out_avp,out_dlg_
no)
1.7.8.
get_dialogs_by_profile(name,value,out_avp,out_
dlg_no)
1.7.9. set_dlg_profile(profile,[value])
1.7.10. unset_dlg_profile(profile,[value])
1.7.11. is_in_profile(profile,[value])
1.7.12. get_profile_size(profile,[value],size)
1.7.13. set_dlg_flag(idx)
1.7.14. test_and_set_dlg_flag(idx, value)
1.7.15. reset_dlg_flag(idx)
1.7.16. is_dlg_flag_set(idx)
1.7.17. store_dlg_value(name,val)
1.7.18. fetch_dlg_value(name,val)
1.7.19. set_dlg_sharing_tag(tag_name)
1.8. Exported Statistics
1.8.1. active_dialogs
1.8.2. early_dialogs
1.8.3. processed_dialogs
1.8.4. expired_dialogs
1.8.5. failed_dialogs
1.8.6. create_sent
1.8.7. update_sent
1.8.8. delete_sent
1.8.9. create_recv
1.8.10. update_recv
1.8.11. delete_recv
1.9. Exported MI Functions
1.9.1. dlg_list
1.9.2. dlg_list_ctx
1.9.3. dlg_end_dlg
1.9.4. profile_get_size
1.9.5. profile_list_dlgs
1.9.6. profile_get_values
1.9.7. profile_end_dlgs
1.9.8. dlg_db_sync
1.9.9. dlg_cluster_sync
1.9.10. dlg_restore_db
1.9.11. list_all_profiles
1.9.12. dlg_push_var
1.9.13. dlg_send_sequential
1.10. Exported Pseudo-Variables
1.10.1. $DLG_count
1.10.2. $DLG_status
1.10.3. $DLG_lifetime
1.10.4. $DLG_flags
1.10.5. $DLG_dir
1.10.6. $DLG_did
1.10.7. $DLG_end_reason
1.10.8. $DLG_timeout
1.10.9. $DLG_json
1.10.10. $DLG_ctx_json
1.10.11. $dlg_val(name)
1.11. Exported Events
1.11.1. E_DLG_STATE_CHANGED
2. Developer Guide
2.1. Available Functions
2.1.1. register_dlgcb (dialog, type, cb, param,
free_param_cb)
3. Frequently Asked Questions
4. Contributors
4.1. By Commit Statistics
4.2. By Commit Activity
5. Documentation
5.1. Contributors
List of Tables
4.1. Top contributors by DevScore^(1), authored commits^(2) and
lines added/removed^(3)
4.2. Most recently active contributors^(1) to this module
List of Examples
1.1. Set enable_stats parameter
1.2. Set hash_size parameter
1.3. Set hash_size parameter
1.4. Set rr_param parameter
1.5. Set default_timeout parameter
1.6. Set dlf_extra_hdrs parameter
1.7. Set dlg_match_mode parameter
1.8. Set db_url parameter
1.9. Set db_mode parameter
1.10. Set db_update_period parameter
1.11. Set options_ping_interval parameter
1.12. Set reinvite_ping_interval parameter
1.13. Set table_name parameter
1.14. Set call_id_column parameter
1.15. Set from_uri_column parameter
1.16. Set from_tag_column parameter
1.17. Set to_uri_column parameter
1.18. Set to_tag_column parameter
1.19. Set from_cseq_column parameter
1.20. Set to_cseq_column parameter
1.21. Set from_route_column parameter
1.22. Set to_route_column parameter
1.23. Set from_contact_column parameter
1.24. Set to_contact_column parameter
1.25. Set from_sock_column parameter
1.26. Set to_sock_column parameter
1.27. Set dlg_id_column parameter
1.28. Set state_column parameter
1.29. Set start_time_column parameter
1.30. Set timeout_column parameter
1.31. Set profiles_column parameter
1.32. Set vars_column parameter
1.33. Set sflags_column parameter
1.34. Set mflags_column parameter
1.35. Set flags_column parameter
1.36. Set profiles_with_value parameter
1.37. Set profiles_no_value parameter
1.38. Set db_flush_vals_profiles parameter
1.39. Set timer_bulk_del_no parameter
1.40. Set race_condition_timeout parameter
1.41. Set cachedb_url parameter
1.42. Set profile_value_prefix parameter
1.43. Set profile_no_value_prefix parameter
1.44. Set profile_size_prefix parameter
1.45. Set profile_timeout parameter
1.46. Set dialog_replication_cluster parameter
1.47. Set profile_replication_cluster parameter
1.48. Set replicate_profiles_buffer parameter
1.49. Set replicate_profiles_check parameter
1.50. Set replicate_profiles_timer parameter
1.51. Set replicate_profiles_expire parameter
1.52. create_dialog() usage
1.53. match_dialog() usage
1.54. validate_dialog() usage
1.55. fix_route_dialog() usage
1.56. get_dialog_info usage
1.57. get_dialog_vals usage
1.58. get_dialog_vals usage
1.59. get_dialog_vals usage
1.60. set_dlg_profile usage
1.61. unset_dlg_profile usage
1.62. is_in_profile usage
1.63. get_profile_size usage
1.64. set_dlg_flag usage
1.65. test_and_set_dlg_flag usage
1.66. reset_dlg_flag usage
1.67. is_dlg_flag_set usage
1.68. store_dlg_value usage
1.69. fetch_dlg_value usage
1.70. set_dlg_sharing_tag usage
Chapter 1. Admin Guide
1.1. Overview
The dialog module provides dialog awareness to the OpenSIPS
proxy. Its functionality is to keep trace of the current
dialogs, to offer information about them (like how many dialogs
are active).
Aside tracking, the dialog module offers functionalities like
flags and attributes per dialog (persistent data across
dialog), dialog profiling and dialog termination (on timeout
base or external triggered).
The module, via an internal API, also provide the foundation to
build on top of it more complex dialog-based functionalities
via other OpenSIPS modules.
1.2. How it works
To create the dialog associated with an initial request, you
must call the create_dialog() function, with or without
parameter.
The dialog is automatically destroyed when a “BYE” is received.
In case of no “BYE”, the dialog lifetime is controlled via the
default timeout (see “default_timeout” - default_timeout) and
custom timeout (see “$DLG_timeout” - $DLG_timeout).
1.3. Dialog profiling
Dialog profiling is a mechanism that helps in classifying,
sorting and keeping trace of certain types of dialogs, using
whatever properties of the dialog (like caller, destination,
type of calls, etc). Dialogs can be dynamically added in
different (and several) profile tables - logically, each
profile table can have a special meaning (like dialogs outside
the domain, dialogs terminated to PSTN, etc).
There are two types of profiles:
* with no value - a dialog simply belongs to a profile. (like
outbound calls profile). There is no other additional
information to describe the dialog's belonging to the
profile;
* with value - a dialog belongs to a profile having a certain
value (like in caller profile, where the value is the
caller ID). The belonging of the dialog to the profile is
strictly related to the value.
A dialog can be added to multiple profiles in the same time.
Profiles are visible (at the moment) in the request route (for
initial and sequential requests) and in the branch, failure and
reply routes of the original request.
Dialog profiles can also be used in distributed systems, using
the OpenSIPS CacheDB Interface or the clusterer module. This
feature allows you to share dialog profile information with
multiple OpenSIPS instaces that use the same CacheDB backend or
are part of an OpenSIPS cluster. In order to do that, the
cachedb_url or profile_replication_cluster parameters must be
defined. Also, the profile must be marked as shared, by adding
one of the '/s' or '/b' suffixes to the name of the profile in
the profiles_with_value or profiles_no_value parameters.
1.4. Dialog clustering
Dialog replication is a mechanism used to mirror all dialog
changes taking place in one OpenSIPS instance to one or
multiple other instances. The process is simplified by using
the clusterer module which facilitates the management of a
cluster of OpenSIPS nodes and the sending of
replication-related BIN packets (binary-encoded, using
proto_bin). This feature is useful in achieving High
Availability and/or Load Balancing for ongoing calls.
Configuring both receival and sending of dialog replication
packets is trivial and can be done by using the
dialog_replication_cluster parameter. But in addition to just
sharing data, in order to properly cluster dialogs you will
need to manage which node in the cluster is doing certain
actions on certain dialogs using the sharing tags mechanism.
For details and configuration examples on how this would work
in different usage scenarios, see this article.
The following actions will not be performed for a dialog marked
with a sharing tag that is in the "backup" state:
* sending Re-Invite or OPTIONS pings to end-points
* generating BYE requests or any other actions(like producing
CDRs) upon dialog expiration
* sending replication packets on dialog events(update,
delete)
* counting the dialog in the profiles that it belongs; only
if profile replication is also enabled
In addition to the event-driven replication, an OpenSIPS
instance will first try to learn all the dialog information
from antoher node in the cluster at startup. The data
synchronization mechanism requires defining one of the nodes in
the cluster as a "seed" node. See the clusterer module for
details on how to do this and why is it needed.
In the context of dialog replication, using a database as a
failsafe for obtaining restart persistency for dialog data is
useful in case all nodes in the cluster are down. This approach
makes the most sense if a separate, local DB is used for each
node in the cluster. In consequence dialogs loaded from the
database at startup are dropped and also deleted from the DB
once the sync from cluster is complete. This is done for
dialogs that are not reconfirmed as being active in the
meantime (SIP updates, received in sync data).
Also configuring profile replication via the
profile_replication_cluster parameter is not necessary when
dialog replication is already configured. The profile
information is included in the dialog updates sent in the
dialog replication cluster. The profiles must still be marked
for sharing though in the profiles_with_value or
profiles_no_value parameters.
A scenario were both profile and dialog replication should be
configured is when a platform has multiple POPs, where separate
dialog replication clusters are configured for HA purposes, and
a cluster for globally shared profiles is also required. In
this case, proper counting for dialogs is ensured by using the
sharing tags mechanism(in order to avoid counting each dialog
twice, both on the active and backup node for that dialog).
1.5. Dependencies
1.5.1. OpenSIPS Modules
The following modules must be loaded before this module:
* TM - Transaction module
* RR - Record-Route module, optional, if Dialog ID matching
is used in non Topo Hiding cases
* clusterer - if replication_cluster parameter is set
(contact replication via clusterer module)
1.5.2. External Libraries or Applications
The following libraries or applications must be installed
before running OpenSIPS with this module loaded:
* None.
1.6. Exported Parameters
1.6.1. enable_stats (integer)
If the statistics support should be enabled or not. Via
statistic variables, the module provide information about the
dialog processing. Set it to zero to disable or to non-zero to
enable it.
Default value is “1 (enabled)”.
Example 1.1. Set enable_stats parameter
...
modparam("dialog", "enable_stats", 0)
...
1.6.2. hash_size (integer)
The size of the hash table internally used to keep the dialogs.
A larger table is much faster but consumes more memory. The
hash size must be a power of 2 number.
IMPORTANT: If dialogs' information should be stored in a
database, a constant hash_size should be used, otherwise the
restored process will not take place. If you really want to
modify the hash_size you must delete all table's rows before
restarting OpenSIPS.
Default value is “4096”.
Example 1.2. Set hash_size parameter
...
modparam("dialog", "hash_size", 1024)
...
1.6.3. log_profile_hash_size (integer)
The size of the hash table internally used to store
profile->dialog associations. A larger table can provide more
parallel operations but consumes more memory. The hash size is
provided as the base 2 logarithm(e.g. log_profile_hash_size =4
means the table has 2^4 entries).
Default value is “4”.
Example 1.3. Set hash_size parameter
...
modparam("dialog", "log_profile_hash_size", 5) #set a table size of 32
...
1.6.4. rr_param (string)
Name of the Record-Route parameter to be added with the dialog
cookie. It is used for fast dialog matching of the sequential
requests.
Default value is “did”.
Example 1.4. Set rr_param parameter
...
modparam("dialog", "rr_param", "xyz")
...
1.6.5. default_timeout (integer)
The default dialog timeout (in seconds) if no custom one is
set.
Default value is “43200 (12 hours)”.
Example 1.5. Set default_timeout parameter
...
modparam("dialog", "default_timeout", 21600)
...
1.6.6. dlg_extra_hdrs (string)
A string containing the extra headers (full format, with EOH)
to be added in the requests generated by the module (like
BYEs).
Default value is “NULL”.
Example 1.6. Set dlf_extra_hdrs parameter
...
modparam("dialog", "dlg_extra_hdrs", "Hint: credit expired\r\n")
...
1.6.7. dlg_match_mode (integer)
How the seqential requests should be matched against the known
dialogs. The modes are a combination between matching based on
a cookie (DID) stored as cookie in Record-Route header and the
matching based on SIP elements (as in RFC3261).
The supported modes are:
* 0 - DID_ONLY - the match is done exclusively based on DID;
* 1 - DID_FALLBACK - the match is first tried based on DID
and if not present, it will fallback to SIP matching;
* 2 - DID_NONE - the match is done exclusively based on SIP
elements; no DID information is added in RR.
Default value is “1 (DID_FALLBACK)”.
NOTE that if you have call looping on your OpenSIPS server
(passing more than once through the same OpenSIPS instance), it
is strongly suggested to use only DID_ONLY mode, as the SIP
based matching will have an undefined behavior - from SIP
perspective, a sequential dialog will match all the loops of
the call, as the Call-ID, To and From TAGs are the same.
Example 1.7. Set dlg_match_mode parameter
...
modparam("dialog", "dlg_match_mode", 0)
...
1.6.8. db_url (string)
If you want to store the information about the dialogs in a
database a database url must be specified.
Default value is
“mysql://opensips:opensipsrw@localhost/opensips”.
Example 1.8. Set db_url parameter
...
modparam("dialog", "db_url", "dbdriver://username:password@dbhost/dbname
")
...
1.6.9. db_mode (integer)
Describe how to push into the DB the dialogs' information from
memory.
The supported modes are:
* 0 - NO_DB - the memory content is not flushed into DB;
* 1 - REALTIME - any dialog information changes will be
reflected into the database immediately.
* 2 - DELAYED - the dialog information changes will be
flushed into the DB periodically, based on a timer routine.
* 3 - SHUTDOWN - the dialog information will be flushed into
DB only at shutdown - no runtime updates.
Default value is “0”.
Example 1.9. Set db_mode parameter
...
modparam("dialog", "db_mode", 1)
...
1.6.10. db_update_period (integer)
The interval (seconds) at which to update dialogs' information
if you chose to store the dialogs' info at a given interval. A
too short interval will generate intensive database operations,
a too large one will not notice short dialogs.
Default value is “60”.
Example 1.10. Set db_update_period parameter
...
modparam("dialog", "db_update_period", 120)
...
1.6.11. options_ping_interval (integer)
The interval (seconds) at which OpenSIPS will generate
in-dialog OPTIONS pings for one or both of the involved
parties.
Default value is “30”.
Example 1.11. Set options_ping_interval parameter
...
modparam("dialog", "options_ping_interval", 20)
...
1.6.12. reinvite_ping_interval (integer)
The interval (seconds) at which OpenSIPS will generate
in-dialog Re-INVITE pings for one or both of the involved
parties.
Important: the ping timeout detection is performed every time
this interval ticks, not when the re-INVITE transaction times
out! Consequently, please make sure that the timeouts for
re-INVITE transactions (e.g. the "fr_timeout" modparam of the
"tm" module or its $T_fr_timeout variable) are always lower
than the value of this parameter! Failing to ensure this
ordering of timeouts may possibly lead to re-INVITE pings never
ending a disconnected dialog due to pings getting retried
before getting a chance to properly time out.
Default value is “300”.
Example 1.12. Set reinvite_ping_interval parameter
...
modparam("dialog", "reinvite_ping_interval", 600)
...
1.6.13. table_name (string)
If you want to store the information about the dialogs in a
database a table name must be specified.
Default value is “dialog”.
Example 1.13. Set table_name parameter
...
modparam("dialog", "table_name", "my_dialog")
...
1.6.14. call_id_column (string)
The column's name in the database to store the dialogs' callid.
Default value is “callid”.
Example 1.14. Set call_id_column parameter
...
modparam("dialog", "call_id_column", "callid_c_name")
...
1.6.15. from_uri_column (string)
The column's name in the database to store the caller's sip
address.
Default value is “from_uri”.
Example 1.15. Set from_uri_column parameter
...
modparam("dialog", "from_uri_column", "from_uri_c_name")
...
1.6.16. from_tag_column (string)
The column's name in the database to store the From tag from
the Invite request.
Default value is “from_tag”.
Example 1.16. Set from_tag_column parameter
...
modparam("dialog", "from_tag_column", "from_tag_c_name")
...
1.6.17. to_uri_column (string)
The column's name in the database to store the calee's sip
address.
Default value is “to_uri”.
Example 1.17. Set to_uri_column parameter
...
modparam("dialog", "to_uri_column", "to_uri_c_name")
...
1.6.18. to_tag_column (string)
The column's name in the database to store the To tag from the
200 OK response to the Invite request, if present.
Default value is “to_tag”.
Example 1.18. Set to_tag_column parameter
...
modparam("dialog", "to_tag_column", "to_tag_c_name")
...
1.6.19. from_cseq_column (string)
The column's name in the database to store the cseq from caller
side.
Default value is “caller_cseq”.
Example 1.19. Set from_cseq_column parameter
...
modparam("dialog", "from_cseq_column", "from_cseq_c_name")
...
1.6.20. to_cseq_column (string)
The column's name in the database to store the cseq from callee
side.
Default value is “callee_cseq”.
Example 1.20. Set to_cseq_column parameter
...
modparam("dialog", "to_cseq_column", "to_cseq_c_name")
...
1.6.21. from_route_column (string)
The column's name in the database to store the route records
from caller side (proxy to caller).
Default value is “caller_route_set”.
Example 1.21. Set from_route_column parameter
...
modparam("dialog", "from_route_column", "from_route_c_name")
...
1.6.22. to_route_column (string)
The column's name in the database to store the route records
from callee side (proxy to callee).
Default value is “callee_route_set”.
Example 1.22. Set to_route_column parameter
...
modparam("dialog", "to_route_column", "to_route_c_name")
...
1.6.23. from_contact_column (string)
The column's name in the database to store the caller's contact
uri.
Default value is “caller_contact”.
Example 1.23. Set from_contact_column parameter
...
modparam("dialog", "from_contact_column", "from_contact_c_name")
...
1.6.24. to_contact_column (string)
The column's name in the database to store the callee's contact
uri.
Default value is “callee_contact”.
Example 1.24. Set to_contact_column parameter
...
modparam("dialog", "to_contact_column", "to_contact_c_name")
...
1.6.25. from_sock_column (string)
The column's name in the database to store the information
about the local interface receiving the traffic from caller.
Default value is “caller_sock”.
Example 1.25. Set from_sock_column parameter
...
modparam("dialog", "from_sock_column", "from_sock_c_name")
...
1.6.26. to_sock_column (string)
The column's name in the database to store information about
the local interface receiving the traffic from callee.
Default value is “callee_sock”.
Example 1.26. Set to_sock_column parameter
...
modparam("dialog", "to_sock_column", "to_sock_c_name")
...
1.6.27. dlg_id_column (string)
The column's name in the database to store the dialogs' id
information.
Default value is “hash_id”.
Example 1.27. Set dlg_id_column parameter
...
modparam("dialog", "dlg_id_column", "dlg_id_c_name")
...
1.6.28. state_column (string)
The column's name in the database to store the dialogs' state
information.
Default value is “state”.
Example 1.28. Set state_column parameter
...
modparam("dialog", "state_column", "state_c_name")
...
1.6.29. start_time_column (string)
The column's name in the database to store the dialogs' start
time information.
Default value is “start_time”.
Example 1.29. Set start_time_column parameter
...
modparam("dialog", "start_time_column", "start_time_c_name")
...
1.6.30. timeout_column (string)
The column's name in the database to store the dialogs'
timeout.
Default value is “timeout”.
Example 1.30. Set timeout_column parameter
...
modparam("dialog", "timeout_column", "timeout_c_name")
...
1.6.31. profiles_column (string)
The column's name in the database to store the dialogs'
profiles.
Default value is “profiles”.
Example 1.31. Set profiles_column parameter
...
modparam("dialog", "profiles_column", "profiles_c_name")
...
1.6.32. vars_column (string)
The column's name in the database to store the dialogs' vars.
Default value is “vars”.
Example 1.32. Set vars_column parameter
...
modparam("dialog", "vars_column", "vars_c_name")
...
1.6.33. sflags_column (string)
The column's name in the database to store the dialogs' script
flags.
Default value is “script_flags”.
Example 1.33. Set sflags_column parameter
...
modparam("dialog", "sflags_column", "sflags_c_name")
...
1.6.34. mflags_column (string)
The column's name in the database to store the dialogs' module
flags.
Default value is “module_flags”.
Example 1.34. Set mflags_column parameter
...
modparam("dialog", "mflags_column", "mflags_c_name")
...
1.6.35. flags_column (string)
The column's name in the database to store the dialogs' flags.
Default value is “flags”.
Example 1.35. Set flags_column parameter
...
modparam("dialog", "flags_column", "flags_c_name")
...
1.6.36. profiles_with_value (string)
List of names for profiles with values. Flags /b or /s allow
sharing profiles between OpenSIPS instances using the clusterer
module or a CacheDB backend, respectively.
Default value is “empty”.
Example 1.36. Set profiles_with_value parameter
...
modparam("dialog", "profiles_with_value", "caller ; my_profile; share/s;
repl/b;")
...
1.6.37. profiles_no_value (string)
List of names for profiles without values. Flags /b or /s allow
sharing profiles between OpenSIPS instances using the clusterer
module or a CacheDB backend, respectively.
Default value is “empty”.
Example 1.37. Set profiles_no_value parameter
...
modparam("dialog", "profiles_no_value", "inbound ; outbound ; shared/s;
repl/b;")
...
1.6.38. db_flush_vals_profiles (int)
Pushes dialog values, profiles and flags into the database
along with other dialog state information (see db_mode 1 and
2).
Default value is “empty”.
Example 1.38. Set db_flush_vals_profiles parameter
...
modparam("dialog", "db_flush_vals_profiles", 1)
...
1.6.39. timer_bulk_del_no (int)
The number of dialogs that should be attempted to be deleted at
the same time ( a single query ) from the DB back-end.
Default value is “1”.
Example 1.39. Set timer_bulk_del_no parameter
...
modparam("dialog", "timer_bulk_del_no", 10)
...
1.6.40. race_condition_timeout (int)
If dialog is created using the 'E' flag, and a 200OK with
CANCEL race condition occurs, then the dialog will be
terminated after 'race_condition_timeout' seconds.
Default value is “5” seconds.
Example 1.40. Set race_condition_timeout parameter
...
modparam("dialog", "race_condition_timeout", 1)
...
1.6.41. cachedb_url (string)
Enables distributed dialog profiles and specifies the backend
that should be used by the CacheDB interface.
Default value is “empty”.
Example 1.41. Set cachedb_url parameter
...
modparam("dialog", "cachedb_url", "redis://127.0.0.1:6379")
...
1.6.42. profile_value_prefix (string)
Specifies what prefix should be added to the profiles with
value when they are inserted into CacheDB backed. This is only
used when distributed profiles are enabled.
Default value is “dlg_val_”.
Example 1.42. Set profile_value_prefix parameter
...
modparam("dialog", "profile_value_prefix", "dlgv_")
...
1.6.43. profile_no_value_prefix (string)
Specifies what prefix should be added to the profiles without
value when they are inserted into CacheDB backed. This is only
used when distributed profiles are enabled.
Default value is “dlg_noval_”.
Example 1.43. Set profile_no_value_prefix parameter
...
modparam("dialog", "profile_no_value_prefix", "dlgnv_")
...
1.6.44. profile_size_prefix (string)
Specifies what prefix should be added to the entity that holds
the profiles with value size in CacheDB backed. This is only
used when distributed profiles are enabled.
Default value is “dlg_size_”.
Example 1.44. Set profile_size_prefix parameter
...
modparam("dialog", "profile_size_prefix", "dlgs_")
...
1.6.45. profile_timeout (int)
Specifies how long a dialog profile should be kept in the
CacheDB until it expires. This is only used when distributed
profiles are enabled.
Default value is “86400”.
Example 1.45. Set profile_timeout parameter
...
modparam("dialog", "profile_timeout", "43200")
...
1.6.46. dialog_replication_cluster (int)
Specifies the cluster ID for dialog replication using the
clusterer module. This enables sending and receiving all the
dialog-related events (creation, update and deletion) in the
cluster.