$Revision: 1.5.2.1 $
$Date: 2005/06/22 23:12:09 $
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>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 domain parts.
Default value is 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>method_column</varname> (string)
Name of column containing supported methods.
Default value is method
.
Set <varname>method_column</varname> parameter
...
modparam("usrloc", "method_column", "method")
...
<varname>flags_column</varname> (string)
Name of column containing saved flags.
Default value is flags
.
<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>user_agent_column</varname> (string)
Name of column containing the user agent string.
Default value is user_agent
.
<varname>db_url</varname> (string)
&url; of the database that should be used.
Default value is mysql://ser:heslo@localhost/ser
.
Set <varname>db_url</varname> parameter
...
modparam("usrloc", "db_url", "mysql://username:password@localhost/ser")
...
<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>use_domain</varname> (integer)
Use also the domain part, in addition to username, when
searching for a record. This parameter must be enabled in
multi-domain mode.
Default value is 0 (disabled).
<varname>desc_time_order</varname> (integer)
Enable/disable sorting of contacts in descenting modification
time order. This ensures that most fresh contacts come first
when doing serial forking.
Default value is 0 (disabled).
<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 three 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.
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)
...
Exported Functions
There are no exported functions that could be used in scripts.