Ver código fonte

tsilo: updated README

Federico Cabiddu 10 anos atrás
pai
commit
a58d2c9d0e
1 arquivos alterados com 23 adições e 6 exclusões
  1. 23 6
      modules/tsilo/README

+ 23 - 6
modules/tsilo/README

@@ -26,6 +26,7 @@ Federico Cabiddu
         3. Parameters
 
               3.1. hash_size (integer)
+              3.2. use_domain (integer)
 
         4. Functions
 
@@ -49,9 +50,10 @@ Federico Cabiddu
    List of Examples
 
    1.1. Set hash_size parameter
-   1.2. ts_store usage
-   1.3. ts_append usage
-   1.4. ts_append_to usage
+   1.2. Set use_domain parameter
+   1.3. ts_store usage
+   1.4. ts_append usage
+   1.5. ts_append_to usage
 
 Chapter 1. Admin Guide
 
@@ -66,6 +68,7 @@ Chapter 1. Admin Guide
    3. Parameters
 
         3.1. hash_size (integer)
+        3.2. use_domain (integer)
 
    4. Functions
 
@@ -121,6 +124,7 @@ Chapter 1. Admin Guide
 3. Parameters
 
    3.1. hash_size (integer)
+   3.2. use_domain (integer)
 
 3.1. hash_size (integer)
 
@@ -136,6 +140,19 @@ Chapter 1. Admin Guide
 modparam("tsilo", "hash_size", 1024)
 ...
 
+3.2. use_domain (integer)
+
+   Specify if the domain part of the URI should be also saved and used for
+   storing and retrieving users' transactions. Useful in multi domain
+   scenarios. Non 0 value means true.
+
+   Default value is “0”.
+
+   Example 1.2. Set use_domain parameter
+...
+modparam("tsilo", "use_domain", 1)
+...
+
 4. Functions
 
    4.1. ts_store([uri])
@@ -150,7 +167,7 @@ modparam("tsilo", "hash_size", 1024)
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.2. ts_store usage
+   Example 1.3. ts_store usage
 ...
 if (is_method("INVITE")) {
     if (t_newtran()) {
@@ -176,7 +193,7 @@ if (is_method("INVITE")) {
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.3. ts_append usage
+   Example 1.4. ts_append usage
 ...
 if (is_method("REGISTER")) {
         ts_append("location", "$tU");
@@ -201,7 +218,7 @@ if (is_method("REGISTER")) {
 
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
 
-   Example 1.4. ts_append_to usage
+   Example 1.5. ts_append_to usage
 ...
 if (is_method("REGISTER")) {
         $var(tindex) = ...