浏览代码

usrloc: fixed type for db_ops_parameter

- reported by Alex Hermann
Daniel-Constantin Mierla 12 年之前
父节点
当前提交
acd0bfb5ac
共有 2 个文件被更改,包括 38 次插入38 次删除
  1. 37 37
      modules/usrloc/README
  2. 1 1
      modules/usrloc/doc/usrloc_admin.xml

+ 37 - 37
modules/usrloc/README

@@ -16,9 +16,9 @@ Edited by
 
 
 Bogdan-Andrei Iancu
 Bogdan-Andrei Iancu
 
 
-   Copyright (c) 2003 FhG FOKUS
+   Copyright © 2003 FhG FOKUS
 
 
-   Copyright (c) 2005 Voice Sistem SRL
+   Copyright © 2005 Voice Sistem SRL
      __________________________________________________________________
      __________________________________________________________________
 
 
    Table of Contents
    Table of Contents
@@ -67,7 +67,7 @@ Bogdan-Andrei Iancu
               3.29. db_check_update (string)
               3.29. db_check_update (string)
               3.30. timer_procs (string)
               3.30. timer_procs (string)
               3.31. xavp_contact (string)
               3.31. xavp_contact (string)
-              3.32. db_ops_ruid (string)
+              3.32. db_ops_ruid (int)
 
 
         4. Functions
         4. Functions
         5. MI Commands
         5. MI Commands
@@ -204,7 +204,7 @@ Chapter 1. Admin Guide
         3.29. db_check_update (string)
         3.29. db_check_update (string)
         3.30. timer_procs (string)
         3.30. timer_procs (string)
         3.31. xavp_contact (string)
         3.31. xavp_contact (string)
-        3.32. db_ops_ruid (string)
+        3.32. db_ops_ruid (int)
 
 
    4. Functions
    4. Functions
    5. MI Commands
    5. MI Commands
@@ -324,7 +324,7 @@ Chapter 1. Admin Guide
    3.29. db_check_update (string)
    3.29. db_check_update (string)
    3.30. timer_procs (string)
    3.30. timer_procs (string)
    3.31. xavp_contact (string)
    3.31. xavp_contact (string)
-   3.32. db_ops_ruid (string)
+   3.32. db_ops_ruid (int)
 
 
 3.1. nat_bflag (integer)
 3.1. nat_bflag (integer)
 
 
@@ -751,7 +751,7 @@ modparam("usrloc", "timer_procs", 4)
 modparam("usrloc", "xavp_contact", "ulattrs")
 modparam("usrloc", "xavp_contact", "ulattrs")
 ...
 ...
 
 
-3.32. db_ops_ruid (string)
+3.32. db_ops_ruid (int)
 
 
    If set to 1, database queries for update or delete are done using ruid
    If set to 1, database queries for update or delete are done using ruid
    value. If it is set to 0, the old style using aor, contact and call-id
    value. If it is set to 0, the old style using aor, contact and call-id
@@ -777,7 +777,7 @@ modparam("usrloc", "db_ops_ruid", 1)
    5.5. ul_add
    5.5. ul_add
    5.6. ul_show_contact
    5.6. ul_show_contact
 
 
-5.1.  ul_rm
+5.1. ul_rm
 
 
    Deletes an entire AOR record (including its contacts).
    Deletes an entire AOR record (including its contacts).
 
 
@@ -786,7 +786,7 @@ modparam("usrloc", "db_ops_ruid", 1)
      * AOR - user AOR in username[@domain] format (domain must be supplied
      * AOR - user AOR in username[@domain] format (domain must be supplied
        only if use_domain option is on).
        only if use_domain option is on).
 
 
-5.2.  ul_rm_contact
+5.2. ul_rm_contact
 
 
    Deletes a contact from an AOR record.
    Deletes a contact from an AOR record.
 
 
@@ -796,7 +796,7 @@ modparam("usrloc", "db_ops_ruid", 1)
        only if use_domain option is on).
        only if use_domain option is on).
      * contact - exact contact to be removed
      * contact - exact contact to be removed
 
 
-5.3.  ul_dump
+5.3. ul_dump
 
 
    Dumps the entire content of the USRLOC in memory cache
    Dumps the entire content of the USRLOC in memory cache
 
 
@@ -805,11 +805,11 @@ modparam("usrloc", "db_ops_ruid", 1)
        "brief", a brief dump will be done (only AOR and contacts, with no
        "brief", a brief dump will be done (only AOR and contacts, with no
        other details)
        other details)
 
 
