Browse code

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

Kamailio Dev authored on 08/09/2020 10:47:01
Showing 3 changed files
... ...
@@ -94,6 +94,9 @@ Chapter 1. Admin Guide
94 94
    To read more about KEMI exports and available KSR submodules, see:
95 95
      * http://kamailio.org/docs/tutorials/devel/kamailio-kemi-framework/
96 96
 
97
+   Note: to have the old Lua module 'sr' available, load the 'app_lua_sr'
98
+   Kamailio module.
99
+
97 100
    Lua (http://www.lua.org) is a fast and easy to embed scripting
98 101
    language. Exported API from SIP router to Lua is documented in the
99 102
    dokuwiki.
... ...
@@ -203,7 +206,7 @@ lua_dofile("/usr/local/etc/kamailio/lua/myscript.lua");
203 206
 
204 207
    Example 1.6. lua_dostring usage
205 208
 ...
206
-if(!lua_dostring("sr.log([[err]], [[----------- Hello World from $fU\n]])"))
209
+if(!lua_dostring("KSR.log([[err]], [[----------- Hello World from $fU\n]])"))
207 210
 {
208 211
     xdbg("SCRIPT: failed to execute lua script!\n");
209 212
 }
... ...
@@ -237,7 +240,7 @@ lua_run("lua_func3", "$rU", "2", "$si");
237 240
 
238 241
    Example 1.8. lua_runstring usage
239 242
 ...
240
-if(!lua_runstring("sr.log([[err]], [[----------- Hello World from $fU\n]])"))
243
+if(!lua_runstring("KSR.log([[err]], [[----------- Hello World from $fU\n]])"))
241 244
 {
242 245
     xdbg("SCRIPT: failed to execute lua script!\n");
243 246
 }
... ...
@@ -297,7 +300,7 @@ if(!lua_runstring("sr.log([[err]], [[----------- Hello World from $fU\n]])"))
297 300
    '/usr/local/etc/kamailio/lua/myscript.lua'.
298 301
 ...
299 302
 function sr_append_fu_to_reply()
300
-        sr.hdr.append_to_reply("P-From: " .. sr.pv.get("$fu") .. "\r\n");
303
+        KSR.hdr.append_to_reply("P-From: " .. KSR.pv.get("$fu") .. "\r\n");
301 304
 end
302 305
 ...
303 306
 
... ...
@@ -39,6 +39,7 @@ Bogdan-Andrei Iancu
39 39
    2. RPC calls
40 40
 
41 41
         1. pike.top
42
+        2. pike.list
42 43
 
43 44
    3. Developer Guide
44 45
 
... ...
@@ -49,6 +50,7 @@ Bogdan-Andrei Iancu
49 50
    1.3. Set remove_latency parameter
50 51
    1.4. Set pike_log_level parameter
51 52
    1.5. pike_check_req usage
53
+   2.1. Using pike.top
52 54
    3.1. Tree of IP addresses
53 55
 
54 56
 Chapter 1. Admin Guide
... ...
@@ -219,6 +221,7 @@ Chapter 2. RPC calls
219 221
    Table of Contents
220 222
 
221 223
    1. pike.top
224
+   2. pike.list
222 225
 
223 226
 1.  pike.top
224 227
 
... ...
@@ -230,9 +233,9 @@ Chapter 2. RPC calls
230 233
 
231 234
    Some IPs could be marked as HOT depending on theirs request rates.
232 235
 
233
-   pike.top command takes one string parameter which specifies what kind
234
-   of nodes you are interested in. Possible values are HOT or ALL. If no
235
-   argument is given, it behaves as HOT was used.
236
+   pike.top command can take one string parameter which specifies what
237
+   kind of nodes you are interested in. Possible values are HOT or ALL. If
238
+   no argument is given, it behaves as HOT was used.
236 239
 
237 240
    Marking nodes HOT is done on server side, client only presents given
238 241
    data and make some postprocessing like sorting.
... ...
@@ -240,6 +243,15 @@ Chapter 2. RPC calls
240 243
    Output of this command is a simple dump of ip_tree nodes marked as
241 244
    ip-leafs.
242 245
 
246
+   Example 2.1. Using pike.top
247
+...
248
+kamcli rpc pike.top ALL
249
+...
250
+
251
+2.  pike.list
252
+
253
+   Alias for "pike.top" command.
254
+
243 255
 Chapter 3. Developer Guide
244 256
 
245 257
    One single tree (for both IPv4 and IPv6) is used. Each node contains a
... ...
@@ -1426,7 +1426,7 @@ end
1426 1426
 
1427 1427
 10.34. rand_engine (str)
1428 1428
 
1429
-   Set the ranondom number generator engine for libssl.
1429
+   Set the random number generator engine for libssl.
1430 1430
 
1431 1431
    Note: the default random number generator (PRNG) engine of libssl
1432 1432
    v1.1.x is not designed for multi-process applications and can result in