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

src/modules/corex/README

@@ -31,9 +31,10 @@ Muhammad Shahzad Shafi
 
               3.1. alias_subdomains (string)
               3.2. dns_cache (string)
-              3.3. nio_intercept (int)
-              3.4. nio_min_msg_len (int)
-              3.5. nio_msg_avp (string)
+              3.3. evcb_reply_out (string)
+              3.4. nio_intercept (int)
+              3.5. nio_min_msg_len (int)
+              3.6. nio_msg_avp (string)
 
         4. Functions
 
@@ -73,6 +74,7 @@ Muhammad Shahzad Shafi
         6. Event Routes
 
               6.1. event_route[network:msg]
+              6.2. event_route[corex:reply-out]
 
         7. Examples of Usage
 
@@ -80,34 +82,35 @@ Muhammad Shahzad Shafi
 
    1.1. Set alias_subdomains parameter
    1.2. Set dns_cache parameter
-   1.3. Set nio_intercept parameter
-   1.4. Set nio_min_msg_len parameter
-   1.5. Set nio_msg_avp parameter
-   1.6. append_branch usage
-   1.7. send_udp usage
-   1.8. send_tcp usage
-   1.9. send_data usage
-   1.10. sendx usage
-   1.11. is_incoming usage
-   1.12. msg_iflag_set usage
-   1.13. msg_iflag_reset usage
-   1.14. msg_iflag_is_set usage
-   1.15. file_read usage
-   1.16. file_write usage
-   1.17. setxflag usage
-   1.18. isxflagset usage
-   1.19. resetxflag usage
-   1.20. set_send_socket usage
-   1.21. set_send_socket_name usage
-   1.22. set_recv_socket usage
-   1.23. set_recv_socket_name usage
-   1.24. set_source_address usage
-   1.25. via_add_srvid usage
-   1.26. via_add_xavp_params usage
-   1.27. via_use_xavp_fields usage
-   1.28. is_faked_msg usage
-   1.29. event_route[network:msg] use cases
-   1.30. Sample PERL code for do_compress and do_uncompress
+   1.3. Set evcb_reply_out parameter
+   1.4. Set nio_intercept parameter
+   1.5. Set nio_min_msg_len parameter
+   1.6. Set nio_msg_avp parameter
+   1.7. append_branch usage
+   1.8. send_udp usage
+   1.9. send_tcp usage
+   1.10. send_data usage
+   1.11. sendx usage
+   1.12. is_incoming usage
+   1.13. msg_iflag_set usage
+   1.14. msg_iflag_reset usage
+   1.15. msg_iflag_is_set usage
+   1.16. file_read usage
+   1.17. file_write usage
+   1.18. setxflag usage
+   1.19. isxflagset usage
+   1.20. resetxflag usage
+   1.21. set_send_socket usage
+   1.22. set_send_socket_name usage
+   1.23. set_recv_socket usage
+   1.24. set_recv_socket_name usage
+   1.25. set_source_address usage
+   1.26. via_add_srvid usage
+   1.27. via_add_xavp_params usage
+   1.28. via_use_xavp_fields usage
+   1.29. is_faked_msg usage
+   1.30. event_route[network:msg] use cases
+   1.31. Sample PERL code for do_compress and do_uncompress
 
 Chapter 1. Admin Guide
 
@@ -123,9 +126,10 @@ Chapter 1. Admin Guide
 
         3.1. alias_subdomains (string)
         3.2. dns_cache (string)
-        3.3. nio_intercept (int)
-        3.4. nio_min_msg_len (int)
-        3.5. nio_msg_avp (string)
+        3.3. evcb_reply_out (string)
+        3.4. nio_intercept (int)
+        3.5. nio_min_msg_len (int)
+        3.6. nio_msg_avp (string)
 
    4. Functions
 
@@ -165,6 +169,7 @@ Chapter 1. Admin Guide
    6. Event Routes
 
         6.1. event_route[network:msg]
+        6.2. event_route[corex:reply-out]
 
    7. Examples of Usage
 
@@ -210,9 +215,10 @@ Chapter 1. Admin Guide
 
    3.1. alias_subdomains (string)
    3.2. dns_cache (string)
-   3.3. nio_intercept (int)
-   3.4. nio_min_msg_len (int)
-   3.5. nio_msg_avp (string)
+   3.3. evcb_reply_out (string)
+   3.4. nio_intercept (int)
+   3.5. nio_min_msg_len (int)
+   3.6. nio_msg_avp (string)
 
 3.1. alias_subdomains (string)
 