-5.4.  ul_flush
+5.4. ul_flush
 
 
    Triggers the flush of USRLOC memory cache into DB.
    Triggers the flush of USRLOC memory cache into DB.
 
 
-5.5.  ul_add
+5.5. ul_add
 
 
    Adds a new contact for an user AOR.
    Adds a new contact for an user AOR.
 
 
@@ -825,7 +825,7 @@ modparam("usrloc", "db_ops_ruid", 1)
      * cflags - per branch flags of the contact
      * cflags - per branch flags of the contact
      * methods - mask with supported requests of the contact
      * methods - mask with supported requests of the contact
 
 
-5.6.  ul_show_contact
+5.6. ul_show_contact
 
 
    Dumps the contacts of an user AOR.
    Dumps the contacts of an user AOR.
 
 
@@ -846,14 +846,14 @@ modparam("usrloc", "db_ops_ruid", 1)
    6.8. ul.db_contacts
    6.8. ul.db_contacts
    6.9. ul.db_expired_contacts
    6.9. ul.db_expired_contacts
 
 
-6.1.  ul.dump
+6.1. ul.dump
 
 
    Dumps the content of the location table
    Dumps the content of the location table
 
 
    Parameters:
    Parameters:
      * None.
      * None.
 
 
-6.2.  ul.lookup table AOR
+6.2. ul.lookup table AOR
 
 
    Looks up the contents of an AOR entry in the location table
    Looks up the contents of an AOR entry in the location table
 
 
@@ -862,7 +862,7 @@ modparam("usrloc", "db_ops_ruid", 1)
      * AOR - user AOR in username[@domain] format (domain must be supplied
      * AOR - user AOR in username[@domain] format (domain must be supplied
        only if use_domain option is on).
        only if use_domain option is on).
 
 
-6.3.  ul.rm table AOR
+6.3. ul.rm table AOR
 
 
    Deletes an entire AOR record (including its contacts).
    Deletes an entire AOR record (including its contacts).
 
 
@@ -871,7 +871,7 @@ modparam("usrloc", "db_ops_ruid", 1)
      * AOR - user AOR in username[@domain] format (domain must be supplied
      * AOR - user AOR in username[@domain] format (domain must be supplied
        only if use_domain option is on).
        only if use_domain option is on).
 
 
-6.4.  ul.rm_contact table AOR contact
+6.4. ul.rm_contact table AOR contact
 
 
    Deletes a contact from an AOR record.
    Deletes a contact from an AOR record.
 
 
@@ -881,11 +881,11 @@ modparam("usrloc", "db_ops_ruid", 1)
        only if use_domain option is on).
        only if use_domain option is on).
      * contact - exact contact to be removed
      * contact - exact contact to be removed
 
 
-6.5.  ul.flush
+6.5. ul.flush
 
 
    Triggers the flush of USRLOC memory cache into DB.
    Triggers the flush of USRLOC memory cache into DB.
 
 
-6.6.  ul.add
+6.6. ul.add
 
 
    Adds a new contact for an user AOR.
    Adds a new contact for an user AOR.
 
 
@@ -901,7 +901,7 @@ modparam("usrloc", "db_ops_ruid", 1)
      * cflags - per branch flags of the contact
      * cflags - per branch flags of the contact
      * methods - mask with supported requests of the contact
      * methods - mask with supported requests of the contact
 
 
-6.7.  ul.db_users
+6.7. ul.db_users
 
 
    Tell number of different users (AoRs) in a location table that have
    Tell number of different users (AoRs) in a location table that have
    unexpired contacts.
    unexpired contacts.
@@ -910,7 +910,7 @@ modparam("usrloc", "db_ops_ruid", 1)
      * table name - location table where the users are looked for, for
      * table name - location table where the users are looked for, for
        example, location.
        example, location.
 
 
-6.8.  ul.db_contacts
+6.8. ul.db_contacts
 
 
    Tell number of unexpired contacts in a location table.
    Tell number of unexpired contacts in a location table.
 
 
@@ -918,7 +918,7 @@ modparam("usrloc", "db_ops_ruid", 1)
      * table name - location table where the contacts are looked for, for
      * table name - location table where the contacts are looked for, for
        example, location.
        example, location.
 
 
