PUA MI


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. presence_server (str)
1.4. Exported Functions
1.5. Exported MI functions
1.5.1. pua_publish
1.6. pua_subscribe
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 presence_server parameter
1.2. pua_publish FIFO example

Chapter1.Admin Guide

1.1.Overview

The pua_mi offers the possibility to publish presence information and subscribe to presence information via MI transports.

Using this module you can create independent applications/scripts to publish not sip-related information (e.g., system resources like CPU-usage, memory, number of active subscribers ...). Also, this module allows non-SIP speaking applications to subscribe presence information kept in a SIP presence server.

1.2.Dependencies

1.2.1.OpenSIPS Modules

The following modules must be loaded before this module:

  • pua

1.2.2.External Libraries or Applications

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

  • none

1.3.Exported Parameters

1.3.1.presence_server (str)

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

Example1.1.Set presence_server parameter

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

1.4.Exported Functions

The module does not export functions to be used in configuration script.

1.5.Exported MI functions

1.5.1. pua_publish

Command parameters:

  • presentity_uri - e.g. sip:system@opensips.org

  • expires - Relative expires time in seconds (e.g. 3600).

  • event package - Event package that is target of published information (e.g. presence).

  • content type - Content type of published information (e.g. application/pidf+xml) or . if no information is enclosed.

  • ETag - ETag that publish should match or . if no ETag is given.

  • extra_headers - Extra headers added to PUBLISH request or . if no extra headers.

  • body - The body of the publish request containing published information or missing if no published information. It has to be a single line for FIFO transport.

Example1.2.pua_publish FIFO example

...

:pua_publish:fifo_test_reply
sip:system@opensips.org
3600
presence
application/pidf+xml
.
.
<?xml version='1.0'?><presence xmlns='urn:ietf:params:xml:ns:pidf' xmlns:dm='urn:ietf:params:xml:ns:pidf:data-model' xmlns:rpid='urn:ietf:params:xml:ns:pidf:rpid' xmlns:c='urn:ietf:params:xml:ns:pidf:cipid' entity='system@opensips.org'><tuple id='0x81475a0'><status><basic>open</basic></status></tuple><dm:person id='pdd748945'><rpid:activities><rpid:away/>away</rpid:activities><dm:note>CPU:16 MEM:476</dm:note></dm:person></presence>


1.6. pua_subscribe

Command parameters:

  • presentity_uri - e.g. sip:presentity@opensips.org

  • watcher_uri - e.g. sip:watcher@opensips.org

  • event package

  • expires - Relative time in seconds for the desired validity of the subscription.

Chapter2.Contributors

2.1.By Commit Statistics

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

NameDevScoreCommitsLines ++Lines --
1. Anca Vamanu30151246267
2. Bogdan-Andrei Iancu (@bogdan-iancu)15134153
3. Juha Heinanen (@juha-h)11716073
4. Daniel-Constantin Mierla (@miconda)973229
5. Liviu Chircu (@liviuchircu)862136
6. Razvan Crainea (@razvancrainea)641114
7. Ovidiu Sas (@ovidiusas)31132
8. Konstantin Bokarius3125
9. Edson Gellert Schubert310103
10. Julien Blache1100

(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. Bogdan-Andrei Iancu (@bogdan-iancu)Dec 2006 - Jun 2018
2. Liviu Chircu (@liviuchircu)Mar 2014 - Jun 2018
3. Razvan Crainea (@razvancrainea)Sep 2011 - Aug 2015
4. Ovidiu Sas (@ovidiusas)Jan 2013 - Jan 2013
5. Anca VamanuNov 2006 - Aug 2010
6. Juha Heinanen (@juha-h)Apr 2007 - May 2008
7. Daniel-Constantin Mierla (@miconda)Feb 2007 - Mar 2008
8. Konstantin BokariusMar 2008 - Mar 2008
9. Edson Gellert SchubertFeb 2008 - Feb 2008
10. Julien BlacheMar 2007 - Mar 2007

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

Chapter3.Documentation

3.1.Contributors

Last edited by: Bogdan-Andrei Iancu (@bogdan-iancu), Liviu Chircu (@liviuchircu), Razvan Crainea (@razvancrainea), Anca Vamanu, Juha Heinanen (@juha-h), Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert.

doc copyrights:

Copyright 2006 Voice Sistem SRL