[sr-dev] git:master:a4cc0be0: modules: readme files regenerated - topoh ... [skip ci]

[Kamailio Dev]

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

Author: Kamailio Dev <kamailio.dev at kamailio.org>
Committer: Kamailio Dev <kamailio.dev at kamailio.org>
Date: 2020-09-29T10:46:15+02:00

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

---

Modified: src/modules/topoh/README
Modified: src/modules/topos/README

---

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

---

diff --git a/src/modules/topoh/README b/src/modules/topoh/README
index 45e4b904d7..5f2113ef58 100644
--- a/src/modules/topoh/README
+++ b/src/modules/topoh/README
@@ -36,10 +36,12 @@ Daniel-Constantin Mierla
               3.9. sanity_checks (integer)
               3.10. uri_prefix_checks (integer)
               3.11. event_callback (str)
+              3.12. event_mode (int)
 
         4. Event Routes
 
               4.1. event_route[topoh:msg-outgoing]
+              4.2. event_route[topoh:msg-sending]
 
    List of Examples
 
@@ -54,7 +56,9 @@ Daniel-Constantin Mierla
    1.9. Set sanity_checks parameter
    1.10. Set uri_prefix_checks parameter
    1.11. Set event_callback parameter
-   1.12. Usage of event_route[topoh:msg-outgoing]
+   1.12. Set event_mode parameter
+   1.13. Usage of event_route[topoh:msg-outgoing]
+   1.14. Usage of event_route[topoh:msg-sending]
 
 Chapter 1. Admin Guide
 
@@ -79,10 +83,12 @@ Chapter 1. Admin Guide
         3.9. sanity_checks (integer)
         3.10. uri_prefix_checks (integer)
         3.11. event_callback (str)
+        3.12. event_mode (int)
 
    4. Event Routes
 
         4.1. event_route[topoh:msg-outgoing]
+        4.2. event_route[topoh:msg-sending]
 
 1. Overview
 
@@ -130,6 +136,7 @@ Chapter 1. Admin Guide
    3.9. sanity_checks (integer)
    3.10. uri_prefix_checks (integer)
    3.11. event_callback (str)
+   3.12. event_mode (int)
 
 3.1. mask_key (str)
 
@@ -284,9 +291,23 @@ function ksr_topoh_event(evname)
 end
 ...
 
+3.12. event_mode (int)
+
+   Control what event_route blocks to be executed. It is a bitmask of: 1 -
+   execute event_route[topoh:msg-outgoing]; 2 - execute
+   event_route[topoh:msg-sending].
+
+   Default value is 3 (execute both event_route blocks).
+
+   Example 1.12. Set event_mode parameter
+...
+modparam("topoh", "event_mode", 2)
+...
+
 4. Event Routes
 
    4.1. event_route[topoh:msg-outgoing]
+   4.2. event_route[topoh:msg-sending]
 
 4.1. event_route[topoh:msg-outgoing]
 
@@ -300,7 +321,7 @@ end
    reparsing the outgoing SIP message for the cases when topology hiding
    is not wanted.
 
-   Example 1.12. Usage of event_route[topoh:msg-outgoing]
+   Example 1.13. Usage of event_route[topoh:msg-outgoing]
 ...
 event_route[topoh:msg-outgoing] {
   if($sndto(ip)=="10.1.1.10") {
@@ -308,3 +329,22 @@ event_route[topoh:msg-outgoing] {
   }
 }
 ...
+
+4.2. event_route[topoh:msg-sending]
+
+   It is executed before doing topology hiding processing for a SIP
+   message to be sent out, being executed after
+   event_route[topoh:msg-outgoing].
+
+   Inside the event route the variables $sndto(ip), $sndto(port) and
+   $sndto(proto) point to the destination. The SIP message is the one to
+   be sent out.
+
+   Example 1.14. Usage of event_route[topoh:msg-sending]
+...
+event_route[topoh:msg-sending] {
+  if(is_request() and $fU=="alice") {
+    drop;
+  }
+}
+...
diff --git a/src/modules/topos/README b/src/modules/topos/README
index 72b1ae8b3f..339ecd4f5d 100644
--- a/src/modules/topos/README
+++ b/src/modules/topos/README
@@ -265,8 +265,8 @@ end
 3.9. event_mode (int)
 
    Control what event_route blocks to be executed. It is a bitmask of: 1 -
-   execute event_route[topos:outgoing]; 2 - execute
-   event_route[topos:sending].
+   execute event_route[topos:msg-outgoing]; 2 - execute
+   event_route[topos:msg-sending].
 
    Default value is 3 (execute both event_route blocks).