Browse code

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

Kamailio Dev authored on 03/04/2019 12:16:32
Showing 8 changed files
... ...
@@ -139,7 +139,14 @@ modparam("app_lua", "load", "/usr/local/etc/kamailio/lua/myscript.lua")
139 139
 
140 140
 3.2. register (string)
141 141
 
142
-   Use this function to register optional SIP Router submodules to Lua.
142
+   NOTE: Since Kamailio v5.0, KEMI exports are available in Lua script
143
+   under KSR module. These exports cover most of the modules, a lot more
144
+   that those listed next. The KEMI exports are the recommended to be
145
+   used, the old 'sr' module might be obsoleted soon. To read more about
146
+   KEMI exports and available KSR submodules, see:
147
+     * http://kamailio.org/docs/tutorials/devel/kamailio-kemi-framework/
148
+
149
+   Use this parameter to register optional Kamailio submodules to Lua.
143 150
    Available submodules are:
144 151
      * alias_db - register functions from alias_db module under
145 152
        'sr.alias_db'.
... ...
@@ -397,9 +397,10 @@ Chapter 1. Admin Guide
397 397
 
398 398
 2. How it works
399 399
 
400
-   To create the dialog associated with an initial request, the flag
401
-   “dlg_flag” (Section 6.4, “dlg_flag (integer)”) must be set before
402
-   creating the corresponding transaction.
400
+   To create the dialog associated with an initial INVITE request, execute
401
+   the function “dlg_manage()” or set the flag specified by parameter
402
+   “dlg_flag” (Section 6.4, “dlg_flag (integer)”) before creating the
403
+   corresponding transaction.
403 404
 
404 405
    The dialog is automatically destroyed when a “BYE” is received. In case
405 406
    of no “BYE”, the dialog lifetime is controlled via the default timeout
... ...
@@ -576,6 +577,10 @@ modparam("dialog", "rr_param", "xyz")
576 577
    Flag to be used for marking if a dialog should be constructed for the
577 578
    current request (this make sense only for initial requests).
578 579
 
580
+   Note: it is not needed to set this parameter and its corresponding flag
581
+   for initial request in case the “dlg_manage()” function is used. In
582
+   other words, using “dlg_manage()” alone is enough.
583
+
579 584
    Default value is “none”.
580 585
 
581 586
    Example 1.4. Set dlg_flag parameter
... ...
@@ -424,7 +424,8 @@ xlog("translated to var $var(y) \n");
424 424
 
425 425
 6.2.  dp_reload()
426 426
 
427
-   Forces an update of the translation rules from the database.
427
+   Reload the translation rules from the database. Note that there is a
428
+   rate limiting of maximum one reload in five seconds.
428 429
 
429 430
    Name: dp_reload
430 431
 
... ...
@@ -468,11 +469,14 @@ xlog("translated to var $var(y) \n");
468 469
    Name: dialplan.translate
469 470
 
470 471
    Parameters: 2
471
-     * Dial plan ID
472
-     * Input String
472
+     * Dial plan ID (number)
473
+     * Input string (string) - it can be prefixed with 's:' to avoid
474
+       auto-conversion when the command is executed with CLI apps such as
475
+       kamcmd.
473 476
 
474 477
    Example:
475 478
                 kamcmd dialplan.translate 1 "abcdxyz"
479
+                kamcmd dialplan.translate 1 s:123456789
476 480
 
477 481
 8. Installation
478 482
 
... ...
@@ -890,9 +890,11 @@ if (is_supported("outbound")) { ... }
890 890
    sender. For incoming SIP requests, it means there is only one Via
891 891
    header. For incoming SIP replies, it means that top Record-Route URI is
892 892
    'myself' and source address is not matching it (to avoid detecting in
893
-   case of local loops). Note that it does not detect spirals, which can
894
-   have the condition for replies true also in the case of additional SIP
895
-   reply receival.
893
+   case of local loops). The detection is done only when Record-Route has
894
+   an IP address in its URI (for a domain, it returns -1/false).
895
+
896
+   Note that it does not detect spirals, which can have the condition for
897
+   replies true also in the case of additional SIP reply reception.
896 898
 
897 899
    This function can be used from ANY_ROUTE.
898 900
 
