$Revision: 1.3.2.1 $
$Date: 2005/06/22 23:12:07 $
User's Guide
Overview
This module implements a presence server, i.e. entity that receives SUBSCRIBE messages
and sends NOTIFY when presence status of a user changes. Currently the presence server
can be connected to registrar and jabber module so &sip; users can see presence of jabber
users.
This module currently cannot work as a B2BUA, i.e. it cannot subscribe
to presence of users using &sip;. We are currently working on that feature.
Dependencies
&ser; Modules
The following modules must be loaded before this module:
No dependencies on other &ser; modules.
External Libraries or Applications
The following libraries or applications must be installed before running
&ser; with this module loaded:
None.
Exported Parameters
<varname>default_expires</varname> (integer)
Default expires value to be used when the client doesn't supply one (in seconds).
Default value is 3600
.
Set <varname>default_expires</varname> parameter
...
modparam("pa", "default_expires", 3600)
...
<varname>default_priority_percentage</varname> (integer)
Default priority value to be used when not included in a PUBLISH
message, expressed as a percentage.
Default value is 50.
<varname>timer_interval</varname> (integer)
This parameter controls the interval between expiration timer
runs, the value is in seconds.
Default value is 10.
<varname>use_db</varname> (integer)
This parameter enables/disables database support in pa module.
Default value is 0 (disabled).
<varname>use_place_table</varname> (integer)
This parameter controls if pa module should use "place"
database table. The table assigns IDs to rooms/locations and
contains additional information for each place.
Default value is 0 (disabled).
<varname>use_bsearch</varname> (integer)
Enable/disable using of binary search instead of linear
searching when looking up location.
Default value is 0 (disabled).
<varname>use_location_package</varname> (integer)
Enable/disable location package support in pa.
Default value is 0 (disabled).
<varname>db_url</varname> (string)
The URL of the database to be used when database support is
enabled in pa module.
Default value is "mysql://ser:heslo@localhost/ser".
<varname>pa_domain</varname> (string)
Hostname of XCAP server associated with presence agent.
Default value is "sip.handhelds.org".
<varname>presentity_table</varname> (string)
The name of the table in database which can store information
about presentities stored in the presence server. Presence
server can reload data from this table after restart.
Default value is "presentity".
<varname>presentity_contact_table</varname> (string)
Table containing additional information on presentities, such
as status, location, contact value, and so on.
Default value is "presentity_contact".
<varname>watcherinfo_table</varname> (string)
The name of the table in database where presence server stores
information about subscribers to the watcherinfo package
(watchers).
Default value is "watcherinfo".
<varname>place_table</varname> (string)
The name of the table in database which contains additional
information on places where presentities can be found. The
presence server can use this table to lookup additional
information about positions of presentities.
Default value is "place".
<varname>new_watcher_pending</varname> (integer)
This parameter controls the initial state of new watchers. When
set to 1 then new watchers will be listed as pending (waiting
for authorization), when set to 0 then new watchers will be
listed as active
Default value is 0.
<varname>callback_update_db</varname> (integer)
This parameter controls the default priority value. The range
of the parameter is 0 to 100 percent. The value will be
internaly converted to a float.
Default value is 50.
<varname>callback_lock_pdomain</varname> (integer)
Enable/disable locking in callbacks. This is for debugging
only, use with care.
Default value is 1 (enabled).
<varname>new_tuple_on_publish</varname> (integer)
The parameter controls whether a new tuple will be created if
it does not already exists when the presence server receives a publish.
Default value is 0 (no).
<varname>pidf_priority</varname> (integer)
Enable/disable priority parameter of contacts in pidf documents.
Default value is 1 (enabled).
Exported Functions
<function moreinfo="none">pa_handle_registration(domain)</function>
Process REGISTER messages and update the state of the
presentity. This function is no longer used.
Meaning of the parameters is as follows:
domain - The domain within the
presence server.
<function moreinfo="none">handle_subscription(domain)</function>
This function processes SUBSCRIBE and generates NOTIFY.
Meaning of the parameters is as follows:
domain - This can be either registrar
or jabber
.
<function>handle_subscription</function> usage
...
if (method=="SUBSCRIBE") {
if (!t_newtran()) {
log(1, "newtran error\n");
sl_reply_error();
};
handle_subscription("registrar");
break;
};
...
<function moreinfo="none">handle_publish(domain)</function>
Process PUBLISH messages, update the state of the presentity
accordingly and generate NOTIFY.
Meaning of the parameters is as follows:
domain - The domain within the
presence server.
<function>handle_subscription</function> usage
...
if (method=="PUBLISH") {
if (!t_newtran()) {
log(1, "newtran error\n");
sl_reply_error();
};
handle_publish("registrar");
break;
};
...
<function moreinfo="none">existing_subscription(domain)</function>
Lookup the table of all subscriptions in the presence server
and return 1 if it exists and 0 if not.
Meaning of the parameters is as follows:
domain - The domain within the
presence server.
<function moreinfo="none">pua_exists(domain)</function>
Try to find out whether user agent supports SUBSCRIBE and
return 1 if yes and 0 if not or not sure.
Meaning of the parameters is as follows:
domain - The domain within the
presence server.