[sr-dev] git:master:c70f0941: modules: readme files regenerated - msrp ... [skip ci]

[Kamailio Dev]

Module: kamailio
Branch: master
Commit: c70f094138033b987bb5b276363de2388d86d47a
URL: https://github.com/kamailio/kamailio/commit/c70f094138033b987bb5b276363de2388d86d47a

Author: Kamailio Dev <kamailio.dev at kamailio.org>
Committer: Kamailio Dev <kamailio.dev at kamailio.org>
Date: 2017-11-05T11:31:25+01:00

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

---

Modified: src/modules/msrp/README
Modified: src/modules/sipcapture/README

---

Diff:  https://github.com/kamailio/kamailio/commit/c70f094138033b987bb5b276363de2388d86d47a.diff
Patch: https://github.com/kamailio/kamailio/commit/c70f094138033b987bb5b276363de2388d86d47a.patch

---

diff --git a/src/modules/msrp/README b/src/modules/msrp/README
index f96b350a7d..b55af6955d 100644
--- a/src/modules/msrp/README
+++ b/src/modules/msrp/README
@@ -264,7 +264,7 @@ modparam("msrp", "use_path_addr", "msrp.kamailio.org:5061")
 
    Example 1.7. Set event_callback parameter
 ...
-modparam("htable", "event_callback", "ksr_msrp_event")
+modparam("msrp", "event_callback", "ksr_msrp_event")
 ...
 -- event callback function implemented in Lua
 function ksr_msrp_event(evname)
diff --git a/src/modules/sipcapture/README b/src/modules/sipcapture/README
index fa373d261a..c4adc983e6 100644
--- a/src/modules/sipcapture/README
+++ b/src/modules/sipcapture/README
@@ -50,6 +50,7 @@ Alexandr Dubovikov
               3.19. callid_aleg_header (str)
               3.20. topoh_unmask (int)
               3.21. nonsip_hook (int)
+              3.22. event_callback (str)
 
         4. Functions
 
@@ -91,10 +92,11 @@ Alexandr Dubovikov
    1.19. Set callid_aleg_header parameter
    1.20. Set topoh_unmask parameter
    1.21. Set nonsip_hook parameter
-   1.22. sip_capture() usage
-   1.23. report_capture() usage
+   1.22. Set event_callback parameter
+   1.23. sip_capture() usage
    1.24. report_capture() usage
-   1.25. event_route[sipcapture:request] usage
+   1.25. report_capture() usage
+   1.26. event_route[sipcapture:request] usage
 
 Chapter 1. Admin Guide
 
@@ -129,6 +131,7 @@ Chapter 1. Admin Guide
         3.19. callid_aleg_header (str)
         3.20. topoh_unmask (int)
         3.21. nonsip_hook (int)
+        3.22. event_callback (str)
 
    4. Functions
 
@@ -202,6 +205,7 @@ Chapter 1. Admin Guide
    3.19. callid_aleg_header (str)
    3.20. topoh_unmask (int)
    3.21. nonsip_hook (int)
+   3.22. event_callback (str)
 
 3.1. db_url (str)
 
@@ -484,6 +488,28 @@ modparam("sipcapture", "topoh_unmask", 1)
 modparam("sipcapture", "nonsip_hook", 1)
 ...
 
+3.22. event_callback (str)
+
+   The name of the function in the kemi configuration file (embedded
+   scripting language such as Lua, Python, ...) to be executed instead of
+   event_route[...] blocks.
+
+   The function receives a string parameter with the name of the event,
+   the values can be: 'sipcapture:request'.
+
+   Default value is 'empty' (no function is executed for events).
+
+   Example 1.22. Set event_callback parameter
+...
+modparam("sipcapture", "event_callback", "ksr_sipcapture_event")
+...
+-- event callback function implemented in Lua
+function ksr_sipcapture_event(evname)
+        KSR.info("===== sipcapture module triggered event: " .. evname .. "\n");
+        return 1;
+end
+...
+
 4. Functions
 
    4.1. sip_capture([table], [cmode])
@@ -506,7 +532,7 @@ modparam("sipcapture", "nonsip_hook", 1)
    This function can be used from ANY_ROUTE.
    Default value is "NULL".
 
-   Example 1.22. sip_capture() usage
+   Example 1.23. sip_capture() usage
 ...
 sip_capture();
 ...
@@ -527,7 +553,7 @@ sip_capture("", "cmode");
    This function can be used from ANY_ROUTE.
    Default value is "NULL".
 
-   Example 1.23. report_capture() usage
+   Example 1.24. report_capture() usage
 ...
 report_capture();
 ...
@@ -543,7 +569,7 @@ report_capture("report_data", "$ci", "{\"MOS\":4.1,\"PACKET_LOST\":100"});
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.24. report_capture() usage
+   Example 1.25. report_capture() usage
 ...
 $var(res) = float2int("10.5", "1");
 ...
@@ -557,7 +583,7 @@ $var(res) = float2int("10.5", "1");
    Event route block to be executed when HEP packet is received. It
    requires module parameter 'nonsip_hook' to be set to 1.
 
-   Example 1.25. event_route[sipcapture:request] usage
+   Example 1.26. event_route[sipcapture:request] usage
 ...
 # new event sipcapture socket
 modparam("sipcapture", "nonsip_hook", 1)