|
|
@@ -834,6 +834,7 @@ modparam("usrloc", "db_ops_ruid", 0)
|
|
|
|
|
|
If set to 1, Kamailio will remove location records made via
|
|
|
TCP/TLS/WS/WSS transports when it looses corresponding tcp connections.
|
|
|
+ Does not currently work in DB-Only scheme.
|
|
|
|
|
|
Default value is "0".
|
|
|
|
|
|
@@ -909,7 +910,7 @@ modparam("usrloc", "db_insert_null", 1)
|
|
|
5.5. ul_add
|
|
|
5.6. ul_show_contact
|
|
|
|
|
|
-5.1. ul_rm
|
|
|
+5.1. ul_rm
|
|
|
|
|
|
Deletes an entire AOR record (including its contacts).
|
|
|
|
|
|
@@ -918,7 +919,7 @@ modparam("usrloc", "db_insert_null", 1)
|
|
|
* AOR - user AOR in username[@domain] format (domain must be supplied
|
|
|
only if use_domain option is on).
|
|
|
|
|
|
-5.2. ul_rm_contact
|
|
|
+5.2. ul_rm_contact
|
|
|
|
|
|
Deletes a contact from an AOR record.
|
|
|
|
|
|
@@ -928,7 +929,7 @@ modparam("usrloc", "db_insert_null", 1)
|
|
|
only if use_domain option is on).
|
|
|
* contact - exact contact to be removed
|
|
|
|
|
|
-5.3. ul_dump
|
|
|
+5.3. ul_dump
|
|
|
|
|
|
Dumps the entire content of the USRLOC in memory cache
|
|
|
|
|
|
@@ -937,11 +938,11 @@ modparam("usrloc", "db_insert_null", 1)
|
|
|
"brief", a brief dump will be done (only AOR and contacts, with no
|
|
|
other details)
|
|
|
|
|
|
-5.4. ul_flush
|
|
|
+5.4. ul_flush
|
|
|
|
|
|
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.
|
|
|
|
|
|
@@ -957,7 +958,7 @@ modparam("usrloc", "db_insert_null", 1)
|
|
|
* cflags - per branch flags 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.
|
|
|
|
|
|
@@ -978,14 +979,14 @@ modparam("usrloc", "db_insert_null", 1)
|
|
|
6.8. ul.db_contacts
|
|
|
6.9. ul.db_expired_contacts
|
|
|
|
|
|
-6.1. ul.dump
|
|
|
+6.1. ul.dump
|
|
|
|
|
|
Dumps the content of the location table
|
|
|
|
|
|
Parameters:
|
|
|
* 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
|
|
|
|
|
|
@@ -994,7 +995,7 @@ modparam("usrloc", "db_insert_null", 1)
|
|
|
* AOR - user AOR in username[@domain] format (domain must be supplied
|
|
|
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).
|
|
|
|
|
|
@@ -1003,7 +1004,7 @@ modparam("usrloc", "db_insert_null", 1)
|
|
|
* AOR - user AOR in username[@domain] format (domain must be supplied
|
|
|
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.
|
|
|
|
|
|
@@ -1013,11 +1014,11 @@ modparam("usrloc", "db_insert_null", 1)
|
|
|
only if use_domain option is on).
|
|
|
* contact - exact contact to be removed
|
|
|
|
|
|
-6.5. ul.flush
|
|
|
+6.5. ul.flush
|
|
|
|
|
|
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.
|
|
|
|
|
|
@@ -1033,7 +1034,7 @@ modparam("usrloc", "db_insert_null", 1)
|
|
|
* cflags - per branch flags 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
|
|
|
unexpired contacts.
|
|
|
@@ -1042,7 +1043,7 @@ modparam("usrloc", "db_insert_null", 1)
|
|
|
* table name - location table where the users are looked for, for
|
|
|
example, location.
|
|
|
|
|
|
-6.8. ul.db_contacts
|
|
|
+6.8. ul.db_contacts
|
|
|
|
|
|
Tell number of unexpired contacts in a location table.
|
|
|
|
|
|
@@ -1050,7 +1051,7 @@ modparam("usrloc", "db_insert_null", 1)
|
|
|
* table name - location table where the contacts are looked for, for
|
|
|
example, location.
|
|
|
|
|
|
-6.9. ul.db_expired_contacts
|
|
|
+6.9. ul.db_expired_contacts
|
|
|
|
|
|
Tell number of expired contacts in a location table.
|
|
|
|
|
|
@@ -1139,7 +1140,7 @@ Chapter 2. Developer Guide
|
|
|
1.15. ul_register_ulcb(type ,callback, param)
|
|
|
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
|
|
|
table used in registrar. The function is called from fixups in
|
|
|
@@ -1154,7 +1155,7 @@ Chapter 2. Developer Guide
|
|
|
* const char* name - Name of the domain (also called table) to be
|
|
|
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
|
|
|
specified domain. The record is structure that contains all the
|
|
|
@@ -1169,7 +1170,7 @@ Chapter 2. Developer Guide
|
|
|
|
|
|
* 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
|
|
|
Record.
|
|
|
@@ -1181,7 +1182,7 @@ Chapter 2. Developer Guide
|
|
|
* str* aor - Address of record (aka username) of the record, that
|
|
|
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.
|
|
|
|
|
|
@@ -1191,7 +1192,7 @@ Chapter 2. Developer Guide
|
|
|
|
|
|
* 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.
|
|
|
|
|
|
@@ -1201,7 +1202,7 @@ Chapter 2. Developer Guide
|
|
|
|
|
|
* 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
|
|
|
processes will be able to access during the time. This prevents race
|
|
|
@@ -1212,14 +1213,14 @@ Chapter 2. Developer Guide
|
|
|
Meaning of the parameters is as follows:
|
|
|
* 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.
|
|
|
|
|
|
Meaning of the parameters is as follows:
|
|
|
* 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
|
|
|
entire record structure.
|
|
|
@@ -1227,7 +1228,7 @@ Chapter 2. Developer Guide
|
|
|
Meaning of the parameters is as follows:
|
|
|
* 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)
|
|
|
|
|
|
The function inserts a new contact in the given record with specified
|
|
|
@@ -1248,7 +1249,7 @@ cont, ua, sock)
|
|
|
* struct socket_info *sock - socket on which the REGISTER message was
|
|
|
received on.
|
|
|
|
|
|
-1.10. ul_delete_ucontact (record, contact)
|
|
|
+1.10. ul_delete_ucontact (record, contact)
|
|
|
|
|
|
The function deletes given contact from record.
|
|
|
|
|
|
@@ -1258,7 +1259,7 @@ cont, ua, sock)
|
|
|
|
|
|
* 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
|
|
|
pointer to structure representing the contact.
|
|
|
@@ -1268,7 +1269,7 @@ cont, ua, sock)
|
|
|
|
|
|
* 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
|
|
|
them in the caller-supplied buffer. If the buffer is too small, the
|
|
|
@@ -1289,7 +1290,7 @@ cont, ua, sock)
|
|
|
|
|
|
* 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)
|
|
|
|
|
|
The function updates contact with new values.
|
|
|
@@ -1308,7 +1309,7 @@ sock)
|
|
|
* struct socket_info *sock - socket on which the REGISTER message was
|
|
|
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
|
|
|
module. Overs for other modules which want to user the internal USRLOC
|
|
|
@@ -1317,7 +1318,7 @@ sock)
|
|
|
Meaning of the parameters is as follows:
|
|
|
* 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
|
|
|
some event occures inside USRLOC.
|
|
|
@@ -1330,6 +1331,6 @@ sock)
|
|
|
* void *param - some parameter to be passed to the callback each time
|
|
|
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.
|
Juha Heinanen