Browse code

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

Kamailio Dev authored on 15/09/2022 11:48:10
Showing 7 changed files
... ...
@@ -143,7 +143,8 @@ Chapter 1. Admin Guide
143 143
 
144 144
 2. Dependencies
145 145
 
146
-   The module does not depend on any other module.
146
+   The following modules must be loaded before this module:
147
+     * sl - stateless reply.
147 148
 
148 149
 3. Parameters
149 150
 
... ...
@@ -757,11 +757,11 @@ $ kamcmd cfgutils.get_gflags
757 757
    Example 1.34. RANDOM pseudo-variable usage
758 758
 ...
759 759
 if (rand_event()) {
760
-  $avp(i:10) = ($RANDOM / 16777216); # 2^24
761
-  if ($avp(i:10) < 10) {
762
-     $avp(i:10) = 10;
760
+  $var(value) = ($RANDOM / 16777216); # 2^24
761
+  if ($var(value) < 10) {
762
+     $var(value) = 10;
763 763
   }
764
-  append_to_reply("Retry-After: $avp(i:10)\n");
764
+  append_to_reply("Retry-After: $var(value)\n");
765 765
   sl_send_reply("503", "Try later");
766 766
   exit;
767 767
 };
... ...
@@ -197,7 +197,8 @@ modparam("db_cluster", "max_query_length", 5)
197 197
 modparam("db_cluster", "connection",
198 198
              "c1=>mysql://kamailio:kamailiorw@localhost/kamailio1")
199 199
 modparam("db_cluster", "connection",
200
-             "c2=>mysql://kamailio:kamailiorw@localhost/kamailio2")
200
+             "c2=>mysql://kamailio:kamailiorw@remotehost/kamailio2")
201
+
201 202
 modparam("db_cluster", "cluster", "k1=>c1=9r9p;c2=9r9p")
202 203
 
203 204
 modparam("acc", "db_url", "cluster://k1")
... ...
@@ -706,9 +706,11 @@ if(is_rfc1918("$rd")) {
706 706
 5.9.  set_contact_alias([trim])
707 707
 
708 708
    Adds an “;alias=ip~port~transport” parameter to the contact URI
709
-   containing the received ip, port, and transport protocol. The new
710
-   contact URI is immediately visible to other modules in the way the
711
-   fix_nated_contact() does it.
709
+   containing the received ip, port, and transport protocol. The update of
710
+   contact URI is signaled to a few other modules in the way the
711
+   fix_nated_contact() does it by using the internal flags. The new value
712
+   is not visible to pseudo-variables and it does not change the SIP
713
+   message buffer.
712 714
 
713 715
    Meaning of parameters:
714 716
      * trim - by default, set_contact_alias() will not detect and trim an
... ...
@@ -514,5 +514,5 @@ modparam("ratelimit", "pipe", "4:NETWORK:10000")
514 514
 
515 515
    The pipes and queues are stored as static vectors, so no more than
516 516
    MAX_PIPES/MAX_QUEUES can be added without recompilation.
517
-     * MAX_PIPES - 16
518
-     * MAX_QUEUES - 10
517
+     * MAX_PIPES - 32
518
+     * MAX_QUEUES - 32
... ...
@@ -144,7 +144,7 @@ Daniel-Constantin Mierla
144 144
               5.1. tm.list
145 145
               5.2. tm.t_uac_start
146 146
               5.3. tm.t_uac_wait
147
-              5.4. tm.t_uac_wait
147
+              5.4. tm.t_uac_wait_block
148 148
               5.5. tm.cancel
149 149
               5.6. tm.hash_stats
150 150
               5.7. tm.reply
... ...
@@ -404,7 +404,7 @@ Chapter 1. Admin Guide
404 404
         5.1. tm.list
405 405
         5.2. tm.t_uac_start
406 406
         5.3. tm.t_uac_wait
407
-        5.4. tm.t_uac_wait
407
+        5.4. tm.t_uac_wait_block
408 408
         5.5. tm.cancel
409 409
         5.6. tm.hash_stats
410 410
         5.7. tm.reply
... ...
@@ -2975,7 +2975,7 @@ t_clean();
2975 2975
    5.1. tm.list
2976 2976
    5.2. tm.t_uac_start
2977 2977
    5.3. tm.t_uac_wait
2978
-   5.4. tm.t_uac_wait
2978
+   5.4. tm.t_uac_wait_block
2979 2979
    5.5. tm.cancel
2980 2980
    5.6. tm.hash_stats
2981 2981
    5.7. tm.reply
... ...
@@ -3010,7 +3010,7 @@ t_clean();
3010 3010
    Similar to tm.t_uac_start, but waits asynchronously for the SIP
3011 3011
    response and tries to provide its details via RPC response.
3012 3012
 
3013
-5.4.  tm.t_uac_wait
3013
+5.4.  tm.t_uac_wait_block
3014 3014
 
3015 3015
    Similar to tm.t_uac_start, but blocks waiting for the SIP response and
3016 3016
    returns the SIP reply code and reason text via RPC response. It waits
... ...
@@ -131,11 +131,15 @@ Chapter 1. Admin Guide
131 131
 
132 132
 3.2. Kamailio Core Settings
133 133
 
134
-   SIP requires a Content-Length header for TCP transport. But most HTTP
135
-   clients do not set the content length for normal GET requests.
136
-   Therefore, the core must be configured to allow incoming requests
137
-   without content length header:
138
-     * tcp_accept_no_cl=yes
134
+   Related core settings:
135
+     * tcp_accept_no_cl=yes - SIP requires the Content-Length header for
136
+       TCP transport. But most HTTP clients do not set the content length
137
+       for normal GET requests. Therefore, the core must be configured to
138
+       allow incoming requests without content length header.
139
+     * http_reply_parse=yes - various Kamailio modules may parse what it
140
+       is sent out (e.g., for replication, topology management). In such
141
+       case errors are printed if the outgoing message is not SIP and this
142
+       parameter is not set.
139 143
 
140 144
 3.3. External Libraries or Applications
141 145