src/modules/usrloc/README
31ccf6a2
 usrloc Module
 
 Jan Janak
 
    FhG FOKUS
 
9fc784c6
 Daniel-Constantin Mierla
 
    <miconda@gmail.com>
 
31ccf6a2
 Edited by
 
 Jan Janak
 
 Bogdan-Andrei Iancu
 
a6609f5f
 Carsten Bock
 
    ng-voice GmbH
 
9cb2a163
    Copyright © 2003 FhG FOKUS
a6609f5f
 
9cb2a163
    Copyright © 2005 Voice Sistem SRL
31ccf6a2
 
9cb2a163
    Copyright © 2015 ng-voice GmbH
83ce345f
      __________________________________________________________________
31ccf6a2
 
    Table of Contents
d77df08a
 
9fc784c6
    1. Admin Guide
31ccf6a2
 
83ce345f
         1. Overview
 
               1.1. Contact matching
 
         2. Dependencies
 
               2.1. Kamailio Modules
               2.2. External Libraries or Applications
 
ba7961bb
         3. Parameters
83ce345f
 
5bd5df36
               3.1. nat_bflag (int)
83ce345f
               3.2. user_column (string)
               3.3. domain_column (string)
               3.4. contact_column (string)
               3.5. expires_column (string)
               3.6. q_column (string)
               3.7. callid_column (string)
               3.8. cseq_column (string)
               3.9. methods_column (string)
               3.10. flags_column (string)
               3.11. cflags_column (string)
               3.12. user_agent_column (string)
               3.13. received_column (string)
               3.14. socket_column (string)
               3.15. path_column (string)
05823430
               3.16. ruid_column (string)
               3.17. instance_column (string)
a8395274
               3.18. reg_id_column (string)
               3.19. server_id_column (string)
               3.20. connection_id_column (string)
               3.21. keepalive_column (string)
               3.22. partition_column (string)
               3.23. use_domain (int)
               3.24. desc_time_order (int)
               3.25. timer_interval (int)
               3.26. db_url (string)
               3.27. db_mode (int)
               3.28. db_load (int)
               3.29. db_insert_update (int)
               3.30. matching_mode (int)
               3.31. cseq_delay (int)
               3.32. fetch_rows (int)
               3.33. hash_size (int)
               3.34. preload (string)
               3.35. db_update_as_insert (int)
               3.36. db_check_update (int)
               3.37. timer_procs (int)
               3.38. xavp_contact (string)
               3.39. db_ops_ruid (int)
               3.40. handle_lost_tcp (int)
               3.41. close_expired_tcp (int)
               3.42. expires_type (int)
               3.43. db_raw_fetch_type (int)
               3.44. db_insert_null (int)
               3.45. skip_remote_socket (int)
               3.46. db_timer_clean (int)
               3.47. rm_expired_delay (int)
               3.48. server_id_filter (int)
               3.49. version_table (int)
b4d38c4a
               3.50. ka_mode (int)
               3.51. ka_method (str)
               3.52. ka_from (str)
               3.53. ka_domain (str)
7d1e27e9
               3.54. ka_filter (int)
609685c9
               3.55. ka_timeout (int)
               3.56. ka_loglevel (int)
               3.57. ka_logmsg (str)
83ce345f
 
1a8f9729
         4. RPC Commands
 
               4.1. ul.dump
               4.2. ul.lookup table AOR
               4.3. ul.rm table AOR
               4.4. ul.rm_contact table AOR contact
               4.5. ul.flush
               4.6. ul.add
               4.7. ul.db_users
               4.8. ul.db_contacts
               4.9. ul.db_expired_contacts
 
         5. Statistics
 
               5.1. users
               5.2. contacts
               5.3. expires
               5.4. registered_users
31ccf6a2
 
9fc784c6
    2. Developer Guide
31ccf6a2
 
83ce345f
         1. Available Functions
31ccf6a2
 
83ce345f
               1.1. ul_register_domain(name)
               1.2. ul_insert_urecord(domain, aor, rec)
               1.3. ul_delete_urecord(domain, aor)
6c385398
               1.4. ul_delete_urecord_by_ruid(domain, ruid)
               1.5. ul_get_urecord(domain, aor)
               1.6. ul_lock_udomain(domain)
               1.7. ul_unlock_udomain(domain)
               1.8. ul_release_urecord(record)
               1.9. ul_insert_ucontact(record, contact, expires, q, callid,
83ce345f
                       cseq, flags, cont, ua, sock)
31ccf6a2
 
6c385398
               1.10. ul_delete_ucontact (record, contact)
               1.11. ul_get_ucontact(record, contact)
               1.12. ul_get_all_ucontacts (buf, len, flags)
               1.13. ul_update_ucontact(contact, expires, q, callid, cseq,
83ce345f
                       set, res, ua, sock)
31ccf6a2
 
6c385398
               1.14. ul_bind_ursloc( api )
               1.15. ul_register_ulcb(type ,callback, param)
               1.16. ul_get_num_users()
31ccf6a2
 
    List of Examples
d77df08a
 
    1.1. Set nat_bflag parameter
    1.2. Set user_column parameter
    1.3. Set user_column parameter
    1.4. Set contact_column parameter
    1.5. Set expires_column parameter
    1.6. Set q_column parameter
    1.7. Set callid_column parameter
    1.8. Set cseq_column parameter
    1.9. Set methods_column parameter
    1.10. Set flags_column parameter
    1.11. Set cflags_column parameter
    1.12. Set user_agent_column parameter
    1.13. Set received_column parameter
    1.14. Set socket_column parameter
    1.15. Set path_column parameter
05823430
    1.16. Set ruid_column parameter
    1.17. Set instance_column parameter
a8395274
    1.18. Set reg_id_column parameter
    1.19. Set server_id_column parameter
    1.20. Set connection_id_column parameter
    1.21. Set keepalive_column parameter
    1.22. Set partition_column parameter
    1.23. Set use_domain parameter
    1.24. Set desc_time_order parameter
    1.25. Set timer_interval parameter
    1.26. Set db_url parameter
    1.27. Set db_mode parameter
    1.28. Set db_load parameter
    1.29. Set db_insert_update parameter
    1.30. Set matching_mode parameter
    1.31. Set cseq_delay parameter
    1.32. Set fetch_rows parameter
    1.33. Set hash_size parameter
    1.34. Set preload parameter
    1.35. Set db_update_as_insert parameter
    1.36. Set db_check_update parameter
    1.37. Set timer_procs parameter
    1.38. Set xavp_contact parameter
    1.39. Set db_ops_ruid parameter
    1.40. Set handle_lost_tcp parameter
    1.41. Set close_expired_tcp parameter
    1.42. Set expires_type parameter
    1.43. Set db_raw_fetch_type parameter
    1.44. Set db_insert_null parameter
    1.45. Set skip_remote_socket parameter
    1.46. Set db_timer_clean parameter
    1.47. Set rm_expired_delay parameter
    1.48. Set server_id_filter parameter
    1.49. version_table parameter usage
b4d38c4a
    1.50. ka_mode parameter usage
    1.51. ka_method parameter usage
    1.52. ka_from parameter usage
    1.53. ka_domain parameter usage
7d1e27e9
    1.54. ka_filter parameter usage
609685c9
    1.55. Set ka_timeout parameter
    1.56. ka_loglevel parameter usage
    1.57. ka_logmsg parameter usage
