PUA Usrloc

Anca-Maria Vamanu

Edited by

Anca-Maria Vamanu

Copyright © 2006 Voice Sistem SRL

Revision History
Revision $Revision: 8740 $$Date$

Table of Contents

1. Admin Guide
1.1. Overview
1.2. Dependencies
1.2.1. OpenSIPS Modules
1.2.2. External Libraries or Applications
1.3. Exported Parameters
1.3.1. default_domain (str)
1.3.2. entity_prefix (str)
1.3.3. presence_server (str)
1.4. Exported Functions
1.4.1. pua_set_publish()

List of Examples

1.1. Set default_domain parameter
1.2. Set presentity_prefix parameter
1.3. Set presence_server parameter
1.4. pua_set_publish usage

Chapter 1. Admin Guide

1.1. Overview

The pua_usrloc is the connector between usrloc and pua modules. It creates the environment to send PUBLISH requests for user location records, on specific events (e.g., when new record is added in usrloc, a PUBLISH with status open (online) is issued; when expires, it sends closed (offline)).

Using this module, phones which have no support for presence can be seen as online/offline.

1.2. Dependencies

1.2.1. OpenSIPS Modules

The following modules must be loaded before this module:

  • usrloc.

  • pua.

1.2.2. External Libraries or Applications

The following libraries or applications must be installed before running OpenSIPS with this module loaded:

  • libxml.

1.3. Exported Parameters

1.3.1. default_domain (str)

The default domain to use when constructing the presentity uri if it is missing from recorded aor.

Default value is “NULL”.

Example 1.1. Set default_domain parameter

...
modparam("pua_usrloc", "default_domain", "opensips.org")
...

1.3.2. entity_prefix (str)

The prefix when construstructing entity attribute to be added to presence node in xml pidf. (ex: pres:user@domain ).

Default value is “NULL”.

Example 1.2. Set presentity_prefix parameter

...
modparam("pua_usrloc", "entity_prefix", "pres")
...

1.3.3. presence_server (str)

The the address of the presence server. If set, it will be used as outbound proxy when sending PUBLISH requests.

Example 1.3. Set presence_server parameter

...
modparam("pua_usrloc", "presence_server", "sip:pa@opensips.org:5075")
...

1.4. Exported Functions

1.4.1.  pua_set_publish()

The function is used to mark REGISTER requests that have to issue a PUBLISH. The PUBLISH is issued when REGISTER is saved in location table.

Example 1.4. pua_set_publish usage

...
if(is_method("REGISTER") && from_uri=~"john@opensips.org") 
	pua_set_publish();
...