@@ -254,7 +260,19 @@ modparam("corex", "dns_cache", "type=AAAA;name=kamailio.org;addr=2a00:d60:0:400:
 :2;ttl=3600000;flags=0")
 ...
 
-3.3. nio_intercept (int)
+3.3. evcb_reply_out (string)
+
+   Name of KEMI callback function to be executed instead of
+   event_route[corex:reply-out].
+
+   Default value is “NULL”.
+
+   Example 1.3. Set evcb_reply_out parameter
+...
+modparam("corex", "evcb_reply_out", "ksr_corex_reply_out")
+...
+
+3.4. nio_intercept (int)
 
    If set to non-zero then raw data received from a remote host or about
    to be sent to a remote host is made available in
@@ -263,12 +281,12 @@ modparam("corex", "dns_cache", "type=AAAA;name=kamailio.org;addr=2a00:d60:0:400:
 
    Default value is 0, i.e. do not allow access to network io data.
 
-   Example 1.3. Set nio_intercept parameter
+   Example 1.4. Set nio_intercept parameter
 ...
 modparam("corex", "nio_intercept", 1)
 ...
 
-3.4. nio_min_msg_len (int)
+3.5. nio_min_msg_len (int)
 
    Minimum content length of the packet to execute the
    event_route[network:msg]. This only works if nio_intercept parameter is
@@ -276,12 +294,12 @@ modparam("corex", "nio_intercept", 1)
 
    Default value is 0.
 
-   Example 1.4. Set nio_min_msg_len parameter
+   Example 1.5. Set nio_min_msg_len parameter
 ...
 modparam("corex", "nio_min_msg_len", 32)
 ...
 
-3.5. nio_msg_avp (string)
+3.6. nio_msg_avp (string)
 
    AVP name to store modified content to be set in the packet. If not set
    in event_route[network:msg], then all changes are lost and original
@@ -290,7 +308,7 @@ modparam("corex", "nio_min_msg_len", 32)
 
    Default value is empty.
 
-   Example 1.5. Set nio_msg_avp parameter
+   Example 1.6. Set nio_msg_avp parameter
 ...
 modparam("corex", "nio_msg_avp", "$avp(msg)")
 ...
@@ -337,7 +355,7 @@ modparam("corex", "nio_msg_avp", "$avp(msg)")
 
    This function can be used from REQUEST_ROUTE or FAILURE_ROUTE.
 
-   Example 1.6. append_branch usage
+   Example 1.7. append_branch usage
 ...
     append_branch();
     append_branch("$avp(uri)", "0.5");
@@ -357,7 +375,7 @@ modparam("corex", "nio_msg_avp", "$avp(msg)")
 
    This function can be used from REQUEST_ROUTE or FAILURE_ROUTE.
 
-   Example 1.7. send_udp usage
+   Example 1.8. send_udp usage
 ...
         send_udp();
         send_udp("10.20.15.10");
@@ -370,7 +388,7 @@ modparam("corex", "nio_msg_avp", "$avp(msg)")
    This function is identical to send_udp() described above, except that
    it sends the SIP message using the TCP protocol instead of UDP.
 
-   Example 1.8. send_tcp usage
+   Example 1.9. send_tcp usage
 ...
         send_tcp();
         send_tcp("10.20.15.10");
@@ -386,7 +404,7 @@ modparam("corex", "nio_msg_avp", "$avp(msg)")
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.9. send_data usage
+   Example 1.10. send_data usage
 ...
         send_data("sip:example.com:5070;transport=sctp", "Message at $Ts");
 ...
@@ -401,7 +419,7 @@ modparam("corex", "nio_msg_avp", "$avp(msg)")
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.10. sendx usage
+   Example 1.11. sendx usage
 ...
 sendx("sip:example.com:5070;transport=sctp", "sctp:2.3.4.5:5060", "Message at $T
 s");
@@ -416,7 +434,7 @@ s");
 
    This function can be used from event_route[network:msg].
 
-   Example 1.11. is_incoming usage
+   Example 1.12. is_incoming usage
 ...
 event_route[network:msg] {
     if (is_incoming()) {
@@ -441,7 +459,7 @@ event_route[network:msg] {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.12. msg_iflag_set usage
+   Example 1.13. msg_iflag_set usage
 ...
     msg_iflag_set("UAC_AUTH");
 ...
@@ -452,7 +470,7 @@ event_route[network:msg] {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.13. msg_iflag_reset usage
+   Example 1.14. msg_iflag_reset usage
 ...
     msg_iflag_reset("UAC_AUTH");
 ...
@@ -463,7 +481,7 @@ event_route[network:msg] {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.14. msg_iflag_is_set usage
+   Example 1.15. msg_iflag_is_set usage
 ...
     if(msg_iflag_is_set("UAC_AUTH")) { ... }
 ...
@@ -474,7 +492,7 @@ event_route[network:msg] {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.15. file_read usage
+   Example 1.16. file_read usage
 ...
 if(file_read("/tmp/data.txt", "$var(data)")) { ... }
 ...
@@ -485,7 +503,7 @@ if(file_read("/tmp/data.txt", "$var(data)")) { ... }
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.16. file_write usage
+   Example 1.17. file_write usage
 ...
 if(file_write("/tmp/data.txt", "Data is: $var(data)")) { ... }
 ...
@@ -500,7 +518,7 @@ if(file_write("/tmp/data.txt", "Data is: $var(data)")) { ... }
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.17. setxflag usage
+   Example 1.18. setxflag usage
 ...
 setxflag("1");
 ...
@@ -518,7 +536,7 @@ setxflag("$var(flag)");
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.18. isxflagset usage
+   Example 1.19. isxflagset usage
 ...
 if(isxflagset("1"))
 {
@@ -536,7 +554,7 @@ if(isxflagset("1"))
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.19. resetxflag usage
+   Example 1.20. resetxflag usage
 ...
 resetxflag("1");
 ...
@@ -551,7 +569,7 @@ resetxflag("1");
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.20. set_send_socket usage
+   Example 1.21. set_send_socket usage
 ...
 set_send_socket("udp:127.0.0.1:5060");
 ...
@@ -566,7 +584,7 @@ set_send_socket("udp:127.0.0.1:5060");
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.21. set_send_socket_name usage
+   Example 1.22. set_send_socket_name usage
 ...
 set_send_socket_name("sock1");
 ...
@@ -581,7 +599,7 @@ set_send_socket_name("sock1");
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.22. set_recv_socket usage
+   Example 1.23. set_recv_socket usage
 ...
 set_recv_socket("udp:127.0.0.1:5060");
 ...
@@ -596,7 +614,7 @@ set_recv_socket("udp:127.0.0.1:5060");
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.23. set_recv_socket_name usage
+   Example 1.24. set_recv_socket_name usage
 ...
 set_recv_socket_name("sock1");
 ...
@@ -611,7 +629,7 @@ set_recv_socket_name("sock1");
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.24. set_source_address usage
+   Example 1.25. set_source_address usage
 ...
 set_source_address("udp:127.0.0.1:5080");
 ...
@@ -626,7 +644,7 @@ set_source_address("udp:127.0.0.1:5080");
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.25. via_add_srvid usage
+   Example 1.26. via_add_srvid usage
 ...
 via_add_srv("1");
 ...
@@ -641,7 +659,7 @@ via_add_srv("1");
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.26. via_add_xavp_params usage
+   Example 1.27. via_add_xavp_params usage
 ...
 xavp_via_params="xvia"
 ...
@@ -664,7 +682,7 @@ request_route {
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.27. via_use_xavp_fields usage
+   Example 1.28. via_use_xavp_fields usage
 ...
 xavp_via_fields="mvia"
 ...
@@ -689,7 +707,7 @@ request_route {
 
    This function can be used in ANY_ROUTE.
 
-   Example 1.28. is_faked_msg usage
+   Example 1.29. is_faked_msg usage
 ...
 event_route[dispatcher:dst-down] {
     if (is_faked_msg()) {
@@ -761,6 +779,7 @@ event_route[dispatcher:dst-down] {
 6. Event Routes
 
    6.1. event_route[network:msg]
+   6.2. event_route[corex:reply-out]
 
 6.1.  event_route[network:msg]
 
@@ -784,6 +803,10 @@ event_route[dispatcher:dst-down] {
    remote host. Therefore, except text operations, no module functions or
    pseudo variables are available in this event route.
 
+6.2.  event_route[corex:reply-out]
+
+   Event route block to be executed when a SIP reply is sent out.
+
 7. Examples of Usage
 
    To use network event_route[network:msg] the remote SIP UA must also
@@ -832,7 +855,7 @@ event_route[dispatcher:dst-down] {
    Next is a basic usage example where encoding and decoding is done using
    PERL.
 
-   Example 1.29. event_route[network:msg] use cases
+   Example 1.30. event_route[network:msg] use cases
 ...
 loadmodule "app_perl.so"
 loadmodule "corex.so"
@@ -863,7 +886,7 @@ event_route[network:msg] {
 }
 ...
 
-   Example 1.30. Sample PERL code for do_compress and do_uncompress
+   Example 1.31. Sample PERL code for do_compress and do_uncompress
 ...
 use strict;
 use warnings;