31ccf6a2
 
9fc784c6
 Chapter 1. Admin Guide
31ccf6a2
 
83ce345f
    Table of Contents
 
    1. Overview
 
         1.1. Contact matching
 
    2. Dependencies
 
         2.1. Kamailio Modules
         2.2. External Libraries or Applications
 
ba7961bb
    3. Parameters
83ce345f
 
5bd5df36
         3.1. nat_bflag (int)
83ce345f
         3.2. user_column (string)
         3.3. domain_column (string)
         3.4. contact_column (string)
         3.5. expires_column (string)
         3.6. q_column (string)
         3.7. callid_column (string)
         3.8. cseq_column (string)
         3.9. methods_column (string)
         3.10. flags_column (string)
         3.11. cflags_column (string)
         3.12. user_agent_column (string)
         3.13. received_column (string)
         3.14. socket_column (string)
         3.15. path_column (string)
05823430
         3.16. ruid_column (string)
         3.17. instance_column (string)
a8395274
         3.18. reg_id_column (string)
         3.19. server_id_column (string)
         3.20. connection_id_column (string)
         3.21. keepalive_column (string)
         3.22. partition_column (string)
         3.23. use_domain (int)
         3.24. desc_time_order (int)
         3.25. timer_interval (int)
         3.26. db_url (string)
         3.27. db_mode (int)
         3.28. db_load (int)
         3.29. db_insert_update (int)
         3.30. matching_mode (int)
         3.31. cseq_delay (int)
         3.32. fetch_rows (int)
         3.33. hash_size (int)
         3.34. preload (string)
         3.35. db_update_as_insert (int)
         3.36. db_check_update (int)
         3.37. timer_procs (int)
         3.38. xavp_contact (string)
         3.39. db_ops_ruid (int)
         3.40. handle_lost_tcp (int)
         3.41. close_expired_tcp (int)
         3.42. expires_type (int)
         3.43. db_raw_fetch_type (int)
         3.44. db_insert_null (int)
         3.45. skip_remote_socket (int)
         3.46. db_timer_clean (int)
         3.47. rm_expired_delay (int)
         3.48. server_id_filter (int)
         3.49. version_table (int)
b4d38c4a
         3.50. ka_mode (int)
         3.51. ka_method (str)
         3.52. ka_from (str)
         3.53. ka_domain (str)
7d1e27e9
         3.54. ka_filter (int)
609685c9
         3.55. ka_timeout (int)
         3.56. ka_loglevel (int)
         3.57. ka_logmsg (str)
83ce345f
 
1a8f9729
    4. RPC Commands
83ce345f
 
1a8f9729
         4.1. ul.dump
         4.2. ul.lookup table AOR
         4.3. ul.rm table AOR
         4.4. ul.rm_contact table AOR contact
         4.5. ul.flush
         4.6. ul.add
         4.7. ul.db_users
         4.8. ul.db_contacts
         4.9. ul.db_expired_contacts
875c5e71
 
1a8f9729
    5. Statistics
83ce345f
 
1a8f9729
         5.1. users
         5.2. contacts
         5.3. expires
         5.4. registered_users
83ce345f
 
 1. Overview
 
    1.1. Contact matching
 
5e77d14b
    The User location module module keeps a user location table and
    provides access to the table for other modules. The module exports no
    functions that can be used directly from routing scripts.
83ce345f
 
 1.1. Contact matching
 
5e77d14b
    How the contacts are matched (for the same AOR - Address of Record) is
    an important aspect of the usrloc module, especially in the context of
    NAT traversal - this raises more problems since contacts from different
    phones of the same user may overlap (if both are behind NATs with the
    same configuration) or the re-register contact of the same phone may be
    seen as a new one (due different binding via NAT).
83ce345f
 
    The SIP RFC 3261 publishes a matching algorithm based only on the
5e77d14b
    contact string with Call-id and Cseq extra checking (if the Call-ID is
    the same, it must have a higher Cseq number, otherwise it is invalid).
8868e624
    But as argued above, this is not enough in NAT traversal context, so
    the Kamailio implementation of contact matching offers more algorithms:
5e77d14b
      * Contact based only - it is strict RFC 3261 compliancy - the Contact
        URI is matched as string and extra checked via Call-ID and cseq (if
        Call-ID is the same, it must have a higher cseq number, otherwise
        it is invalid).
      * Contact and Call-id based - it is an extension of the first case -
        the contact and Call-ID must be matched as string; the cseq must be
61b81832
        higher than the previous one - so be careful how you deal with
        REGISTER retransmissions in this case.
      * contact and path based - it is an extension of the first case - the
        contact and path must be matched as string; the cseq must be higher
83ce345f
        than the previous one - so be careful how you deal with REGISTER
        retransmissions in this case.
eb4644db
      * Call-id only based - it is not according to RFC3261, as it will
        check the Call-ID only (independent of the Contact-Header or Path).
83ce345f
 
8868e624
    To find out how to control/select the contact matching algorithm,
a8395274
    please see the module parameter matching_mode - Section 3.30,
5bd5df36
    “matching_mode (int)”.
83ce345f
 
 2. Dependencies
 
    2.1. Kamailio Modules
    2.2. External Libraries or Applications
 
 2.1. Kamailio Modules
31ccf6a2
 
    The following modules must be loaded before this module:
      * Optionally a database module.
 
83ce345f
 2.2. External Libraries or Applications
31ccf6a2
 
83ce345f
    The following libraries or applications must be installed before
    running Kamailio with this module loaded:
31ccf6a2
      * None.
 
ba7961bb
 3. Parameters
83ce345f
 
5bd5df36
    3.1. nat_bflag (int)
83ce345f
    3.2. user_column (string)
    3.3. domain_column (string)
    3.4. contact_column (string)
    3.5. expires_column (string)
    3.6. q_column (string)
    3.7. callid_column (string)
    3.8. cseq_column (string)
    3.9. methods_column (string)
    3.10. flags_column (string)
    3.11. cflags_column (string)
    3.12. user_agent_column (string)
    3.13. received_column (string)
    3.14. socket_column (string)
    3.15. path_column (string)
05823430
    3.16. ruid_column (string)
    3.17. instance_column (string)
a8395274
    3.18. reg_id_column (string)
    3.19. server_id_column (string)
    3.20. connection_id_column (string)
    3.21. keepalive_column (string)
    3.22. partition_column (string)
    3.23. use_domain (int)
    3.24. desc_time_order (int)
    3.25. timer_interval (int)
    3.26. db_url (string)
    3.27. db_mode (int)
    3.28. db_load (int)
    3.29. db_insert_update (int)
    3.30. matching_mode (int)
    3.31. cseq_delay (int)
    3.32. fetch_rows (int)
    3.33. hash_size (int)
    3.34. preload (string)
    3.35. db_update_as_insert (int)
    3.36. db_check_update (int)
    3.37. timer_procs (int)
    3.38. xavp_contact (string)
    3.39. db_ops_ruid (int)
    3.40. handle_lost_tcp (int)
    3.41. close_expired_tcp (int)
    3.42. expires_type (int)
    3.43. db_raw_fetch_type (int)
    3.44. db_insert_null (int)
    3.45. skip_remote_socket (int)
    3.46. db_timer_clean (int)
    3.47. rm_expired_delay (int)
    3.48. server_id_filter (int)
    3.49. version_table (int)
