Browse code

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

Kamailio Dev authored on 08/08/2022 13:31:21
Showing 1 changed files
... ...
@@ -63,6 +63,8 @@ Camille Oudot
63 63
               3.22. trace_mode (integer)
64 64
               3.23. auth_key (integer)
65 65
               3.24. evcb_msg (str)
66
+              3.25. trace_dialog_ack (str)
67
+              3.26. trace_dialog_spiral (str)
66 68
 
67 69
         4. Functions
68 70
 
... ...
@@ -106,10 +108,12 @@ Camille Oudot
106 108
    1.21. Set trace_mode parameter
107 109
    1.22. Set auth_key parameter
108 110
    1.23. Set evcb_msg parameter
109
-   1.24. sip_trace() usage
110
-   1.25. sip_trace_mode() usage
111
-   1.26. hlog() usage
112
-   1.27. Send relayed ACK message
111
+   1.24. Set trace_dialog_ack parameter
112
+   1.25. Set trace_dialog_spiral parameter
113
+   1.26. sip_trace() usage
114
+   1.27. sip_trace_mode() usage
115
+   1.28. hlog() usage
116
+   1.29. Send relayed ACK message
113 117
 
114 118
 Chapter 1. Admin Guide
115 119
 
... ...
@@ -147,6 +151,8 @@ Chapter 1. Admin Guide
147 151
         3.22. trace_mode (integer)
148 152
         3.23. auth_key (integer)
149 153
         3.24. evcb_msg (str)
154
+        3.25. trace_dialog_ack (str)
155
+        3.26. trace_dialog_spiral (str)
150 156
 
151 157
    4. Functions
152 158
 
... ...
@@ -231,6 +237,8 @@ Chapter 1. Admin Guide
231 237
    3.22. trace_mode (integer)
232 238
    3.23. auth_key (integer)
233 239
    3.24. evcb_msg (str)
240
+   3.25. trace_dialog_ack (str)
241
+   3.26. trace_dialog_spiral (str)
234 242
 
235 243
 3.1. db_url (str)
236 244
 
... ...
@@ -565,6 +573,28 @@ modparam("siptrace", "auth_key", "spoihepuirthpeuia")
565 573
 modparam("siptrace", "evcb_msg", "ksr_siptrace_msg")
566 574
 ...
567 575
 
576
+3.25. trace_dialog_ack (str)
577
+
578
+   Enable tracing of in-dialog ACK.
579
+
580
+   Default value is 1 (enabled).
581
+
582
+   Example 1.24. Set trace_dialog_ack parameter
583
+...
584
+modparam("siptrace", "trace_dialog_ack", 1)
585
+...
586
+
587
+3.26. trace_dialog_spiral (str)
588
+
589
+   Enable tracing of dialog spirals.
590
+
591
+   Default value is 1 (enabled).
592
+
593
+   Example 1.25. Set trace_dialog_spiral parameter
594
+...
595
+modparam("siptrace", "trace_dialog_spiral", 1)
596
+...
597
+
568 598
 4. Functions
569 599
 
570 600
    4.1. sip_trace([address][,correlation_id][,mode])
... ...
@@ -595,7 +625,7 @@ modparam("siptrace", "evcb_msg", "ksr_siptrace_msg")
595 625
    ONREPLY_ROUTE, BRANCH_ROUTE.
596 626
    Default value is "NULL".
597 627
 
598
-   Example 1.24. sip_trace() usage
628
+   Example 1.26. sip_trace() usage
599 629
 ...
600 630
 sip_trace();
601 631
 ...
... ...
@@ -621,7 +651,7 @@ sip_trace("sip:10.1.1.2:5085", "$ci-abc", "d");
621 651
 
622 652
    This function can be used in ANY_ROUTE.
623 653
 
624
-   Example 1.25. sip_trace_mode() usage
654
+   Example 1.27. sip_trace_mode() usage
625 655
 ...
626 656
 sip_trace_mode("t");
627 657
 ...
... ...
@@ -638,7 +668,7 @@ sip_trace_mode("t");
638 668
      * message - The text to send to Homer as log event. (This parameter
639 669
        may contain PVs)
640 670
 
641
-   Example 1.26. hlog() usage
671
+   Example 1.28. hlog() usage
642 672
 ...
643 673
 hlog("[cfg:$cfg(line)] This is a log from kamailio to Homer");
644 674
 ...
... ...
@@ -712,7 +742,7 @@ event_route[siptrace:msg] {
712 742
    this name will result in overlapping internal avp used by the module
713 743
    therefore causing unknown consequences.
714 744
 
715
-   Example 1.27. Send relayed ACK message
745
+   Example 1.29. Send relayed ACK message
716 746
 ...
717 747
 onsend_route {
718 748
     if (is_method("ACK")) {