-6.9.  ul.db_expired_contacts
+6.9. ul.db_expired_contacts
 
 
    Tell number of expired contacts in a location table.
    Tell number of expired contacts in a location table.
 
 
@@ -1007,7 +1007,7 @@ Chapter 2. Developer Guide
    1.15. ul_register_ulcb(type ,callback, param)
    1.15. ul_register_ulcb(type ,callback, param)
    1.16. ul_get_num_users()
    1.16. ul_get_num_users()
 
 
-1.1.  ul_register_domain(name)
+1.1. ul_register_domain(name)
 
 
    The function registers a new domain. Domain is just another name for
    The function registers a new domain. Domain is just another name for
    table used in registrar. The function is called from fixups in
    table used in registrar. The function is called from fixups in
@@ -1022,7 +1022,7 @@ Chapter 2. Developer Guide
      * const char* name - Name of the domain (also called table) to be
      * const char* name - Name of the domain (also called table) to be
        registered.
        registered.
 
 
-1.2.  ul_insert_urecord(domain, aor, rec)
+1.2. ul_insert_urecord(domain, aor, rec)
 
 
    The function creates a new record structure and inserts it in the
    The function creates a new record structure and inserts it in the
    specified domain. The record is structure that contains all the
    specified domain. The record is structure that contains all the
@@ -1037,7 +1037,7 @@ Chapter 2. Developer Guide
 
 
      * urecord_t** rec - The newly created record structure.
      * urecord_t** rec - The newly created record structure.
 
 
-1.3.  ul_delete_urecord(domain, aor)
+1.3. ul_delete_urecord(domain, aor)
 
 
    The function deletes all the contacts bound with the given Address Of
    The function deletes all the contacts bound with the given Address Of
    Record.
    Record.
@@ -1049,7 +1049,7 @@ Chapter 2. Developer Guide
      * str* aor - Address of record (aka username) of the record, that
      * str* aor - Address of record (aka username) of the record, that
        should be deleted.
        should be deleted.
 
 
-1.4.  ul_delete_urecord_by_ruid(domain, ruid)
+1.4. ul_delete_urecord_by_ruid(domain, ruid)
 
 
    The function deletes from given domain a contact with given ruid.
    The function deletes from given domain a contact with given ruid.
 
 
@@ -1059,7 +1059,7 @@ Chapter 2. Developer Guide
 
 
      * str* ruid - ruid of contact that should be deleted.
      * str* ruid - ruid of contact that should be deleted.
 
 
-1.5.  ul_get_urecord(domain, aor)
+1.5. ul_get_urecord(domain, aor)
 
 
    The function returns pointer to record with given Address of Record.
    The function returns pointer to record with given Address of Record.
 
 
@@ -1069,7 +1069,7 @@ Chapter 2. Developer Guide
 
 
      * str* aor - Address of Record of request record.
      * str* aor - Address of Record of request record.
 
 
-1.6.  ul_lock_udomain(domain)
+1.6. ul_lock_udomain(domain)
 
 
    The function lock the specified domain, it means, that no other
    The function lock the specified domain, it means, that no other
    processes will be able to access during the time. This prevents race
    processes will be able to access during the time. This prevents race
@@ -1080,14 +1080,14 @@ Chapter 2. Developer Guide
    Meaning of the parameters is as follows:
    Meaning of the parameters is as follows:
      * udomain_t* domain - Domain to be locked.
      * udomain_t* domain - Domain to be locked.
 
 
-1.7.  ul_unlock_udomain(domain)
+1.7. ul_unlock_udomain(domain)
 
 
    Unlock the specified domain previously locked by ul_lock_udomain.
    Unlock the specified domain previously locked by ul_lock_udomain.
 
 
    Meaning of the parameters is as follows:
    Meaning of the parameters is as follows:
      * udomain_t* domain - Domain to be unlocked.
      * udomain_t* domain - Domain to be unlocked.
 
 
-1.8.  ul_release_urecord(record)
+1.8. ul_release_urecord(record)
 
 
    Do some sanity checks - if all contacts have been removed, delete the
    Do some sanity checks - if all contacts have been removed, delete the
    entire record structure.
    entire record structure.
@@ -1095,7 +1095,7 @@ Chapter 2. Developer Guide
    Meaning of the parameters is as follows:
    Meaning of the parameters is as follows:
      * urecord_t* record - Record to be released.
      * urecord_t* record - Record to be released.
 
 