b4d38c4a
    3.50. ka_mode (int)
    3.51. ka_method (str)
    3.52. ka_from (str)
    3.53. ka_domain (str)
7d1e27e9
    3.54. ka_filter (int)
609685c9
    3.55. ka_timeout (int)
    3.56. ka_loglevel (int)
    3.57. ka_logmsg (str)
83ce345f
 
5bd5df36
 3.1. nat_bflag (int)
83ce345f
 
    The index of the branch flag to be used as NAT marker (if the contact
    is or not natted). This is a branch flag and it will be imported and
    used by all other modules depending of usrloc module.
 
9cb2a163
    Default value is “not set”.
cffbf08f
 
d77df08a
    Example 1.1. Set nat_bflag parameter
cffbf08f
 ...
 modparam("usrloc", "nat_bflag", 3)
 ...
 
83ce345f
 3.2. user_column (string)
31ccf6a2
 
5e77d14b
    Name of database column containing usernames.
31ccf6a2
 
9cb2a163
    Default value is “username”.
31ccf6a2
 
d77df08a
    Example 1.2. Set user_column parameter
31ccf6a2
 ...
 modparam("usrloc", "user_column", "username")
 ...
 
83ce345f
 3.3. domain_column (string)
31ccf6a2
 
5e77d14b
    Name of database column containing domains.
31ccf6a2
 
9cb2a163
    Default value is “domain”.
31ccf6a2
 
d77df08a
    Example 1.3. Set user_column parameter
31ccf6a2
 ...
 modparam("usrloc", "domain_column", "domain")
 ...
 
83ce345f
 3.4. contact_column (string)
31ccf6a2
 
5e77d14b
    Name of database column containing contacts.
31ccf6a2
 
9cb2a163
    Default value is “contact”.
31ccf6a2
 
d77df08a
    Example 1.4. Set contact_column parameter
31ccf6a2
 ...
 modparam("usrloc", "contact_column", "contact")
 ...
 
83ce345f
 3.5. expires_column (string)
31ccf6a2
 
5e77d14b
    Name of database column containing expires value.
31ccf6a2
 
9cb2a163
    Default value is “expires”.
31ccf6a2
 
d77df08a
    Example 1.5. Set expires_column parameter
31ccf6a2
 ...
 modparam("usrloc", "expires_column", "expires")
 ...
 
83ce345f
 3.6. q_column (string)
31ccf6a2
 
5e77d14b
    Name of database column containing q values.
31ccf6a2
 
9cb2a163
    Default value is “q”.
31ccf6a2
 
d77df08a
    Example 1.6. Set q_column parameter
31ccf6a2
 ...
 modparam("usrloc", "q_column", "q")
 ...
 
83ce345f
 3.7. callid_column (string)
31ccf6a2
 
5e77d14b
    Name of database column containing Call-ID values.
31ccf6a2
 
9cb2a163
    Default value is “callid”.
31ccf6a2
 
d77df08a
    Example 1.7. Set callid_column parameter
31ccf6a2
 ...
 modparam("usrloc", "callid_column", "callid")
 ...
 
83ce345f
 3.8. cseq_column (string)
31ccf6a2
 
5e77d14b
    Name of database column containing Cseq.
31ccf6a2
 
9cb2a163
    Default value is “cseq”.
31ccf6a2
 
d77df08a
    Example 1.8. Set cseq_column parameter
31ccf6a2
 ...
 modparam("usrloc", "cseq_column", "cseq")
 ...
 
83ce345f
 3.9. methods_column (string)
31ccf6a2
 
5e77d14b
    Name of database column containing supported methods.
31ccf6a2
 
9cb2a163
    Default value is “methods”.
31ccf6a2
 
d77df08a
    Example 1.9. Set methods_column parameter
31ccf6a2
 ...
0b7b6f4f
 modparam("usrloc", "methods_column", "methods")
31ccf6a2
 ...
 
83ce345f
 3.10. flags_column (string)
31ccf6a2
 
5e77d14b
    Name of database column to save the internal flags of the record.
31ccf6a2
 
9cb2a163
    Default value is “flags”.
31ccf6a2
 
d77df08a
    Example 1.10. Set flags_column parameter
31ccf6a2
 ...
 modparam("usrloc", "flags_column", "flags")
 ...
 
83ce345f
 3.11. cflags_column (string)
9f26bb5c
 
5e77d14b
    Name of database column to save the branch/contact flags of the record.
9f26bb5c
 
9cb2a163
    Default value is “cflags”.
9f26bb5c
 
d77df08a
    Example 1.11. Set cflags_column parameter
9f26bb5c
 ...
 modparam("usrloc", "cflags_column", "cflags")
 ...
 
83ce345f
 3.12. user_agent_column (string)
31ccf6a2
 
5e77d14b
    Name of database column containing user-agent values.
31ccf6a2
 
9cb2a163
    Default value is “user_agent”.
31ccf6a2
 
d77df08a
    Example 1.12. Set user_agent_column parameter
31ccf6a2
 ...
 modparam("usrloc", "user_agent_column", "user_agent")
 ...
 
83ce345f
 3.13. received_column (string)
31ccf6a2
 
5e77d14b
    Name of database column containing the source IP, port, and protocol
    from the REGISTER message.
31ccf6a2
 
9cb2a163
    Default value is “received”.
31ccf6a2
 
d77df08a
    Example 1.13. Set received_column parameter
31ccf6a2
 ...
 modparam("usrloc", "received_column", "received")
 ...
 
83ce345f
 3.14. socket_column (string)
31ccf6a2
 
5e77d14b
    Name of database column containing the received socket information
    (IP:port) for the REGISTER message.
31ccf6a2
 
9cb2a163
    Default value is “socket”.
31ccf6a2
 
d77df08a
    Example 1.14. Set socket_column parameter
31ccf6a2
 ...
 modparam("usrloc", "socket_column", "socket")
 ...
 
83ce345f
 3.15. path_column (string)
1061d103
 
5e77d14b
    Name of database column containing the Path header.
1061d103
 
9cb2a163
    Default value is “path”.
1061d103
 
d77df08a
    Example 1.15. Set path_column parameter
1061d103
 ...
 modparam("usrloc", "path_column", "path")
 ...
 
05823430
 3.16. ruid_column (string)
 
5e77d14b
    Name of database column containing the Kamailio record unique id.
05823430
 
9cb2a163
    Default value is “ruid”.
05823430
 
    Example 1.16. Set ruid_column parameter
 ...
 modparam("usrloc", "ruid_column", "myruid")
 ...
 
 3.17. instance_column (string)
 
5e77d14b
    Name of database column containing the SIP instance ID (GRUU -
    RFC5627). This is a unique device identifier - UUID.
05823430
 
9cb2a163
    Default value is “instance”.
05823430
 
    Example 1.17. Set instance_column parameter
 ...
 modparam("usrloc", "instance_column", "myinstance")
 ...
 
a8395274
 3.18. reg_id_column (string)
 
    Name of database table column containing the value for reg-id.
 
    Default value is “reg_id”.
 
    Example 1.18. Set reg_id_column parameter
 ...
 modparam("usrloc", "reg_id_column", "r_id")
 ...
 
 3.19. server_id_column (string)
64dc2bbb
 
    Name of database table column containing the value for server id.
 
9cb2a163
    Default value is “server_id”.
64dc2bbb
 
a8395274
    Example 1.19. Set server_id_column parameter
