
PUA MI

Anca-Maria Vamanu

   voice-system.ro

Edited by

Anca-Maria Vamanu

   Copyright © 2006 voice-system.ro
     _________________________________________________________

   Table of Contents
   1. User's Guide

        1.1. Overview
        1.2. Dependencies

              1.2.1. OpenSER Modules
              1.2.2. External Libraries or Applications

        1.3. Exported Parameters
        1.4. Exported Functions
        1.5. Exported MI functions

              1.5.1. mi_pua_publish

   2. Developer's Guide
   3. Frequently Asked Questions

   List of Examples
   1-1. mi_pua_publish FIFO example
     _________________________________________________________

Chapter 1. User's Guide

1.1. Overview

   The pua_mi sends offer the possibility to publish presence
   information via MI transports. Future improvement may be
   ability to subscribe for presence status via MI.

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

1.2. Dependencies

1.2.1. OpenSER Modules

   The following modules must be loaded before this module:

     * mi_fifo.
     * pua.
     _________________________________________________________

1.2.2. External Libraries or Applications

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

     * none.
     _________________________________________________________

1.3. Exported Parameters

     * none.
     _________________________________________________________

1.4. Exported Functions

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

1.5. Exported MI functions

1.5.1. mi_pua_publish

   Command parameters:

     * presentity_uri - like 'sip:system@openser.org' 
     * expires 
       The relative time in seconds (eg: 3600 )
     * body 
       The body of the publish message; the only format accepted
       is xml. For FIFO MI transport, it has to be on a single
       line.

   Example 1-1. mi_pua_publish FIFO example
...
:mi_pua_publish:fifo_test_reply
sip:system@openser.org
10
<?xml version='1.0'?><presence xmlns='urn:ietf:params:xml:ns:pidf' xmln
s:dm='urn:ietf:params:xml:ns:pidf:data-model' xmlns:rpid='urn:ietf:para
ms:xml:ns:pidf:rpid' xmlns:c='urn:ietf:params:xml:ns:pidf:cipid' entity
='system@openser.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></p
resence>
...
     _________________________________________________________

Chapter 2. Developer's Guide

   The module does not provide any API to use in other OpenSER
   modules.
     _________________________________________________________

Chapter 3. Frequently Asked Questions

   3.1. Where can I find more about OpenSER?
   3.2. Where can I post a question about this module?
   3.3. How can I report a bug?

   3.1. Where can I find more about OpenSER?

   Take a look at http://openser.org/.

   3.2. Where can I post a question about this module?

   First at all check if your question was already answered on
   one of our mailing lists:

     * User Mailing List -
       http://openser.org/cgi-bin/mailman/listinfo/users
     * Developer Mailing List -
       http://openser.org/cgi-bin/mailman/listinfo/devel

   E-mails regarding any stable OpenSER release should be sent to
   <users@openser.org> and e-mails regarding development versions
   should be sent to <devel@openser.org>.

   If you want to keep the mail private, send it to
   <team@openser.org>.

   3.3. How can I report a bug?

   Please follow the guidelines provided at:
   http://sourceforge.net/tracker/?group_id=139143.
