Table of Contents
nat_bflag (integer)
user_column (string)
domain_column (string)
contact_column (string)
expires_column (string)
q_column (string)
callid_column (string)
cseq_column (string)
methods_column (string)
flags_column (string)
cflags_column (string)
user_agent_column (string)
received_column (string)
socket_column (string)
path_column (string)
ruid_column (string)
instance_column (string)
use_domain (integer)
desc_time_order (integer)
timer_interval (integer)
db_url (string)
db_mode (integer)
matching_mode (integer)
cseq_delay (integer)
fetch_rows (integer)
hash_size (integer)
preload (string)
db_update_as_insert (string)
db_check_update (string)
timer_procs (string)
xavp_contact (string)
db_ops_ruid (int)
ul_register_domain(name)
ul_insert_urecord(domain, aor, rec)
ul_delete_urecord(domain, aor)
ul_get_urecord(domain, aor)
ul_lock_udomain(domain)
ul_unlock_udomain(domain)
ul_release_urecord(record)
ul_insert_ucontact(record, contact,
expires, q, callid, cseq, flags, cont, ua, sock)
ul_delete_ucontact
(record, contact)
ul_get_ucontact(record, contact)
ul_get_all_ucontacts
(buf, len, flags)
ul_update_ucontact(contact, expires, q,
callid, cseq, set, res, ua, sock)
ul_bind_ursloc( api )
ul_register_ulcb(type ,callback, param)
ul_get_num_users()
List of Examples
nat_bflag parameteruser_column parameteruser_column parametercontact_column parameterexpires_column parameterq_column parametercallid_column parametercseq_column parametermethods_column parameterflags_column parametercflags_column parameteruser_agent_column parameterreceived_column parametersocket_column parameterpath_column parameterruid_column parameterinstance_column parameteruse_domain parameterdesc_time_order parametertimer_interval parameterdb_url parameterdb_mode parametermatching_mode parametercseq_delay parameterfetch_rows parameterhash_size parameterpreload parameterdb_update_as_insert parameterdb_check_update parametertimer_procs parameterxavp_contact parameterdb_ops_ruid parameterTable of Contents
nat_bflag (integer)
user_column (string)
domain_column (string)
contact_column (string)
expires_column (string)
q_column (string)
callid_column (string)
cseq_column (string)
methods_column (string)
flags_column (string)
cflags_column (string)
user_agent_column (string)
received_column (string)
socket_column (string)
path_column (string)
ruid_column (string)
instance_column (string)
use_domain (integer)
desc_time_order (integer)
timer_interval (integer)
db_url (string)
db_mode (integer)
matching_mode (integer)
cseq_delay (integer)
fetch_rows (integer)
hash_size (integer)
preload (string)
db_update_as_insert (string)
db_check_update (string)
timer_procs (string)
xavp_contact (string)
db_ops_ruid (int)
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.
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).
The SIP RFC 3261 publishes a matching algorithm based only on the 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). But as argumented above, this is not enough in NAT traversal context, so the Kamailio implementation of contact matching offers more algorithms:
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 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 than the previous one - so be careful how you deal with REGISTER retransmissions in this case.
To find out how to control/select the contact maching algorithm, please see the
module parameter matching_mode - Section 3.23, “matching_mode (integer)”.
The following modules must be loaded before this module:
Optionally a database module.
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.
Default value is “not set”.
Name of database column containing usernames.
Default value is “username”.
Name of database column containing domains.
Default value is “domain”.
Name of database column containing contacts.
Default value is “contact”.
Name of database column containing expires value.
Default value is “expires”.
Name of database column containing q values.
Default value is “q”.
Name of database column containing Call-ID values.
Default value is “callid”.
Name of database column containing Cseq.
Default value is “cseq”.
Name of database column containing supported methods.
Default value is “methods”.
Name of database column to save the internal flags of the record.
Default value is “flags”.
Name of database column to save the branch/contact flags of the record.
Default value is “cflags”.
Name of database column containing user-agent values.
Default value is “user_agent”.
Example 1.12. Set user_agent_column parameter
...
modparam("usrloc", "user_agent_column", "user_agent")
...
Name of database column containing the source IP, port, and protocol from the REGISTER message.
Default value is “received”.
Example 1.13. Set received_column parameter
...
modparam("usrloc", "received_column", "received")
...
Name of database column containing the received socket information (IP:port) for the REGISTER message.
Default value is “socket”.
Name of database column containing the Path header.
Default value is “path”.
Name of database column containing the Kamailio record unique id.
Default value is “ruid”.
Name of database column containing the SIP instance ID (GRUU - RFC5627). This is a unique device identifier - UUID.
Default value is “instance”.
Example 1.17. Set instance_column parameter
...
modparam("usrloc", "instance_column", "myinstance")
...
If the domain part of the user should be also saved and used for identifing the user (along with the username part). Useful in multi domain scenarios. Non 0 value means true.
Default value is “0 (false)”.
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.
Default value is “0 (false)”.
Number of seconds between two timer runs. The module uses a timer to delete expired contacts, synchronize with database and other tasks, that need to be run periodically.
Default value is 60.
URL of the database that should be used.
Default value is “mysql://kamailio:kamailiorw@localhost/kamailio”.
Example 1.21. Set db_url parameter
...
modparam("usrloc", "db_url", "dbdriver://username:password@dbhost/dbname")
...
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:
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 all nated contact are loaded from the DB; The lack of memory caching also disable the statistics exports.
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.
Default value is 0.
What contact matching algorithm to be used. Refer to section Section 1.1, “Contact matching” for the description of the algorithms.
The parameter may take the following values:
0 - CONTACT ONLY based matching algorithm.
1 - CONTACT and CALLID based matching algorithm.
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.
Default value is 0 (CONTACT_ONLY).
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.
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.
A value of 0 disable the retransmission detection.
Default value is “20 seconds”.
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.
Default value is “2000”.
The number of entries of the hash table used by usrloc to store the location records is 2^hash_size. For hash_size=4, the number of entries of the hash table is 16.
Default value is “9”.
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.
Default value is “NULL”.
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.
Default value is “0”.
Example 1.28. Set db_update_as_insert parameter
...
modparam("usrloc", "db_update_as_insert", 1)
...
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().
Default value is “0” (no DB INSERT).
Number of timer processes to be started by module. Timer processes take care of checking expired records and syncronization with database. If set to 0, no dedicated timer is started, the one from core will be used.
Default value is “0”.
The name of XAVP storring the attributes per contact. They are saved in location record and restored at lookup.
Default value is “NULL”.
Deletes an entire AOR record (including its contacts).
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).
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
Dumps the entire content of the USRLOC in memory cache
Parameters:
brief - (optional, may not be present); if equals to string “brief”, a brief dump will be done (only AOR and contacts, with no other details)
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
unused - unused attribute (kept for backword compatibility)
flags - internal USRLOC flags of the contact
cflags - per branch flags of the contact
methods - mask with supported requests of the contact
Exported statistics are listed in the next sections.
Number of AOR existing in the USRLOC memory cache for that domain - can not be resetted; this statistic will be register for each used domain (Ex: location).
Number of contacts existing in the USRLOC memory cache for that domain - can not be resetted; this statistic will be register for each used domain (Ex: location).
Total number of expired contacts for that domain - can be resetted; this statistic will be register for each used domain (Ex: location).
Table of Contents
ul_register_domain(name)
ul_insert_urecord(domain, aor, rec)
ul_delete_urecord(domain, aor)
ul_get_urecord(domain, aor)
ul_lock_udomain(domain)
ul_unlock_udomain(domain)
ul_release_urecord(record)
ul_insert_ucontact(record, contact,
expires, q, callid, cseq, flags, cont, ua, sock)
ul_delete_ucontact
(record, contact)
ul_get_ucontact(record, contact)
ul_get_all_ucontacts
(buf, len, flags)
ul_update_ucontact(contact, expires, q,
callid, cseq, set, res, ua, sock)
ul_bind_ursloc( api )
ul_register_ulcb(type ,callback, param)
ul_get_num_users()
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.
Meaning of the parameters is as follows:
const char* name - Name of the domain (also called table) to be registered.
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.
Meaning of the parameters is as follows:
udomain_t* domain - Pointer to domain returned by ul_register_udomain.
str* aor - Address of Record (aka username) of the new record (at this time the record will contain no contacts yet).
urecord_t** rec - The newly created record structure.
The function deletes all the contacts bound with the given Address Of Record.
Meaning of the parameters is as follows:
udomain_t* domain - Pointer to domain returned by ul_register_udomain.
str* aor - Address of record (aka username) of the record, that should be deleted.
The function returns pointer to record with given Address of Record.
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.
The function lock the specified domain, it means, that no other 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.
Meaning of the parameters is as follows:
udomain_t* domain - Domain to be locked.
Unlock the specified domain previously locked by ul_lock_udomain.
Meaning of the parameters is as follows:
udomain_t* domain - Domain to be unlocked.
Do some sanity checks - if all contacts have been removed, delete the entire record structure.
Meaning of the parameters is as follows:
urecord_t* record - Record to be released.
The function inserts a new contact in the given record with specified parameters.
Meaning of the parameters is as follows:
urecord_t* record - Record in which the contact should be inserted.
str* contact - Contact URI.
time_t expires - Expires of the contact in absolute value.
float q - q value of the contact.
str* callid - Call-ID of the REGISTER message that contained the contact.
int cseq - CSeq of the REGISTER message that contained the contact.
unsigned int flags - Flags to be set.
ucontact_t* cont - Pointer to newly created structure.
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.
The function deletes given contact from record.
Meaning of the parameters is as follows:
urecord_t* record - Record from which the contact should be removed.
ucontact_t* contact - Contact to be deleted.
The function tries to find contact with given Contact URI and returns pointer to structure representing the contact.
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.
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 positive return value should be used only as a “hint”, as there is no guarantee that during the time between two subsequent calls number of registered contacts will remain the same.
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.
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.
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.
str* callid - Call-ID of the REGISTER message that contained the contact.
int cseq - CSeq of the REGISTER message that contained the contact.
unsigned int set - OR value of flags to be set.
unsigned int res - OR value of flags to be reset.
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.
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.
Meaning of the parameters is as follows:
usrloc_api_t* api - USRLOC API
The function register with USRLOC a callback function to be called when some event occures inside USRLOC.
Meaning of the parameters is as follows:
int types - type of event for which the callback should be called (see usrloc/ul_callback.h).
ul_cb f - callback function; see usrloc/ul_callback.h for prototype.
void *param - some parameter to be passed to the callback each time when it is called.