64dc2bbb
 ...
 modparam("usrloc", "server_id_column", "srv_id")
 ...
 
a8395274
 3.20. connection_id_column (string)
64dc2bbb
 
    Name of database table column containing the value for connection id.
 
9cb2a163
    Default value is “connection_id”.
64dc2bbb
 
a8395274
    Example 1.20. Set connection_id_column parameter
64dc2bbb
 ...
 modparam("usrloc", "connection_id_column", "con_id")
 ...
 
a8395274
 3.21. keepalive_column (string)
64dc2bbb
 
    Name of database table column containing the value for keepalive
    status.
 
9cb2a163
    Default value is “keepalive”.
64dc2bbb
 
a8395274
    Example 1.21. Set keepalive_column parameter
64dc2bbb
 ...
 modparam("usrloc", "keepalive_column", "kalive")
 ...
 
a8395274
 3.22. partition_column (string)
b579d64f
 
    Name of database table column containing the value for partition id.
 
    Default value is “partition”.
 
a8395274
    Example 1.22. Set partition_column parameter
b579d64f
 ...
 modparam("usrloc", "partition_column", "part")
 ...
 
a8395274
 3.23. use_domain (int)
31ccf6a2
 
83ce345f
    If the domain part of the user should be also saved and used for
8868e624
    identifying the user (along with the username part). Useful in multi
83ce345f
    domain scenarios. Non 0 value means true.
31ccf6a2
 
9cb2a163
    Default value is “0 (false)”.
31ccf6a2
 
a8395274
    Example 1.23. Set use_domain parameter
31ccf6a2
 ...
 modparam("usrloc", "use_domain", 1)
 ...
 
a8395274
 3.24. desc_time_order (int)
31ccf6a2
 
83ce345f
    If the user's contacts should be kept timestamp ordered; otherwise the
    contact will be ordered based on q value. Non 0 value means true.
31ccf6a2
 
9cb2a163
    Default value is “0 (false)”.
31ccf6a2
 
a8395274
    Example 1.24. Set desc_time_order parameter
31ccf6a2
 ...
 modparam("usrloc", "desc_time_order", 1)
 ...
 
a8395274
 3.25. timer_interval (int)
31ccf6a2
 
5e77d14b
    Number of seconds between two timer runs. The module uses a timer to
609685c9
    delete expired contacts, synchronize with database, send keepalives and
    other tasks, that need to be run periodically.
31ccf6a2
 
989206bd
    Default value is 60.
31ccf6a2
 
a8395274
    Example 1.25. Set timer_interval parameter
31ccf6a2
 ...
 modparam("usrloc", "timer_interval", 120)
 ...
 
a8395274
 3.26. db_url (string)
31ccf6a2
 
    URL of the database that should be used.
 
9cb2a163
    Default value is “mysql://kamailio:kamailiorw@localhost/kamailio”.
31ccf6a2
 
a8395274
    Example 1.26. Set db_url parameter
31ccf6a2
 ...
83ce345f
 modparam("usrloc", "db_url", "dbdriver://username:password@dbhost/dbname")
 ...
 
a8395274
 3.27. db_mode (int)
83ce345f
 
5e77d14b
    The usrloc module can utilize a database for persistent contact
    storage. If a database is used, the location database (contacts) will
    survive machine restarts or software crashes. The disadvantage is that
    accessing a database can be very time consuming. Therefore, usrloc
    module implements four database accessing modes:
83ce345f
      * 0 - This disables database completely. Only memory will be used.
        Contacts will not survive restart. Use this value if you need a
        really fast usrloc and contact persistence is not necessary or is
        provided by other means.
      * 1 - Write-Through scheme. All changes to usrloc are immediately
        reflected in database too. This is very slow, but very reliable.
        Use this scheme if speed is not your priority but need to make sure
        that no registered contacts will be lost during crash or reboot.
      * 2 - Write-Back scheme. This is a combination of previous two
        schemes. All changes are made to memory and database
        synchronization is done in the timer. The timer deletes all expired
        contacts and flushes all modified or new contacts to database. Use
        this scheme if you encounter high-load peaks and want them to
        process as fast as possible. The mode will not help at all if the
        load is high all the time. Also, latency of this mode is much lower
        than latency of mode 1, but slightly higher than latency of mode 0.
      * 3 - DB-Only scheme. No memory cache is kept, all operations being
        directly performed with the database. The timer deletes all expired
        contacts from database - cleans after clients that didn't
        un-register or re-register. The mode is useful if you configure
        more servers sharing the same DB without any replication at SIP
        level. The mode may be slower due the high number of DB operation.
        For example NAT pinging is a killer since during each ping cycle
8868e624
        all natted contact are loaded from the DB; The lack of memory
83ce345f
        caching also disable the statistics exports.
d80ea02f
      * 4 - This uses database to load records at startup but uses only
        memory during the runtime. Records are not written back at all, not
        even at shutdown. Useful for scenarios when registrations are
        replicated to a node that does the storage in database during
        runtime.
31ccf6a2
 
d77df08a
 Warning
31ccf6a2
 
83ce345f
    In case of crash or restart contacts that are in memory only and
    haven't been flushed yet will get lost. If you want minimize the risk,
    use shorter timer interval.
31ccf6a2
 
989206bd
    Default value is 0.
31ccf6a2
 
a8395274
    Example 1.27. Set db_mode parameter
31ccf6a2
 ...
 modparam("usrloc", "db_mode", 2)
 ...
 
a8395274
 3.28. db_load (int)
1b264954
 
    Determine if the usrloc module should load contacts from the database
    storage during module initialization A value of 0 disable the loading
    from the database, this parameter is ignored if db_mode 4 is set
 
    Default value is 1.
 
a8395274
    Example 1.28. Set db_load parameter
1b264954
 ...
5bd5df36
 modparam("usrloc", "db_load", 0)
1b264954
 ...
 
a8395274
 3.29. db_insert_update (int)
1b264954
 
    Determine if the usrloc module should do an update when a duplicate key
    is found while inserting A value of 1 will activate update on duplicate
    key
 
    Default value is 0.
 
a8395274
    Example 1.29. Set db_insert_update parameter
1b264954
 ...
5bd5df36
 modparam("usrloc", "db_insert_update", 1)
1b264954
 ...
 
a8395274
 3.30. matching_mode (int)
3877e72f
 
5bd5df36
    What contact matching algorithm to be used. Refer to section ??? for
    the description of the algorithms.
3877e72f
 
    The parameter may take the following values:
      * 0 - CONTACT ONLY based matching algorithm.
      * 1 - CONTACT and CALLID based matching algorithm.
83ce345f
      * 2 - CONTACT and PATH based matching algorithm. This mode is like
        mode 0 but allows for duplicate contacts from differing paths. If
        no path is available, it defaults to mode 0.
eb4644db
      * 3 - CALLID only based matching algorithm. This mode will discard
        any duplicate registration coming through different paths.
3877e72f
 
989206bd
    Default value is 0 (CONTACT_ONLY).
3877e72f
 
a8395274
    Example 1.30. Set matching_mode parameter
3877e72f
 ...
 modparam("usrloc", "matching_mode", 1)
 ...
 
a8395274
 3.31. cseq_delay (int)
9679b230
 
83ce345f
    Delay (in seconds) for accepting as retransmissions register requests
    with same Call-ID and Cseq. The delay is calculated starting from the
    receiving time of the first register with that Call-ID and Cseq.
