$Revision: 1798 $
$Date: 2007-03-10 17:27:39 +0200 (Sat, 10 Mar 2007) $
User's Guide
Overview
User location module. The module keeps a user location table and
provides access to the table to other modules. The module exports no
functions that could be used directly from scripts.
Dependencies
&ser; Modules
The following modules must be loaded before this module:
Optionally a database module.
External Libraries or Applications
The following libraries or applications must be installed before
running &ser; with this module loaded:
None.
Exported Parameters
<varname>nat_bflag</varname> (integer)
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
.
Set <varname>nat_bflag</varname> parameter
...
modparam("usrloc", "nat_bflag", 3)
...
<varname>user_column</varname> (string)
Name of column containing usernames.
Default value is username
.
Set <varname>user_column</varname> parameter
...
modparam("usrloc", "user_column", "username")
...
<varname>domain_column</varname> (string)
Name of column containing domains.
Default value is domain
.
Set <varname>user_column</varname> parameter
...
modparam("usrloc", "domain_column", "domain")
...
<varname>contact_column</varname> (string)
Name of column containing contacts.
Default value is contact
.
Set <varname>contact_column</varname> parameter
...
modparam("usrloc", "contact_column", "contact")
...
<varname>expires_column</varname> (string)
Name of column containing expires value.
Default value is expires
.
Set <varname>expires_column</varname> parameter
...
modparam("usrloc", "expires_column", "expires")
...
<varname>q_column</varname> (string)
Name of column containing q values.
Default value is q
.
Set <varname>q_column</varname> parameter
...
modparam("usrloc", "q_column", "q")
...
<varname>callid_column</varname> (string)
Name of column containing callid values.
Default value is callid
.
Set <varname>callid_column</varname> parameter
...
modparam("usrloc", "callid_column", "callid")
...
<varname>cseq_column</varname> (string)
Name of column containing cseq numbers.
Default value is cseq
.
Set <varname>cseq_column</varname> parameter
...
modparam("usrloc", "cseq_column", "cseq")
...
<varname>methods_column</varname> (string)
Name of column containing supported methods.
Default value is methods
.
Set <varname>methods_column</varname> parameter
...
modparam("usrloc", "methods_column", "methods")
...
<varname>flags_column</varname> (string)
Name of column to save the internal flags of the record.
Default value is flags
.
Set <varname>flags_column</varname> parameter
...
modparam("usrloc", "flags_column", "flags")
...
<varname>cflags_column</varname> (string)
Name of column to save the branch/contact flags of the record.
Default value is cflags
.
Set <varname>cflags_column</varname> parameter
...
modparam("usrloc", "cflags_column", "cflags")
...
<varname>user_agent_column</varname> (string)
Name of column containing user-agent values.
Default value is user_agent
.
Set <varname>user_agent_column</varname> parameter
...
modparam("usrloc", "user_agent_column", "user_agent")
...
<varname>received_column</varname> (string)
Name of column containing the source IP, port, and protocol from the REGISTER
message.
Default value is received
.
Set <varname>received_column</varname> parameter
...
modparam("usrloc", "received_column", "received")
...
<varname>socket_column</varname> (string)
Name of column containing the received socket information (IP:port)
for the REGISTER message.
Default value is socket
.
Set <varname>socket_column</varname> parameter
...
modparam("usrloc", "socket_column", "socket")
...
<varname>path_column</varname> (string)
Name of column containing the Path header.
Default value is path
.
Set <varname>path_column</varname> parameter
...
modparam("usrloc", "path_column", "path")
...
<varname>use_domain</varname> (integer)
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)
.
Set <varname>use_domain</varname> parameter
...
modparam("usrloc", "use_domain", 1)
...
<varname>desc_time_order</varname> (integer)
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)
.
Set <varname>desc_time_order</varname> parameter
...
modparam("usrloc", "desc_time_order", 1)
...
<varname>timer_interval</varname> (integer)
Number of seconds between two timer runs. The module uses timer to
delete expired contacts, synchronize with database and other tasks,
that need to be run periodically.
Default value is 60.
Set <varname>timer_interval</varname> parameter
...
modparam("usrloc", "timer_interval", 120)
...
<varname>db_url</varname> (string)
&url; of the database that should be used.
Default value is
mysql://openser:openserrw@localhost/openser
.
Set <varname>db_url</varname> parameter
...
modparam("usrloc", "db_url", "mysql://username:password@localhost/openser")
...
<varname>db_mode</varname> (integer)
The usrloc module can utilize database for persistent contact storage.
If you use database, your contacts will survive machine restarts or
SW crashes. The disadvantage is that accessing 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 location watcher registration (in will
not work with PA module) and 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.
Set <varname>db_mode</varname> parameter
...
modparam("usrloc", "db_mode", 2)
...
<varname>matching_mode</varname> (integer)
What contact matching algorithm to be used. Refer to section
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.
Default value is 0 (CONTACT_ONLY).
Set <varname>matching_mode</varname> parameter
...
modparam("usrloc", "matching_mode", 1)
...
<varname>cseq_delay</varname> (integer)
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
.
Set <varname>cseq_delay</varname> parameter
...
modparam("usrloc", "cseq_delay", 5)
...
<varname>fetch_rows</varname> (integer)
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
.
Set <varname>fetch_rows</varname> parameter
...
modparam("usrloc", "fetch_rows", 3000)
...
<varname>hash_size</varname> (integer)
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
.
Set <varname>hash_size</varname> parameter
...
modparam("usrloc", "hash_size", 10)
...
Exported Functions
There are no exported functions that could be used in scripts.
Exported MI Functions
<function moreinfo="none">ul_rm</function>
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).
<function moreinfo="none">ul_rm_contact</function>
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
<function moreinfo="none">ul_dump</function>
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)
<function moreinfo="none">ul_flush</function>
Triggers the flush of USRLOC memory cache into DB.
<function moreinfo="none">ul_add</function>
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
<function moreinfo="none">ul_show_contact</function>
Dumps the contacts of an user AOR.
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).
Exported statistics
Exported statistics are listed in the next sections.
users
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).
contacts
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).
expires
Total number of expired contacts for that domain - can be resetted;
this statistic will be register for each used domain
(Ex: location).
registered_users
Total number of AOR existing in the USRLOC memory cache for all
domains - can not be resetted.