pua update README
authorOlle E. Johansson <oej@edvina.net>
Tue, 31 May 2016 14:57:40 +0000 (16:57 +0200)
committerOlle E. Johansson <oej@edvina.net>
Tue, 31 May 2016 15:12:39 +0000 (17:12 +0200)
modules/pua/README

index ed64a3b..366053b 100644 (file)
@@ -8,7 +8,7 @@ Edited by
 
 Anca-Maria Vamanu
 
-   Copyright (c) 2006 Voice Sistem SRL
+   Copyright © 2006 Voice Sistem SRL
      __________________________________________________________________
 
    Table of Contents
@@ -33,8 +33,9 @@ Anca-Maria Vamanu
               3.8. dlginfo_increase_version (int)
               3.9. reginfo_increase_version (int)
               3.10. db_mode (int)
-              3.11. check_remote_contact (int)
-              3.12. fetch_rows (integer)
+              3.11. db_table_lock_write (integer)
+              3.12. check_remote_contact (int)
+              3.13. fetch_rows (integer)
 
         4. Functions
 
@@ -67,9 +68,10 @@ Anca-Maria Vamanu
    1.8. Set dlginfo_increase_version parameter
    1.9. Set reginfo_increase_version parameter
    1.10. Set db_mode parameter
-   1.11. Set check_remote_contact parameter
-   1.12. Set fetch_rows parameter
-   1.13. pua_update_contact usage
+   1.11. Set db_table_lock_write parameter
+   1.12. Set check_remote_contact parameter
+   1.13. Set fetch_rows parameter
+   1.14. pua_update_contact usage
    2.1. pua_api structure
    2.2. pua_is_dialog usage example
    2.3. register_puacb usage example
@@ -97,8 +99,9 @@ Chapter 1. Admin Guide
         3.8. dlginfo_increase_version (int)
         3.9. reginfo_increase_version (int)
         3.10. db_mode (int)
-        3.11. check_remote_contact (int)
-        3.12. fetch_rows (integer)
+        3.11. db_table_lock_write (integer)
+        3.12. check_remote_contact (int)
+        3.13. fetch_rows (integer)
 
    4. Functions
 
@@ -166,8 +169,9 @@ Chapter 1. Admin Guide
    3.8. dlginfo_increase_version (int)
    3.9. reginfo_increase_version (int)
    3.10. db_mode (int)
-   3.11. check_remote_contact (int)
-   3.12. fetch_rows (integer)
+   3.11. db_table_lock_write (integer)
+   3.12. check_remote_contact (int)
+   3.13. fetch_rows (integer)
 
 3.1. hash_size (int)
 
@@ -303,7 +307,20 @@ modparam("pua", "reginfo_increase_version", 1)
 modparam("pua", "db_mode", 0)
 ...
 
-3.11. check_remote_contact (int)
+3.11. db_table_lock_write (integer)
+
+   Enable (=1) or disable (=0) the Locks for table during an transaction.
+   Locking only the "current" table causes problems with a MySQL-Databases
+   in "DB-Only" mode.
+
+   Default value is 1 (Write Lock for the Tables).
+
+   Example 1.11. Set db_table_lock_write parameter
+...
+modparam("pua", "db_table_lock_write", 0)
+...
+
+3.12. check_remote_contact (int)
 
    When sending a SUBSCRIBE check that the remote contact matches the one
    in the stored dialog or not. If the remote contact is checked and does
@@ -315,18 +332,18 @@ modparam("pua", "db_mode", 0)
 
    Default value is "1".
 
-   Example 1.11. Set check_remote_contact parameter
+   Example 1.12. Set check_remote_contact parameter
 ...
 modparam("pua", "check_remote_contact", 0)
 ...
 
-3.12. fetch_rows (integer)
+3.13. fetch_rows (integer)
 
    Number of rows to be loaded in one step from database.
 
    Default value is 500.
 
-   Example 1.12. Set fetch_rows parameter
+   Example 1.13. Set fetch_rows parameter
 ...
 modparam("pua", "fetch_rows", 1000)
 ...
@@ -335,7 +352,7 @@ modparam("pua", "fetch_rows", 1000)
 
    4.1. pua_update_contact()
 
-4.1.  pua_update_contact()
+4.1. pua_update_contact()
 
    The remote target can be updated by the Contact of a subsequent in
    dialog request. In the PUA watcher case (sending a SUBSCRIBE messages),
@@ -350,7 +367,7 @@ modparam("pua", "fetch_rows", 1000)
      * 1 - if success.
      * -1 - if error.
 
-   Example 1.13. pua_update_contact usage
+   Example 1.14. pua_update_contact usage
 ...
 if(method=="NOTIFY")
     pua_update_contact();
@@ -360,7 +377,7 @@ if(method=="NOTIFY")
 
    5.1. pua_cleanup
 
-5.1.  pua_cleanup
+5.1. pua_cleanup
 
    Manually triggers the cleanup functions for the pua table. Useful if
    you have set update_period to zero or less.
@@ -395,7 +412,7 @@ Chapter 2. Developer Guide
    The module provides the following functions that can be used by other
    Kamailio modules.
 
-1.  bind_pua(pua_api_t* api)
+1. bind_pua(pua_api_t* api)
 
    This function binds the pua modules and fills the structure with the
    two exported functions.
@@ -411,7 +428,7 @@ typedef struct pua_api {
 } pua_api_t;
 ...
 
-2.  send_publish
+2. send_publish
 
    Field type:
 ...
@@ -453,7 +470,7 @@ typedef struct publ_info
 }publ_info_t;
 ...
 
-3.  send_subscribe
+3. send_subscribe
 
    Field type:
 ...
@@ -492,7 +509,7 @@ typedef struct subs_info
 }subs_info_t;
 ...
 
-4.  is_dialog
+4. is_dialog
 
    Field type:
 ...
@@ -511,7 +528,7 @@ typedef int  (*query_dialog_t)(ua_pres_t* presentity);
         }
 ...
 
-5.  register_puacb
+5. register_puacb
 
    Field type:
 ...
@@ -540,7 +557,7 @@ typedef int (*register_puacb_t)(int types, pua_cb f, void* param );
 typedef int (pua_cb)(ua_pres_t* hentity, struct sip_msg*);
 ...
 
-6.  add_event
+6. add_event
 
    Field type:
 ...