$Revision: 1499 $
$Date: 2007-01-12 14:05:57 +0200 (Fri, 12 Jan 2007) $
User's Guide
Overview
This module offer the functionality of a presence user agent client,
sending Subscribe and Publish messages.
Now it can be used with the following modules: pua_mi and pua_usrloc.
The pua_mi offer the possiblity to publish any kind of information
or subscribing to a resource through fifo. The pua_usrloc module calls
a function exported by pua modules to publish elementary presence
information, such as basic status "open" or "closed", for clients that
do not implement client-to-server presence.
The module use cache to store presentity list and writes to database
on timer to be able to recover upon restart.
Dependencies
&ser; Modules
The following modules must be loaded before this module:
a database modules.
tm.
External Libraries or Applications
The following libraries or applications must be installed before running
&ser; with this module loaded:
libxml.
Exported Parameters
<varname>hash_size</varname> (int)
The size of the hash table used for storing Subscribe and
Publish information.
Default value is 4
.
Set <varname>hash_size</varname> parameter
...
modparam("pua", "hash_size", 9)
...
<varname>db_url</varname> (str)
Database url.
Default value is NULL
.
Set <varname>db_url</varname> parameter
...
modparam("pua", "db_url"
"mysql://openser:openserrw@192.168.2.132/openser")
...
<varname>db_table</varname> (str)
The name of the database table.
Default value is pua
.
Set <varname>db_table</varname> parameter
...
modparam("pua", "db_table", "pua")
...
<varname>min_expires</varname> (int)
The inferior expires limit for both Publish and Subscribe.
Default value is 0
.
Set <varname>min_expires</varname> parameter
...
modparam("pua", "min_expires", 0)
...
<varname>default_expires</varname> (int)
The default expires value used in case this information is not provisioned.
Default value is 3600
.
Set <varname>default_expires</varname> parameter
...
modparam("pua", "default_expires", 3600)
...
<varname>update_period</varname> (int)
The interval at which the information in database and hash table
should be updated. In the case of the hash table updating is
deleting expired messages.
Default value is 30
.
Set <varname>update_period</varname> parameter
...
modparam("pua", "update_period", 100)
...
Exported Functions
No function exported to be used in configuration script.
Installation
The module requires a new table in OpenSER database. Next SQL statement
shows the syntax to create it.
PUA tables
...
&sql;
...