modules: readme files regenerated - topos ... [skip ci]
authorKamailio Dev <kamailio.dev@kamailio.org>
Mon, 10 Jul 2017 08:01:37 +0000 (10:01 +0200)
committerKamailio Dev <kamailio.dev@kamailio.org>
Mon, 10 Jul 2017 08:01:37 +0000 (10:01 +0200)
src/modules/topos/README

index ab83dca..3e42389 100644 (file)
@@ -25,21 +25,23 @@ Daniel-Constantin Mierla
 
         3. Parameters
 
-              3.1. db_url (str)
-              3.2. mask_callid (int)
-              3.3. sanity_checks (int)
-              3.4. branch_expire (int)
-              3.5. dialog_expire (int)
-              3.6. clean_interval (int)
+              3.1. storage (str)
+              3.2. db_url (str)
+              3.3. mask_callid (int)
+              3.4. sanity_checks (int)
+              3.5. branch_expire (int)
+              3.6. dialog_expire (int)
+              3.7. clean_interval (int)
 
    List of Examples
 
-   1.1. Set db_url parameter
-   1.2. Set mask_callid parameter
-   1.3. Set sanity_checks parameter
-   1.4. Set branch_expire parameter
-   1.5. Set dialog_expire parameter
-   1.6. Set clean_interval parameter
+   1.1. Set storage parameter
+   1.2. Set db_url parameter
+   1.3. Set mask_callid parameter
+   1.4. Set sanity_checks parameter
+   1.5. Set branch_expire parameter
+   1.6. Set dialog_expire parameter
+   1.7. Set clean_interval parameter
 
 Chapter 1. Admin Guide
 
@@ -53,12 +55,13 @@ Chapter 1. Admin Guide
 
    3. Parameters
 
-        3.1. db_url (str)
-        3.2. mask_callid (int)
-        3.3. sanity_checks (int)
-        3.4. branch_expire (int)
-        3.5. dialog_expire (int)
-        3.6. clean_interval (int)
+        3.1. storage (str)
+        3.2. db_url (str)
+        3.3. mask_callid (int)
+        3.4. sanity_checks (int)
+        3.5. branch_expire (int)
+        3.6. dialog_expire (int)
+        3.7. clean_interval (int)
 
 1. Overview
 
@@ -92,25 +95,39 @@ Chapter 1. Admin Guide
 
 3. Parameters
 
-   3.1. db_url (str)
-   3.2. mask_callid (int)
-   3.3. sanity_checks (int)
-   3.4. branch_expire (int)
-   3.5. dialog_expire (int)
-   3.6. clean_interval (int)
+   3.1. storage (str)
+   3.2. db_url (str)
+   3.3. mask_callid (int)
+   3.4. sanity_checks (int)
+   3.5. branch_expire (int)
+   3.6. dialog_expire (int)
+   3.7. clean_interval (int)
 
-3.1. db_url (str)
+3.1. storage (str)
+
+   Type of storage, valid types are:
+     * db - Database Backend
+     * redis - Redis Backend
+
+   Default value is “db”.
+
+   Example 1.1. Set storage parameter
+...
+modparam("topos", "storage", "redis")
+...
+
+3.2. db_url (str)
 
    Database URL.
 
    Default value is “mysql://kamailio:kamailiorw@localhost/kamailio”.
 
-   Example 1.1. Set db_url parameter
+   Example 1.2. Set db_url parameter
 ...
 modparam("topos", "db_url", "dbdriver://username:password@dbhost/dbname")
 ...
 
-3.2. mask_callid (int)
+3.3. mask_callid (int)
 
    Note: this functionality is not implemented yet - the parameter is
    present in order to be in pair with topoh module.
@@ -120,12 +137,12 @@ modparam("topos", "db_url", "dbdriver://username:password@dbhost/dbname")
 
    Default value is 0 (do not mask).
 
-   Example 1.2. Set mask_callid parameter
+   Example 1.3. Set mask_callid parameter
 ...
 modparam("topos", "mask_callid", 1)
 ...
 
-3.3. sanity_checks (int)
+3.4. sanity_checks (int)
 
    If set to 1, topoh module will bind to sanity module in order to
    perform sanity checks over received SIP request. Default sanity checks
@@ -134,40 +151,40 @@ modparam("topos", "mask_callid", 1)
 
    Default value is 0 (do not bind to sanity module).
 
-   Example 1.3. Set sanity_checks parameter
+   Example 1.4. Set sanity_checks parameter
 ...
 modparam("topoh", "sanity_checks", 1)
 ...
 
-3.4. branch_expire (int)
+3.5. branch_expire (int)
 
    Interval in seconds after which the branch records are deleted.
 
    Default value is 180 (3 min).
 
-   Example 1.4. Set branch_expire parameter
+   Example 1.5. Set branch_expire parameter
 ...
 modparam("topos", "branch_expire", 300)
 ...
 
-3.5. dialog_expire (int)
+3.6. dialog_expire (int)
 
    Interval in seconds after which the dialog records are deleted.
 
    Default value is 10800 (3 hours).
 
-   Example 1.5. Set dialog_expire parameter
+   Example 1.6. Set dialog_expire parameter
 ...
 modparam("topos", "dialog_expire", 3600)
 ...
 
-3.6. clean_interval (int)
+3.7. clean_interval (int)
 
    Interval in seconds to run the clean up of stored records.
 
    Default value is 60 (1 min).
 
-   Example 1.6. Set clean_interval parameter
+   Example 1.7. Set clean_interval parameter
 ...
 modparam("topos", "clean_interval", 30)
 ...