Browse code

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

Kamailio Dev authored on 25/06/2017 08:16:40
Showing 1 changed files
... ...
@@ -34,6 +34,8 @@ Daniel-Constantin Mierla
34 34
               3.7. vparam_prefix (str)
35 35
               3.8. callid_prefix (str)
36 36
               3.9. sanity_checks (integer)
37
+              3.10. uri_prefix_checks (integer)
38
+              3.11. event_callback (str)
37 39
 
38 40
         4. Event Routes
39 41
 
... ...
@@ -50,7 +52,9 @@ Daniel-Constantin Mierla
50 52
    1.7. Set vparam_prefix parameter
51 53
    1.8. Set callid_prefix parameter
52 54
    1.9. Set sanity_checks parameter
53
-   1.10. Usage of event_route[topoh:msg-outgoing]
55
+   1.10. Set uri_prefix_checks parameter
56
+   1.11. Set event_callback parameter
57
+   1.12. Usage of event_route[topoh:msg-outgoing]
54 58
 
55 59
 Chapter 1. Admin Guide
56 60
 
... ...
@@ -73,6 +77,8 @@ Chapter 1. Admin Guide
73 77
         3.7. vparam_prefix (str)
74 78
         3.8. callid_prefix (str)
75 79
         3.9. sanity_checks (integer)
80
+        3.10. uri_prefix_checks (integer)
81
+        3.11. event_callback (str)
76 82
 
77 83
    4. Event Routes
78 84
 
... ...
@@ -122,6 +128,8 @@ Chapter 1. Admin Guide
122 128
    3.7. vparam_prefix (str)
123 129
    3.8. callid_prefix (str)
124 130
    3.9. sanity_checks (integer)
131
+   3.10. uri_prefix_checks (integer)
132
+   3.11. event_callback (str)
125 133
 
126 134
 3.1. mask_key (str)
127 135
 
... ...
@@ -236,6 +244,46 @@ modparam("topoh", "callid_prefix", "***")
236 244
 modparam("topoh", "sanity_checks", 1)
237 245
 ...
238 246
 
247
+3.10. uri_prefix_checks (integer)
248
+
249
+   If set to 1, topoh module will check if URIs to be decoded match the
250
+   expected prefix composed from mask IP and parameter name prefix. It can
251
+   make the topoh processing safer by avoiding to try decoding URIs which
252
+   were not encoded previously by topoh.
253
+
254
+   Note: do not enable this option if you have SIP devices that can alter
255
+   the URI values it takes from Contact or Record-Route headers (like
256
+   adding port 5060 when no port is in received URIs, or thet introduce
257
+   new parameters at unknown position).
258
+
259
+   Default value is 0.
260
+
261
+   Example 1.10. Set uri_prefix_checks parameter
262
+...
263
+modparam("topoh", "uri_prefix_checks", 1)
264
+...
265
+
266
+3.11. event_callback (str)
267
+
268
+   The name of the function in the KEMI configuration file (embedded
269
+   scripting language such as Lua, Python, ...) to be executed instead of
270
+   event_route[...] blocks.
271
+
272
+   The function receives a string parameter with the name of the event.
273
+
274
+   Default value is 'empty' (no function is executed for events).
275
+
276
+   Example 1.11. Set event_callback parameter
277
+...
278
+modparam("topoh", "event_callback", "ksr_topoh_event")
279
+...
280
+-- event callback function implemented in Lua
281
+function ksr_topoh_event(evname)
282
+        KSR.info("===== topoh module triggered event: " .. evname .. "\n");
283
+        return 1;
284
+end
285
+...
286
+
239 287
 4. Event Routes
240 288
 
241 289
    4.1. event_route[topoh:msg-outgoing]
... ...
@@ -252,7 +300,7 @@ modparam("topoh", "sanity_checks", 1)
252 300
    reparsing the outgoing SIP message for the cases when topology hiding
253 301
    is not wanted.
254 302
 
255
-   Example 1.10. Usage of event_route[topoh:msg-outgoing]
303
+   Example 1.12. Usage of event_route[topoh:msg-outgoing]
256 304
 ...
257 305
 event_route[topoh:msg-outgoing] {
258 306
   if($sndto(ip)=="10.1.1.10") {