9679b230
 
83ce345f
    Retransmissions within this delay interval will be accepted and replied
    as the original request, but no update will be done in location. If the
    delay is exceeded, error is reported.
9679b230
 
    A value of 0 disable the retransmission detection.
 
9cb2a163
    Default value is “20 seconds”.
9679b230
 
a8395274
    Example 1.31. Set cseq_delay parameter
9679b230
 ...
 modparam("usrloc", "cseq_delay", 5)
 ...
 
a8395274
 3.32. fetch_rows (int)
3c46477c
 
83ce345f
    The number of the rows to be fetched at once from database when loading
    the location records. This value can be used to tune the load time at
    startup. For 1MB of private memory (default) it should be below 4000.
    The database driver must support fetch_result() capability.
3c46477c
 
9cb2a163
    Default value is “2000”.
3c46477c
 
a8395274
    Example 1.32. Set fetch_rows parameter
3c46477c
 ...
 modparam("usrloc", "fetch_rows", 3000)
 ...
 
a8395274
 3.33. hash_size (int)
4e5b7dfd
 
83ce345f
    The number of entries of the hash table used by usrloc to store the
1f1b81ed
    location records is 2^hash_size. For hash_size=4, the number of slots
83ce345f
    of the hash table is 16.
4e5b7dfd
 
9cb2a163
    Default value is “10” (1024 slots).
4e5b7dfd
 
a8395274
    Example 1.33. Set hash_size parameter
4e5b7dfd
 ...
1f1b81ed
 modparam("usrloc", "hash_size", 12)
16679e6d
 ...
 
a8395274
 3.34. preload (string)
16679e6d
 
    Preload location table given as value. A location table is loaded based
    on fixup of registrar functions, therefore you need to use this
    parameter only to load tables that are not used by registrar module
    directly in configuration file.
 
9cb2a163
    Default value is “NULL”.
16679e6d
 
a8395274
    Example 1.34. Set preload parameter
16679e6d
 ...
 modparam("usrloc", "preload", "location")
4e5b7dfd
 ...
 
a8395274
 3.35. db_update_as_insert (int)
d66b9903
 
    Set this parameter if you want to do INSERT DB operations instead of
    UPDATE DB operations. It is recommended to set this parameter if you
    use Cassandra as a DB backend.
 
9cb2a163
    Default value is “0”.
d66b9903
 
a8395274
    Example 1.35. Set db_update_as_insert parameter
d66b9903
 ...
 modparam("usrloc", "db_update_as_insert", 1)
 ...
 
a8395274
 3.36. db_check_update (int)
4b68b3ca
 
    Set this parameter to 1 if you want to do DB INSERT if the number of
    affected rows by contact DB UPDATE operation is 0. The database module
    driver has to implement affected_rows() DB API function, otherwise this
    parameter is ignored - e.g., MySQL and Postgres DB connectors offer
    affected_rows().
 
9cb2a163
    Default value is “0” (no DB INSERT).
4b68b3ca
 
a8395274
    Example 1.36. Set db_check_update parameter
4b68b3ca
 ...
 modparam("usrloc", "db_check_update", 1)
 ...
 
a8395274
 3.37. timer_procs (int)
c642e504
 
    Number of timer processes to be started by module. Timer processes take
8868e624
    care of checking expired records and synchronization with database. If
c642e504
    set to 0, no dedicated timer is started, the one from core will be
    used.
 
a8395274
    If the number of timer processes is greater than 1, the workload of
    synchronization and record expiration is split up among the multiple
    processes. (Each process is assigned a range of slots from the internal
    hash table, and is responsible for cleanup and storage on those slots.)
5750b405
 
9cb2a163
    Default value is “0”.
c642e504
 
a8395274
    Example 1.37. Set timer_procs parameter
c642e504
 ...
 modparam("usrloc", "timer_procs", 4)
 ...
 
a8395274
 3.38. xavp_contact (string)
83ce345f
 
b4488aa7
    The name of XAVP storing the attributes per contact. They are saved in
    location record and restored at lookup. The tm module parameter
    xavp_contact must also be set to the same value to use the
    t_load_contacts and t_next_contacts functions.
762c216d
 
9cb2a163
    Default value is “NULL”.
e6ad428f
 
a8395274
    Example 1.38. Set xavp_contact parameter
e6ad428f
 ...
9d67099c
 modparam("tm|usrloc", "xavp_contact", "ulattrs")
e6ad428f
 ...
 
a8395274
 3.39. db_ops_ruid (int)
9106eca1
 
    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
    is done.
 
9cb2a163
    Default value is “1”.
9106eca1
 
a8395274
    Example 1.39. Set db_ops_ruid parameter
9106eca1
 ...
6a0201d8
 modparam("usrloc", "db_ops_ruid", 0)
9106eca1
 ...
 
a8395274
 3.40. handle_lost_tcp (int)
56d02f02
 
    If set to 1, Kamailio will remove location records made via
    TCP/TLS/WS/WSS transports when it looses corresponding tcp connections.
fe7351d5
    Does not currently work in DB-Only scheme.
56d02f02
 
9cb2a163
    Default value is “0”.
56d02f02
 
a8395274
    Example 1.40. Set handle_lost_tcp parameter
56d02f02
 ...
 modparam("usrloc", "handle_lost_tcp", 1)
 ...
 
a8395274
 3.41. close_expired_tcp (int)
64dc2bbb
 
    If set to 1, Kamailio will close the TCP connection when a contact has
    expired, if the corresponding transport is TCP/TLS/WS/WSS.
 
9cb2a163
    Default value is “0”.
64dc2bbb
 
a8395274
    Example 1.41. Set close_expired_tcp parameter
64dc2bbb
 ...
 modparam("usrloc", "close_expired_tcp", 1)
 ...
 
a8395274
 3.42. expires_type (int)
b1035995
 
    If set to 1, Kamailio expects to deal with BIGINT type on database
    columns for expires and last modified values. It allows to handle
6a69220e
    better the daylight time adjustments. If set to 0, those columns are
b1035995
    expected to be on default type 'DATETIME'. When it is 1, the database
    columns types have to be changed manually to 'BIGINT'.
 
9cb2a163
    Default value is “0”.
b1035995
 
a8395274
    Example 1.42. Set expires_type parameter
b1035995
 ...
 modparam("usrloc", "expires_type", 1)
 ...
 
a8395274
 3.43. db_raw_fetch_type (int)
ec1dfe89
 
    This affect DB-only mode and controls what kind of raw query is used to
    fetch the contacts from database for specific needs (e.g., sending NAT
    keepalives). If it is set to 0, then the common SQL query is used
    (working for MySQL, PostgreSQL, ...). If it is set to 1, the query
    required by Oracle is used.
 
9cb2a163
    Default value is “0”.
ec1dfe89
 
a8395274
    Example 1.43. Set db_raw_fetch_type parameter
ec1dfe89
 ...
 modparam("usrloc", "db_raw_fetch_type", 1)
 ...
 
a8395274
 3.44. db_insert_null (int)
c1edef1f
 
    If set to 1, the insert operation to database will add null values in
32d1c953
    the statement. It has to be set to 1 for the database systems that do
    not have table definitions that create automatically the null fields
    (e.g., db_mongodb) for each stored record.
 
8868e624
    When set to 0, the fields that default to null are not added to the DB
