PUA Usrloc

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()
2. Contributors
2.1. By Commit Statistics
2.2. By Commit Activity
3. Documentation
3.1. Contributors

List of Tables

2.1. Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)
2.2. Most recently active contributors(1) to this module

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

Chapter1.Admin Guide


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.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.

Example1.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.

Example1.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.

Example1.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.

Example1.4.pua_set_publish usage

if(is_method("REGISTER") && $fu=~"john@opensips.org") 


2.1.By Commit Statistics

Table2.1.Top contributors by DevScore(1), authored commits(2) and lines added/removed(3)

NameDevScoreCommitsLines ++Lines --
1. Anca Vamanu34171245365
2. Liviu Chircu (@liviuchircu)15135455
3. Bogdan-Andrei Iancu (@bogdan-iancu)15134660
4. Razvan Crainea (@razvancrainea)12101220
5. Daniel-Constantin Mierla (@miconda)1082519
6. Vlad Patrascu (@rvlad-patrascu)53147
7. Ovidiu Sas (@ovidiusas)42142
8. Peter Lemenkov (@lemenkov)4254
9. Konstantin Bokarius3125
10. Elena-Ramona Modroiu3111

All remaining contributors: Juha Heinanen (@juha-h), Walter Doekes (@wdoekes), Edson Gellert Schubert, Julien Blache.

(1) DevScore = author_commits + author_lines_added / (project_lines_added / project_commits) + author_lines_deleted / (project_lines_deleted / project_commits)

(2) including any documentation-related commits, excluding merge commits. Regarding imported patches/code, we do our best to count the work on behalf of the proper owner, as per the "fix_authors" and "mod_renames" arrays in opensips/doc/build-contrib.sh. If you identify any patches/commits which do not get properly attributed to you, please submit a pull request which extends "fix_authors" and/or "mod_renames".

(3) ignoring whitespace edits, renamed files and auto-generated files

2.2.By Commit Activity

Table2.2.Most recently active contributors(1) to this module

NameCommit Activity
1. Peter Lemenkov (@lemenkov)Jun 2018 - Feb 2020
2. Liviu Chircu (@liviuchircu)Mar 2014 - Nov 2019
3. Razvan Crainea (@razvancrainea)Feb 2012 - Sep 2019
4. Bogdan-Andrei Iancu (@bogdan-iancu)Feb 2007 - Apr 2019
5. Vlad Patrascu (@rvlad-patrascu)May 2017 - Apr 2019
6. Ovidiu Sas (@ovidiusas)Jan 2013 - Mar 2014
7. Walter Doekes (@wdoekes)Apr 2010 - Apr 2010
8. Anca VamanuNov 2006 - Oct 2009
9. Daniel-Constantin Mierla (@miconda)Dec 2006 - Mar 2008
10. Konstantin BokariusMar 2008 - Mar 2008

All remaining contributors: Edson Gellert Schubert, Juha Heinanen (@juha-h), Julien Blache, Elena-Ramona Modroiu.

(1) including any documentation-related commits, excluding merge commits



Last edited by: Peter Lemenkov (@lemenkov), Liviu Chircu (@liviuchircu), Vlad Patrascu (@rvlad-patrascu), Bogdan-Andrei Iancu (@bogdan-iancu), Razvan Crainea (@razvancrainea), Anca Vamanu, Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert, Elena-Ramona Modroiu.

Documentation Copyrights:

Copyright 2006 Voice Sistem SRL