... ...
@@ -196,7 +196,7 @@ if (is_method("INVITE")) {
196 196
    Example 1.4. ts_append usage
197 197
 ...
198 198
 if (is_method("REGISTER")) {
199
-        ts_append("location", "$tU");
199
+        ts_append("location", "$tu");
200 200
 }
201 201
 ...
202 202
 
... ...
@@ -196,12 +196,12 @@ modparam("uac_redirect","accept_filter",".*@siphub\.net")
196 196
 
197 197
 4.4. acc_function (string)
198 198
 
199
-   Specifies the accounting function to be used. Just be defining this
199
+   Specifies the accounting function to be used. Just by defining this
200 200
    parameter, the accounting support will not be enabled. Accounting may
201 201
    only be enabled via two parameters set_accept_filter() scripting
202 202
    function.
203 203
 
204
-   Its values my be:
204
+   Its values may be:
205 205
      * acc_log_request
206 206
      * acc_db_request
207 207
      * acc_rad_request
... ...
@@ -217,7 +217,7 @@ modparam("uac_redirect","acc_function","acc_db_request")
217 217
 4.5. acc_db_table (string)
218 218
 
219 219
    Specifies the accounting table to be used if DB accounting was chosen
220
-   (acc_function was set to “acc_db_request”). Just be defining this
220
+   (acc_function was set to “acc_db_request”). Just by defining this
221 221
    parameter, the accounting support will not be enabled. Accounting may
222 222
    only be enabled via two parameters set_accept_filter() scripting
223 223
    function.
... ...
@@ -74,9 +74,9 @@ Carsten Bock
74 74
               3.28. fetch_rows (integer)
75 75
               3.29. hash_size (integer)
76 76
               3.30. preload (string)
77
-              3.31. db_update_as_insert (string)
78
-              3.32. db_check_update (string)
79
-              3.33. timer_procs (string)
77
+              3.31. db_update_as_insert (int)
78
+              3.32. db_check_update (int)
79
+              3.33. timer_procs (int)
80 80
               3.34. xavp_contact (string)
81 81
               3.35. db_ops_ruid (int)
82 82
               3.36. handle_lost_tcp (int)
... ...
@@ -223,9 +223,9 @@ Chapter 1. Admin Guide
223 223
         3.28. fetch_rows (integer)
224 224
         3.29. hash_size (integer)
225 225
         3.30. preload (string)
226
-        3.31. db_update_as_insert (string)
227
-        3.32. db_check_update (string)
228
-        3.33. timer_procs (string)
226
+        3.31. db_update_as_insert (int)
227
+        3.32. db_check_update (int)
228
+        3.33. timer_procs (int)
229 229
         3.34. xavp_contact (string)
230 230
         3.35. db_ops_ruid (int)
231 231
         3.36. handle_lost_tcp (int)
... ...
@@ -346,9 +346,9 @@ Chapter 1. Admin Guide
346 346
    3.28. fetch_rows (integer)
347 347
    3.29. hash_size (integer)
348 348
    3.30. preload (string)
349
-   3.31. db_update_as_insert (string)
350
-   3.32. db_check_update (string)
351
-   3.33. timer_procs (string)
349
+   3.31. db_update_as_insert (int)
350
+   3.32. db_check_update (int)
351
+   3.33. timer_procs (int)
352 352
    3.34. xavp_contact (string)
353 353
    3.35. db_ops_ruid (int)
354 354
    3.36. handle_lost_tcp (int)
... ...
@@ -767,7 +767,7 @@ modparam("usrloc", "hash_size", 12)
767 767
 modparam("usrloc", "preload", "location")
768 768
 ...
769 769
 
770
-3.31. db_update_as_insert (string)
770
+3.31. db_update_as_insert (int)
771 771
 
772 772
    Set this parameter if you want to do INSERT DB operations instead of
773 773
    UPDATE DB operations. It is recommended to set this parameter if you
... ...
@@ -780,7 +780,7 @@ modparam("usrloc", "preload", "location")
780 780
 modparam("usrloc", "db_update_as_insert", 1)
781 781
 ...
782 782
 
783
-3.32. db_check_update (string)
783
+3.32. db_check_update (int)
784 784
 
785 785
    Set this parameter to 1 if you want to do DB INSERT if the number of
786 786
    affected rows by contact DB UPDATE operation is 0. The database module
... ...
@@ -795,7 +795,7 @@ modparam("usrloc", "db_update_as_insert", 1)
795 795
 modparam("usrloc", "db_check_update", 1)
796 796
 ...
797 797
 
798
-3.33. timer_procs (string)
798
+3.33. timer_procs (int)
799 799
 
800 800
    Number of timer processes to be started by module. Timer processes take
801 801
    care of checking expired records and syncronization with database. If
... ...
@@ -200,7 +200,7 @@ event_route[xhttp:request] {
200 200
                 # Optional... perform HTTP authentication
201 201
 
202 202
                 # ws_handle_handshake() exits (no further configuration file
203
-                # processing of the request) when complete.
203
+                # processing of the request) when complete in case of failure.
204 204
                 if (ws_handle_handshake())
205 205
                 {
206 206
                         # Optional... cache some information about the
... ...
@@ -474,7 +474,8 @@ modparam("websocket", "verbose_list", 1)
474 474
 Note
475 475
 
476 476
    This function returns 0, stopping all further processing of the
477
-   request, when there is a problem.
477
+   request, when there is a problem. Otherwise, it returns 1 (or positive
478
+   number) in case of success.
478 479
 
479 480
    Example 1.11. ws_handle_handshake usage
480 481
 ...