32d1c953
    insert statement if they don't have a different value, making the query
    smaller.
c1edef1f
 
9cb2a163
    Default value is “0” (don't add null fields in insert statement).
c1edef1f
 
a8395274
    Example 1.44. Set db_insert_null parameter
c1edef1f
 ...
 modparam("usrloc", "db_insert_null", 1)
 ...
 
a8395274
 3.45. skip_remote_socket (int)
eb4644db
 
    If set to 1, Kamailio will skip location record when loading from
    database, if socket value of the record does not in kamailio listening
    socket list.
 
9cb2a163
    Default value is “0”.
eb4644db
 
a8395274
    Example 1.45. Set skip_remote_socket parameter
eb4644db
 ...
 modparam("usrloc", "skip_remote_socket", 1)
 ...
 
a8395274
 3.46. db_timer_clean (int)
bfb1d0ec
 
    Enable (1) or disable (0) cleaning of expired db records on timer basis
    for db_mode WRITE-BACK and WRITE-THROUGH. It uses the secondary timer
    process.
 
9cb2a163
    Default value is “0”.
bfb1d0ec
 
a8395274
    Example 1.46. Set db_timer_clean parameter
bfb1d0ec
 ...
 modparam("usrloc", "db_timer_clean", 1)
 ...
 
a8395274
 3.47. rm_expired_delay (int)
68c476bc
 
    Specify the number of seconds to delay the removal of expired records.
    For now it works for DB_ONLY mode (db_mode=3).
 
    Default value is “0”.
 
a8395274
    Example 1.47. Set rm_expired_delay parameter
68c476bc
 ...
 modparam("usrloc", "rm_expired_delay", 30)
 ...
 
a8395274
 3.48. server_id_filter (int)
2c828e19
 
aca63625
    Enable (1) or disable (0) filter records by server_id on load and
671fc87c
    during cleaning of expired db records. It could be useful when you want
    to use the same location table for several kamailio instances which are
    configured to work in db_mode=1 or db_mode=2 (cache modes). Otherwise
    one instance of proxy cleans records made by another proxy and that
    breaks its cache.
2c828e19
 
    Default value is “0”.
 
a8395274
    Example 1.48. Set server_id_filter parameter
2c828e19
 ...
 modparam("usrloc", "server_id_filter", 1)
 ...
 
a8395274
 3.49. version_table (int)
5daba2fa
 
    If set to 0, the module will skip checking the version for location
    table.
 
    Default value is “1 (check for table version)”.
 
a8395274
    Example 1.49. version_table parameter usage
5daba2fa
 ...
 modparam("usrloc", "version_table", 0)
 ...
 
b4d38c4a
 3.50. ka_mode (int)
 
    Keepalive mode - control the internal keepalive mechanism. With this
7d1e27e9
    feature enabled, the module sends periodically (based on timer
    interval) SIP requests to location contacts and measures the round trip
    in microseconds (the round trip value can be seen in the response of
    the RPC command 'ul.dump').
b4d38c4a
 
    Its value is a set of flags:
      * 0 - if the value is zero, no keepalive is sent
7d1e27e9
      * 1 (bit 1 set) - if set to 1, the keepalive is enabled for all
        contacts
b4d38c4a
      * 2 (bit 2 set) - the keepalive is sent only for natted contacts
        (nat_bflag set)
      * 4 (bit 3 set) - the keepalive is sent only for UDP contacts
 
    For example, if set to 6, then keepalive is sent only natted UDP
    contacs.
 
    Note: the internal keepalive of usrloc module conflicts in some way
    with the keepalive done by nathelper module. It is recommended to
    enable only one.
 
    Note: the internal keepalive is for the moment implemented only for
    contact records stored in memory.
 
    Note: it is recommeder to set 'timer_procs' parameter in order to have
    dedicated timer processes for usrloc module and off-load the keepalive
    sending process from the core timers.
 
    Default value is “0 (keepalive disabled)”.
 
    Example 1.50. ka_mode parameter usage
 ...
 modparam("usrloc", "ka_mode", 1)
 ...
 
 3.51. ka_method (str)
 
    The SIP method type for keepalive requests.
 
    Default value is “OPTIONS”.
 
    Example 1.51. ka_method parameter usage
 ...
 modparam("usrloc", "ka_method", "NOTIFY")
 ...
 
 3.52. ka_from (str)
 
    The SIP URI to be set in the From header of the keepalive requests.
 
    Default value is “sip:server@kamailio.org”.
 
    Example 1.52. ka_from parameter usage
 ...
 modparam("usrloc", "ka_from", "sip:server@mydomain.com")
 ...
 
 3.53. ka_domain (str)
 
    The domain to be set in To header URI if the multi-domain is not
    enabled. If multi-domain is enabled, then the domain from the location
    record is used and this parameter is ignored.
 
    Default value is “kamailio.org”.
 
    Example 1.53. ka_domain parameter usage
 ...
 modparam("usrloc", "ka_domain", "mydomain.com")
 ...
 
7d1e27e9
 3.54. ka_filter (int)
 
    Set filters for keepalive processing.
 
    Its value is a set of flags:
      * 0 - if the value is zero, no filter is enabled for keepalives
      * 1 (bit 1 set) - keepalives sent only to records matching the
        server_id global parameter.
 
    Default value is “0” (no filter).
 
    Example 1.54. ka_filter parameter usage
 ...
 modparam("usrloc", "ka_filter", 1)
 ...
 
609685c9
 3.55. ka_timeout (int)
 
    The parameter sets the interval in seconds after which a contact is
    removed from location table if it does not reply to SIP keepalives
    (usually OPTIONS ping requests).
 
    The features is available only for contacts that are stored in memory
    (not working for db only mode of the usrloc module).
 
    Keepalives are sent stateless, not using TM module. The value of this
    parameter has to be few times higher than timer interval.
 
    Default value is “0” (feature disabled).
 
    Example 1.55. Set ka_timeout parameter
 ...
 modparam("usrloc", "ka_timeout", 120)
 ...
 
 3.56. ka_loglevel (int)
91c1b9a0
 
    The level to print the log message when the keepalive response is
b505a4df
    received. It should be a value between -5 (L_ALERT) and 3 (L_DBG).
91c1b9a0
 
b505a4df
    Default value is “255” (disabled).
91c1b9a0
 
609685c9
    Example 1.56. ka_loglevel parameter usage
91c1b9a0
 ...
 modparam("usrloc", "ka_loglevel", 1)
 ...
 
609685c9
 3.57. ka_logmsg (str)
91c1b9a0
 
    The formatted log specification to be added to the message printed when
    the keepalive is received and roundtrip time is computed. The log
    message starts with "keepalive roundtrip: %u.%06u sec - ruid [%.*s]",
    then concatenates the value of this parameter and the end of line.
 
    The value of this parameter can contain script variables that are
    evaluated with the SIP response.
 
b505a4df
    Default value is “ to-uri: [$tu] remote-addr: [$sas]”.
91c1b9a0
 
609685c9
    Example 1.57. ka_logmsg parameter usage
91c1b9a0
 ...
b505a4df
 modparam("usrloc", "ka_logmsg", " to-uri: [$tu] remote-addr: [$sas]")
91c1b9a0
 ...
 
1a8f9729
 4. RPC Commands
875c5e71
 
1a8f9729
    4.1. ul.dump
    4.2. ul.lookup table AOR
    4.3. ul.rm table AOR
    4.4. ul.rm_contact table AOR contact
    4.5. ul.flush
    4.6. ul.add
    4.7. ul.db_users
    4.8. ul.db_contacts
    4.9. ul.db_expired_contacts
875c5e71
 
1a8f9729
 4.1.  ul.dump
875c5e71
 
    Dumps the content of the location table
 
    Parameters:
      * None.
 
1a8f9729
 4.2.  ul.lookup table AOR
22076189
 
    Looks up the contents of an AOR entry in the location table
 
    Parameters:
      * table name - table where the AOR resides (Ex: location).
      * AOR - user AOR in username[@domain] format (domain must be supplied
        only if use_domain option is on).
 
1a8f9729
 4.3.  ul.rm table AOR
c57575c5
 
    Deletes an entire AOR record (including its contacts).
 
    Parameters:
      * table name - table where the AOR resides (Ex: location).
      * AOR - user AOR in username[@domain] format (domain must be supplied
        only if use_domain option is on).
 
1a8f9729
 4.4.  ul.rm_contact table AOR contact
c57575c5
 
    Deletes a contact from an AOR record.
 
    Parameters:
      * table name - table where the AOR is removed from (Ex: location).
      * AOR - user AOR in username[@domain] format (domain must be supplied
        only if use_domain option is on).
      * contact - exact contact to be removed
 
1a8f9729
 4.5.  ul.flush
c57575c5
 
    Triggers the flush of USRLOC memory cache into DB.
 
1a8f9729
 4.6.  ul.add
c57575c5
 
    Adds a new contact for an user AOR.
 
    Parameters:
      * table name - table where the contact will be added (Ex: location).
      * AOR - user AOR in username[@domain] format (domain must be supplied
        only if use_domain option is on).
      * contact - contact string to be added
      * expires - expires value of the contact
      * Q - Q value of the contact
b38455c9
      * path value with the Path vector (use '0' or '.' if it should not be
        set)
c57575c5
      * flags - internal USRLOC flags of the contact
      * cflags - per branch flags of the contact
      * methods - mask with supported requests of the contact
b38455c9
      * received (optional) value with the received-from address (source
        address) (use '0' or '.' if it should not be set). Format:
        sip:srcip:srcport;transport=abc
      * socket (optional) value with the local socket address (use '0' or
        '.' if it should not be set). Format: proto:localip:localport
 
    Note: the position of parameters is relevant, in the case of optional
    parameters, use '0' or '.' for parameters that should not be set which
    are positioned before any parameter that has to be set.
c57575c5
 
1a8f9729
 4.7.  ul.db_users
d0d29807
 
7cb062ce
    Tell number of different users (AoRs) in a location table that have
    unexpired contacts.
d0d29807
 
    Parameters:
      * table name - location table where the users are looked for, for
        example, location.
 
1a8f9729
 4.8.  ul.db_contacts
d0d29807
 
7cb062ce
    Tell number of unexpired contacts in a location table.
 
    Parameters:
      * table name - location table where the contacts are looked for, for
        example, location.
 
1a8f9729
 4.9.  ul.db_expired_contacts
7cb062ce
 
    Tell number of expired contacts in a location table.
d0d29807
 
    Parameters:
      * table name - location table where the contacts are looked for, for
        example, location.
 
1a8f9729
 5. Statistics
83ce345f
 
1a8f9729
    5.1. users
    5.2. contacts
    5.3. expires
    5.4. registered_users
762c216d
 
521b6643
    Exported statistics are listed in the next sections.
762c216d
 
1a8f9729
 5.1. users
762c216d
 
83ce345f
    Number of AOR existing in the USRLOC memory cache for that domain - can
8868e624
    not be reset; this statistic will be register for each used domain (Ex:
    location).
762c216d
 
1a8f9729
 5.2. contacts
762c216d
 
83ce345f
    Number of contacts existing in the USRLOC memory cache for that domain
8868e624
    - can not be reset; this statistic will be register for each used
83ce345f
    domain (Ex: location).
762c216d
 
1a8f9729
 5.3. expires
762c216d
 
8868e624
    Total number of expired contacts for that domain - can be reset; this
    statistic will be register for each used domain (Ex: location).
521b6643
 
1a8f9729
 5.4. registered_users
521b6643
 
83ce345f
    Total number of AOR existing in the USRLOC memory cache for all domains
8868e624
    - can not be reset.
762c216d
 
9fc784c6
 Chapter 2. Developer Guide
31ccf6a2
 
83ce345f
    Table of Contents
31ccf6a2
 
83ce345f
    1. Available Functions
 
         1.1. ul_register_domain(name)
         1.2. ul_insert_urecord(domain, aor, rec)
         1.3. ul_delete_urecord(domain, aor)
6c385398
         1.4. ul_delete_urecord_by_ruid(domain, ruid)
         1.5. ul_get_urecord(domain, aor)
         1.6. ul_lock_udomain(domain)
         1.7. ul_unlock_udomain(domain)
         1.8. ul_release_urecord(record)
         1.9. ul_insert_ucontact(record, contact, expires, q, callid, cseq,
83ce345f
                 flags, cont, ua, sock)
 
6c385398
         1.10. ul_delete_ucontact (record, contact)
         1.11. ul_get_ucontact(record, contact)
         1.12. ul_get_all_ucontacts (buf, len, flags)
         1.13. ul_update_ucontact(contact, expires, q, callid, cseq, set,
83ce345f
                 res, ua, sock)
 
6c385398
         1.14. ul_bind_ursloc( api )
         1.15. ul_register_ulcb(type ,callback, param)
         1.16. ul_get_num_users()
83ce345f
 
 1. Available Functions
 
    1.1. ul_register_domain(name)
    1.2. ul_insert_urecord(domain, aor, rec)
    1.3. ul_delete_urecord(domain, aor)
6c385398
    1.4. ul_delete_urecord_by_ruid(domain, ruid)
    1.5. ul_get_urecord(domain, aor)
    1.6. ul_lock_udomain(domain)
    1.7. ul_unlock_udomain(domain)
    1.8. ul_release_urecord(record)
    1.9. ul_insert_ucontact(record, contact, expires, q, callid, cseq,
83ce345f
           flags, cont, ua, sock)
 
6c385398
    1.10. ul_delete_ucontact (record, contact)
    1.11. ul_get_ucontact(record, contact)
    1.12. ul_get_all_ucontacts (buf, len, flags)
    1.13. ul_update_ucontact(contact, expires, q, callid, cseq, set, res,
83ce345f
           ua, sock)
 
6c385398
    1.14. ul_bind_ursloc( api )
    1.15. ul_register_ulcb(type ,callback, param)
    1.16. ul_get_num_users()
83ce345f
 
9cb2a163
 1.1.  ul_register_domain(name)
83ce345f
 
    The function registers a new domain. Domain is just another name for
    table used in registrar. The function is called from fixups in
    registrar. It gets name of the domain as a parameter and returns
    pointer to a new domain structure. The fixup than 'fixes' the parameter
    in registrar so that it will pass the pointer instead of the name every
    time save() or lookup() is called. Some usrloc functions get the
    pointer as parameter when called. For more details see implementation
    of save function in registrar.
31ccf6a2
 
    Meaning of the parameters is as follows:
83ce345f
      * const char* name - Name of the domain (also called table) to be
        registered.
31ccf6a2
 
9cb2a163
 1.2.  ul_insert_urecord(domain, aor, rec)
31ccf6a2
 
83ce345f
    The function creates a new record structure and inserts it in the
    specified domain. The record is structure that contains all the
    contacts for belonging to the specified username.
31ccf6a2
 
    Meaning of the parameters is as follows:
      * udomain_t* domain - Pointer to domain returned by
        ul_register_udomain.
 
83ce345f
      * str* aor - Address of Record (aka username) of the new record (at
        this time the record will contain no contacts yet).
31ccf6a2
 
      * urecord_t** rec - The newly created record structure.
 
9cb2a163
 1.3.  ul_delete_urecord(domain, aor)
31ccf6a2
 
83ce345f
    The function deletes all the contacts bound with the given Address Of
    Record.
31ccf6a2
 
    Meaning of the parameters is as follows:
      * udomain_t* domain - Pointer to domain returned by
        ul_register_udomain.
 
83ce345f
      * str* aor - Address of record (aka username) of the record, that
        should be deleted.
31ccf6a2
 
9cb2a163
 1.4.  ul_delete_urecord_by_ruid(domain, ruid)
6c385398
 
    The function deletes from given domain a contact with given ruid.
 
    Meaning of the parameters is as follows:
      * udomain_t* domain - Pointer to domain returned by
        ul_register_udomain.
 
      * str* ruid - ruid of contact that should be deleted.
 
9cb2a163
 1.5.  ul_get_urecord(domain, aor)
31ccf6a2
 
83ce345f
    The function returns pointer to record with given Address of Record.
31ccf6a2
 
    Meaning of the parameters is as follows:
      * udomain_t* domain - Pointer to domain returned by
        ul_register_udomain.
 
      * str* aor - Address of Record of request record.
 
9cb2a163
 1.6.  ul_lock_udomain(domain)
31ccf6a2
 
989206bd
    The function lock the specified domain, it means, that no other
83ce345f
    processes will be able to access during the time. This prevents race
    conditions. Scope of the lock is the specified domain, that means, that
    multiple domain can be accessed simultaneously, they don't block each
    other.
31ccf6a2
 
    Meaning of the parameters is as follows:
      * udomain_t* domain - Domain to be locked.
 
9cb2a163
 1.7.  ul_unlock_udomain(domain)
31ccf6a2
 
83ce345f
    Unlock the specified domain previously locked by ul_lock_udomain.
31ccf6a2
 
    Meaning of the parameters is as follows:
      * udomain_t* domain - Domain to be unlocked.
 
9cb2a163
 1.8.  ul_release_urecord(record)
31ccf6a2
 
83ce345f
    Do some sanity checks - if all contacts have been removed, delete the
    entire record structure.
31ccf6a2
 
    Meaning of the parameters is as follows:
      * urecord_t* record - Record to be released.
 
9cb2a163
 1.9.  ul_insert_ucontact(record, contact, expires, q, callid, cseq, flags,
83ce345f
 cont, ua, sock)
31ccf6a2
 
83ce345f
    The function inserts a new contact in the given record with specified
    parameters.
31ccf6a2
 
    Meaning of the parameters is as follows:
83ce345f
      * urecord_t* record - Record in which the contact should be inserted.
31ccf6a2
      * str* contact - Contact URI.
      * time_t expires - Expires of the contact in absolute value.
      * float q - q value of the contact.
83ce345f
      * str* callid - Call-ID of the REGISTER message that contained the
31ccf6a2
        contact.
83ce345f
      * int cseq - CSeq of the REGISTER message that contained the contact.
31ccf6a2
      * unsigned int flags - Flags to be set.
      * ucontact_t* cont - Pointer to newly created structure.
83ce345f
      * str* ua - User-Agent of the REGISTER message that contained the
        contact.
      * struct socket_info *sock - socket on which the REGISTER message was
        received on.
31ccf6a2
 
9cb2a163
 1.10.  ul_delete_ucontact (record, contact)
31ccf6a2
 
    The function deletes given contact from record.
 
    Meaning of the parameters is as follows:
989206bd
      * urecord_t* record - Record from which the contact should be
        removed.
31ccf6a2
 
      * ucontact_t* contact - Contact to be deleted.
 
9cb2a163
 1.11.  ul_get_ucontact(record, contact)
31ccf6a2
 
83ce345f
    The function tries to find contact with given Contact URI and returns
    pointer to structure representing the contact.
31ccf6a2
 
    Meaning of the parameters is as follows:
      * urecord_t* record - Record to be searched for the contact.
 
      * str_t* contact - URI of the request contact.
 
9cb2a163
 1.12.  ul_get_all_ucontacts (buf, len, flags)
31ccf6a2
 
83ce345f
    The function retrieves all contacts of all registered users and returns
    them in the caller-supplied buffer. If the buffer is too small, the
    function returns positive value indicating how much additional space
    would be necessary to accommodate all of them. Please note that the
9cb2a163
    positive return value should be used only as a “hint”, as there is no
83ce345f
    guarantee that during the time between two subsequent calls number of
    registered contacts will remain the same.
31ccf6a2
 
83ce345f
    If flag parameter is set to non-zero value then only contacts that have
    the specified flags set will be returned. It is, for example, possible
    to list only contacts that are behind NAT.
31ccf6a2
 
    Meaning of the parameters is as follows:
      * void* buf - Buffer for returning contacts.
 
      * int len - Length of the buffer.
 
      * unsigned int flags - Flags that must be set.
 
9cb2a163
 1.13.  ul_update_ucontact(contact, expires, q, callid, cseq, set, res, ua,
83ce345f
 sock)
31ccf6a2
 
    The function updates contact with new values.
 
    Meaning of the parameters is as follows:
      * ucontact_t* contact - Contact URI.
      * time_t expires - Expires of the contact in absolute value.
      * float q - q value of the contact.
83ce345f
      * str* callid - Call-ID of the REGISTER message that contained the
31ccf6a2
        contact.
83ce345f
      * int cseq - CSeq of the REGISTER message that contained the contact.
31ccf6a2
      * unsigned int set - OR value of flags to be set.
      * unsigned int res - OR value of flags to be reset.
83ce345f
      * str* ua - User-Agent of the REGISTER message that contained the
        contact.
      * struct socket_info *sock - socket on which the REGISTER message was
        received on.
31ccf6a2
 
9cb2a163
 1.14.  ul_bind_ursloc( api )
31ccf6a2
 
83ce345f
    The function imports all functions that are exported by the USRLOC
    module. Overs for other modules which want to user the internal USRLOC
    API an easy way to load and access the functions.
31ccf6a2
 
    Meaning of the parameters is as follows:
      * usrloc_api_t* api - USRLOC API
 
9cb2a163
 1.15.  ul_register_ulcb(type ,callback, param)
31ccf6a2
 
83ce345f
    The function register with USRLOC a callback function to be called when
    some event occures inside USRLOC.
31ccf6a2
 
    Meaning of the parameters is as follows:
83ce345f
      * int types - type of event for which the callback should be called
        (see usrloc/ul_callback.h).
31ccf6a2
      * ul_cb f - callback function; see usrloc/ul_callback.h for
        prototype.
83ce345f
      * void *param - some parameter to be passed to the callback each time
        when it is called.
521b6643
 
9cb2a163
 1.16.  ul_get_num_users()
521b6643
 
83ce345f
    The function loops through all domains summing up the number of users.