Browse code

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

Kamailio Dev authored on 02/03/2022 12:31:49
Showing 4 changed files
... ...
@@ -452,6 +452,11 @@ modparam("auth", "rpid_avp", "$avp(myrpid)")
452 452
    timeout value will be converted to a 180 message. Please note that you
453 453
    need to set a positive timeout value in order to use this function.
454 454
 
455
+   Note: the change of sip reply can be done only in cases when it is not
456
+   parsed too much before config execution, otherwise it fails. For
457
+   example, setting global parameter "log_prefix" can cause this function
458
+   to fail changing the replies.
459
+
455 460
    The function returns TRUE on success, and FALSE during processing
456 461
    failures.
457 462
 
... ...
@@ -103,6 +103,8 @@ modparam("statsc", "interval", 300)
103 103
 
104 104
    How many items to store for each statistic.
105 105
 
106
+   Note: it must be set before any 'track' parameter.
107
+
106 108
    Default value is 100.
107 109
 
108 110
    Example 1.2. Set items parameter
... ...
@@ -55,7 +55,7 @@ Daniel-Constantin Mierla
55 55
               3.26. contact_flows_avp (string)
56 56
               3.27. fr_timer_avp (string)
57 57
               3.28. fr_inv_timer_avp (string)
58
-              3.29. unmatched_cancel (string)
58
+              3.29. unmatched_cancel (integer)
59 59
               3.30. ruri_matching (integer)
60 60
               3.31. via1_matching (integer)
61 61
               3.32. callid_matching (integer)
... ...
@@ -317,7 +317,7 @@ Chapter 1. Admin Guide
317 317
         3.26. contact_flows_avp (string)
318 318
         3.27. fr_timer_avp (string)
319 319
         3.28. fr_inv_timer_avp (string)
320
-        3.29. unmatched_cancel (string)
320
+        3.29. unmatched_cancel (integer)
321 321
         3.30. ruri_matching (integer)
322 322
         3.31. via1_matching (integer)
323 323
         3.32. callid_matching (integer)
... ...
@@ -693,7 +693,7 @@ failure_route["serial"]
693 693
    3.26. contact_flows_avp (string)
694 694
    3.27. fr_timer_avp (string)
695 695
    3.28. fr_inv_timer_avp (string)
696
-   3.29. unmatched_cancel (string)
696
+   3.29. unmatched_cancel (integer)
697 697
    3.30. ruri_matching (integer)
698 698
    3.31. via1_matching (integer)
699 699
    3.32. callid_matching (integer)
... ...
@@ -1290,7 +1290,7 @@ modparam("tm", "fr_inv_timer_avp", "$avp(my_fr_inv_timer)")
1290 1290
 modparam("tm", "fr_inv_timer_avp", "my_fr_inv_timer")
1291 1291
 ...
1292 1292
 
1293
-3.29. unmatched_cancel (string)
1293
+3.29. unmatched_cancel (integer)
1294 1294
 
1295 1295
    This parameter selects between forwarding CANCELs that do not match any
1296 1296
    transaction statefully (0, default value), statelessly (1) or dropping
... ...
@@ -1307,7 +1307,7 @@ modparam("tm", "fr_inv_timer_avp", "my_fr_inv_timer")
1307 1307
 
1308 1308
    Example 1.29. Set unmatched_cancel parameter
1309 1309
 ...
1310
-modparam("tm", "unmatched_cancel", "2")
1310
+modparam("tm", "unmatched_cancel", 2)
1311 1311
 ...
1312 1312
 
1313 1313
 3.30. ruri_matching (integer)
... ...
@@ -93,11 +93,28 @@ modparam("xmlops", "buf_size", 8192)
93 93
 3.2. xml_ns (str)
94 94
 
95 95
    Register xml namespace prefix. Parameter value must have the format:
96
-   'prefix=uri'.
96
+   'prefix=uri'. It can be set many times to cope with multiple namespaces
97
+   without prefix.
98
+
99
+   This is useful when it is needed to access XML documents that specify
100
+   xmlns without prefix, which is not XML-standard compliant, but it comes
101
+   with SIP SIMPLE presence bodies.
97 102
 
98 103
    Example 1.2. Set xml_ns parameter
99 104
 ...
100 105
 modparam("xmlops", "xml_ns", "rpid=urn:ietf:params:xml:ns:pidf:rpid")
106
+modparam("xmlops", "xml_ns", "pidf=urn:ietf:params:xml:ns:pidf")
107
+...
108
+$xml(x=>doc) = '<?xml version="1.0" encoding="utf-8"?>
109
+    <presence xmlns="urn:ietf:params:xml:ns:pidf" entity="sip:test@mydomain.com"
110
+>
111
+        <tuple id="86ae65b7-42de-4399-b635-295caad13aac">
112
+            <status><basic>none</basic></status>
113
+        </tuple>
114
+    </presence>';
115
+
116
+xinfo("status: $xml(x=>xpath:/pidf:presence/pidf:tuple/pidf:status/pidf:basic)\n
117
+");
101 118
 ...
102 119
 
103 120
 4. Pseudo-Variables