-1.9.  ul_insert_ucontact(record, contact, expires, q, callid, cseq, flags,
+1.9. ul_insert_ucontact(record, contact, expires, q, callid, cseq, flags,
 cont, ua, sock)
 cont, ua, sock)
 
 
    The function inserts a new contact in the given record with specified
    The function inserts a new contact in the given record with specified
@@ -1116,7 +1116,7 @@ cont, ua, sock)
      * struct socket_info *sock - socket on which the REGISTER message was
      * struct socket_info *sock - socket on which the REGISTER message was
        received on.
        received on.
 
 
-1.10.  ul_delete_ucontact (record, contact)
+1.10. ul_delete_ucontact (record, contact)
 
 
    The function deletes given contact from record.
    The function deletes given contact from record.
 
 
@@ -1126,7 +1126,7 @@ cont, ua, sock)
 
 
      * ucontact_t* contact - Contact to be deleted.
      * ucontact_t* contact - Contact to be deleted.
 
 
-1.11.  ul_get_ucontact(record, contact)
+1.11. ul_get_ucontact(record, contact)
 
 
    The function tries to find contact with given Contact URI and returns
    The function tries to find contact with given Contact URI and returns
    pointer to structure representing the contact.
    pointer to structure representing the contact.
@@ -1136,7 +1136,7 @@ cont, ua, sock)
 
 
      * str_t* contact - URI of the request contact.
      * str_t* contact - URI of the request contact.
 
 
-1.12.  ul_get_all_ucontacts (buf, len, flags)
+1.12. ul_get_all_ucontacts (buf, len, flags)
 
 
    The function retrieves all contacts of all registered users and returns
    The function retrieves all contacts of all registered users and returns
    them in the caller-supplied buffer. If the buffer is too small, the
    them in the caller-supplied buffer. If the buffer is too small, the
@@ -1157,7 +1157,7 @@ cont, ua, sock)
 
 
      * unsigned int flags - Flags that must be set.
      * unsigned int flags - Flags that must be set.
 
 
-1.13.  ul_update_ucontact(contact, expires, q, callid, cseq, set, res, ua,
+1.13. ul_update_ucontact(contact, expires, q, callid, cseq, set, res, ua,
 sock)
 sock)
 
 
    The function updates contact with new values.
    The function updates contact with new values.
@@ -1176,7 +1176,7 @@ sock)
      * struct socket_info *sock - socket on which the REGISTER message was
      * struct socket_info *sock - socket on which the REGISTER message was
        received on.
        received on.
 
 
-1.14.  ul_bind_ursloc( api )
+1.14. ul_bind_ursloc( api )
 
 
    The function imports all functions that are exported by the USRLOC
    The function imports all functions that are exported by the USRLOC
    module. Overs for other modules which want to user the internal USRLOC
    module. Overs for other modules which want to user the internal USRLOC
@@ -1185,7 +1185,7 @@ sock)
    Meaning of the parameters is as follows:
    Meaning of the parameters is as follows:
      * usrloc_api_t* api - USRLOC API
      * usrloc_api_t* api - USRLOC API
 
 
-1.15.  ul_register_ulcb(type ,callback, param)
+1.15. ul_register_ulcb(type ,callback, param)
 
 
    The function register with USRLOC a callback function to be called when
    The function register with USRLOC a callback function to be called when
    some event occures inside USRLOC.
    some event occures inside USRLOC.
@@ -1198,6 +1198,6 @@ sock)
      * void *param - some parameter to be passed to the callback each time
      * void *param - some parameter to be passed to the callback each time
        when it is called.
        when it is called.
 
 
-1.16.  ul_get_num_users()
+1.16. ul_get_num_users()
 
 
    The function loops through all domains summing up the number of users.
    The function loops through all domains summing up the number of users.

+ 1 - 1
modules/usrloc/doc/usrloc_admin.xml

@@ -854,7 +854,7 @@ modparam("usrloc", "xavp_contact", "ulattrs")
 	</section>
 	</section>
 
 
 	<section id="usrloc.p.db_ops_ruid">
 	<section id="usrloc.p.db_ops_ruid">
-		<title><varname>db_ops_ruid</varname> (string)</title>
+		<title><varname>db_ops_ruid</varname> (int)</title>
 		<para>
 		<para>
 			If set to 1, database queries for update or delete are done using
 			If set to 1, database queries for update or delete are done using
 			ruid value. If it is set to 0, the old style using aor, contact and
 			ruid value. If it is set to 0, the old style using aor, contact and