瀏覽代碼

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

Kamailio Dev 2 年之前
父節點
當前提交
a45f4d9013
共有 1 個文件被更改,包括 21 次插入4 次删除
  1. 21 4
      src/modules/topoh/README

+ 21 - 4
src/modules/topoh/README

@@ -38,6 +38,7 @@ Daniel-Constantin Mierla
               3.11. uri_prefix_checks (integer)
               3.12. event_callback (str)
               3.13. event_mode (int)
+              3.14. use_mode (int)
 
         4. Event Routes
 
@@ -59,8 +60,9 @@ Daniel-Constantin Mierla
    1.11. Set uri_prefix_checks parameter
    1.12. Set event_callback parameter
    1.13. Set event_mode parameter
-   1.14. Usage of event_route[topoh:msg-outgoing]
-   1.15. Usage of event_route[topoh:msg-sending]
+   1.14. Set use_mode parameter
+   1.15. Usage of event_route[topoh:msg-outgoing]
+   1.16. Usage of event_route[topoh:msg-sending]
 
 Chapter 1. Admin Guide
 
@@ -87,6 +89,7 @@ Chapter 1. Admin Guide
         3.11. uri_prefix_checks (integer)
         3.12. event_callback (str)
         3.13. event_mode (int)
+        3.14. use_mode (int)
 
    4. Event Routes
 
@@ -141,6 +144,7 @@ Chapter 1. Admin Guide
    3.11. uri_prefix_checks (integer)
    3.12. event_callback (str)
    3.13. event_mode (int)
+   3.14. use_mode (int)
 
 3.1. mask_key (str)
 
@@ -322,6 +326,19 @@ end
 modparam("topoh", "event_mode", 2)
 ...
 
+3.14. use_mode (int)
+
+   Control how the module is initialized. If set to 1, the module is only
+   initialized to be used as a library via inter-module API functions. If
+   set to 0, the module is initialized for SIP messages processing.
+
+   Default value is 0 (to process SIP messages).
+
+   Example 1.14. Set use_mode parameter
+...
+modparam("topoh", "use_mode", 1)
+...
+
 4. Event Routes
 
    4.1. event_route[topoh:msg-outgoing]
@@ -339,7 +356,7 @@ modparam("topoh", "event_mode", 2)
    reparsing the outgoing SIP message for the cases when topology hiding
    is not wanted.
 
-   Example 1.14. Usage of event_route[topoh:msg-outgoing]
+   Example 1.15. Usage of event_route[topoh:msg-outgoing]
 ...
 event_route[topoh:msg-outgoing] {
   if($sndto(ip)=="10.1.1.10") {
@@ -358,7 +375,7 @@ event_route[topoh:msg-outgoing] {
    $sndto(proto) point to the destination. The SIP message is the one to
    be sent out.
 
-   Example 1.15. Usage of event_route[topoh:msg-sending]
+   Example 1.16. Usage of event_route[topoh:msg-sending]
 ...
 event_route[topoh:msg-sending] {
   if(is_request() and $fU=="alice") {