PUA Bridged Line Appearances

Anca-Maria Vamanu

   voice-system.ro

Edited by

Anca-Maria Vamanu

   Copyright  2007 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.3.1. default_domain(str)
              1.3.2. header_name(str)
              1.3.3. outbound_proxy(str)
              1.3.4. server_address(str)

        1.4. Exported Functions

              1.4.1. bla_set_flag
              1.4.2. bla_handle_notify

   2. Developer's Guide
   3. Frequently Asked Questions

   List of Examples
   1-1. Set default_domain parameter
   1-2. Set header_name parameter
   1-3. Set outbound_proxy parameter
   1-4. Set server_address parameter
   1-5. bla_set_flag usage
   1-6. bla_handle_notify usage
     __________________________________________________________

Chapter 1. User's Guide

1.1. Overview

   The pua_bla module enables Bridged Line Appearances support
   according to the specifications in
   draft-anil-sipping-bla-03.txt.
     __________________________________________________________

1.2. Dependencies

1.2.1. OpenSER Modules

   The following modules must be loaded before this module:

     * usrloc.
     * pua.
     * presence.
     __________________________________________________________

1.2.2. External Libraries or Applications

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

     * libxml.
     __________________________________________________________

1.3. Exported Parameters

1.3.1. default_domain(str)

   The default domain for the registered users to be used when
   constructing the uri for the registrar callback.

   Default value is "NULL".

   Example 1-1. Set default_domain parameter
...
modparam("pua_bla", "default_domain", "openser.org")
...
     __________________________________________________________

1.3.2. header_name(str)

   The name of the header to be added to Publish requests. It will
   contain the uri of the user agent that sent the Notify that is
   transformed into Publish. It stops sending a Notification with
   the same information to the sender.

   Default value is "NULL".

   Example 1-2. Set header_name parameter
...
modparam("pua_bla", "header_name", "Sender")
...
     __________________________________________________________

1.3.3. outbound_proxy(str)

   The outbound_proxy uri to be used when sending Subscribe
   requests.

   Default value is "NULL".

   Example 1-3. Set outbound_proxy parameter
...
modparam("pua_bla", "outbound_proxy", "sip:proxy@openser.org")
...
     __________________________________________________________

1.3.4. server_address(str)

   The IP address of the server.

   Example 1-4. Set server_address parameter
...
modparam("pua_bla", "server_address", "sip:160.34.23.12")
...
     __________________________________________________________

1.4. Exported Functions

1.4.1. bla_set_flag

   The function is used to mark REGISTER requests made to a BLA
   AOR. The modules subscribes to the registered contacts for
   dialog;sla event.

   Example 1-5. bla_set_flag usage
...
if(is_method("REGISTER") && to_uri=~"bla_aor@openser.org")
        bla_set_flag();
...
     __________________________________________________________

1.4.2. bla_handle_notify

   The function handles Notify requests sent from phones on the
   same BLA to the server. The message is transformed in Publish
   request and passed to presence module for further handling. in
   case of a successful processing a 2xx reply should be sent.

   Example 1-6. bla_handle_notify usage
...
if(is_method("NOTIFY") && to_uri=~"bla_aor@openser.org")
{
                if( bla_handle_notify() )
                        t_reply("200", "OK");
}
...
     __________________________________________________________

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.
