"Fossies" - the Fresh Open Source Software Archive

Member "opensips-3.0.1/modules/pua_bla/README" (1 Oct 2019, 6836 Bytes) of package /linux/misc/opensips-3.0.1.tar.gz:


As a special service "Fossies" has tried to format the requested text file into HTML format (style: standard) with prefixed line numbers. Alternatively you can here view or download the uninterpreted source code file. See also the latest Fossies "Diffs" side-by-side code changes report for "README": 3.0.0_vs_3.0.1.

    1 PUA Bridged Line Appearances
    2      __________________________________________________________
    3 
    4    Table of Contents
    5 
    6    1. Admin Guide
    7 
    8         1.1. Overview
    9         1.2. Dependencies
   10 
   11               1.2.1. OpenSIPS Modules
   12               1.2.2. External Libraries or Applications
   13 
   14         1.3. Exported Parameters
   15 
   16               1.3.1. default_domain(str)
   17               1.3.2. header_name(str)
   18               1.3.3. outbound_proxy(str)
   19               1.3.4. server_address(str)
   20               1.3.5. presence_server(str)
   21 
   22         1.4. Exported Functions
   23 
   24               1.4.1. bla_set_flag()
   25               1.4.2. bla_handle_notify()
   26 
   27    2. Contributors
   28 
   29         2.1. By Commit Statistics
   30         2.2. By Commit Activity
   31 
   32    3. Documentation
   33 
   34         3.1. Contributors
   35 
   36    List of Tables
   37 
   38    2.1. Top contributors by DevScore^(1), authored commits^(2) and
   39           lines added/removed^(3)
   40 
   41    2.2. Most recently active contributors^(1) to this module
   42 
   43    List of Examples
   44 
   45    1.1. Set default_domain parameter
   46    1.2. Set header_name parameter
   47    1.3. Set outbound_proxy parameter
   48    1.4. Set server_address parameter
   49    1.5. Set presence_server parameter
   50    1.6. bla_set_flag usage
   51    1.7. bla_handle_notify usage
   52 
   53 Chapter 1. Admin Guide
   54 
   55 1.1. Overview
   56 
   57    The pua_bla module enables Bridged Line Appearances support
   58    according to the specifications in
   59    draft-anil-sipping-bla-03.txt.
   60 
   61 1.2. Dependencies
   62 
   63 1.2.1. OpenSIPS Modules
   64 
   65    The following modules must be loaded before this module:
   66      * usrloc.
   67      * pua.
   68      * presence.
   69 
   70 1.2.2. External Libraries or Applications
   71 
   72    The following libraries or applications must be installed
   73    before running OpenSIPS with this module loaded:
   74      * libxml.
   75 
   76 1.3. Exported Parameters
   77 
   78 1.3.1. default_domain(str)
   79 
   80    The default domain for the registered users to be used when
   81    constructing the uri for the registrar callback.
   82 
   83    Default value is “NULL”.
   84 
   85    Example 1.1. Set default_domain parameter
   86 ...
   87 modparam("pua_bla", "default_domain", "opensips.org")
   88 ...
   89 
   90 1.3.2. header_name(str)
   91 
   92    The name of the header to be added to Publish requests. It will
   93    contain the uri of the user agent that sent the Notify that is
   94    transformed into Publish. It stops sending a Notification with
   95    the same information to the sender.
   96 
   97    Default value is “NULL”.
   98 
   99    Example 1.2. Set header_name parameter
  100 ...
  101 modparam("pua_bla", "header_name", "Sender")
  102 ...
  103 
  104 1.3.3. outbound_proxy(str)
  105 
  106    The outbound_proxy uri to be used when sending Subscribe
  107    requests.
  108 
  109    Default value is “NULL”.
  110 
  111    Example 1.3. Set outbound_proxy parameter
  112 ...
  113 modparam("pua_bla", "outbound_proxy", "sip:proxy@opensips.org")
  114 ...
  115 
  116 1.3.4. server_address(str)
  117 
  118    The IP address of the server.
  119 
  120    Example 1.4. Set server_address parameter
  121 ...
  122 modparam("pua_bla", "server_address", "sip:bla@160.34.23.12")
  123 ...
  124 
  125 1.3.5. presence_server(str)
  126 
  127    The address of the presence server - will be used as an
  128    outbound proxy when sending PUBLISH requests. It is optional.
  129 
  130    Default value is “NULL”.
  131 
  132    Example 1.5. Set presence_server parameter
  133 ...
  134 modparam("pua_bla", "presence_server", "sip:pa@opensips.org")
  135 ...
  136 
  137 1.4. Exported Functions
  138 
  139 1.4.1.  bla_set_flag()
  140 
  141    The function is used to mark REGISTER requests made to a BLA
  142    AOR. The modules subscribes to the registered contacts for
  143    dialog;sla event.
  144 
  145    Example 1.6. bla_set_flag usage
  146 ...
  147 if(is_method("REGISTER") && $tu=~"bla_aor@opensips.org")
  148         bla_set_flag();
  149 ...
  150 
  151 1.4.2.  bla_handle_notify()
  152 
  153    The function handles Notify requests sent from phones on the
  154    same BLA to the server. The message is transformed in Publish
  155    request and passed to presence module for further handling. in
  156    case of a successful processing a 2xx reply should be sent.
  157 
  158    Example 1.7. bla_handle_notify usage
  159 ...
  160 if(is_method("NOTIFY") && $tu=~"bla_aor@opensips.org")
  161 {
  162                 if( bla_handle_notify() )
  163                         t_reply(200, "OK");
  164 }
  165 ...
  166 
  167 Chapter 2. Contributors
  168 
  169 2.1. By Commit Statistics
  170 
  171    Table 2.1. Top contributors by DevScore^(1), authored
  172    commits^(2) and lines added/removed^(3)
  173      Name DevScore Commits Lines ++ Lines --
  174    1. Anca Vamanu 57 27 1961 779
  175    2. Liviu Chircu (@liviuchircu) 16 13 58 71
  176    3. Bogdan-Andrei Iancu (@bogdan-iancu) 15 12 42 60
  177    4. Daniel-Constantin Mierla (@miconda) 9 7 17 15
  178    5. Vlad Patrascu (@rvlad-patrascu) 7 5 20 18
  179    6. Razvan Crainea (@razvancrainea) 7 5 10 11
  180    7. Ovidiu Sas (@ovidiusas) 4 2 15 4
  181    8. Vlad Paiu (@vladpaiu) 3 1 6 16
  182    9. Sergio Gutierrez 3 1 4 4
  183    10. Konstantin Bokarius 3 1 2 5
  184 
  185    All remaining contributors: Juha Heinanen (@juha-h), Ezequiel
  186    Lovelle, Peter Lemenkov (@lemenkov), Edson Gellert Schubert,
  187    Stanislaw Pitucha.
  188 
  189    (1) DevScore = author_commits + author_lines_added /
  190    (project_lines_added / project_commits) + author_lines_deleted
  191    / (project_lines_deleted / project_commits)
  192 
  193    (2) including any documentation-related commits, excluding
  194    merge commits. Regarding imported patches/code, we do our best
  195    to count the work on behalf of the proper owner, as per the
  196    "fix_authors" and "mod_renames" arrays in
  197    opensips/doc/build-contrib.sh. If you identify any
  198    patches/commits which do not get properly attributed to you,
  199    please submit a pull request which extends "fix_authors" and/or
  200    "mod_renames".
  201 
  202    (3) ignoring whitespace edits, renamed files and auto-generated
  203    files
  204 
  205 2.2. By Commit Activity
  206 
  207    Table 2.2. Most recently active contributors^(1) to this module
  208                       Name                   Commit Activity
  209    1.  Razvan Crainea (@razvancrainea)     Feb 2012 - Sep 2019
  210    2.  Vlad Patrascu (@rvlad-patrascu)     May 2017 - Apr 2019
  211    3.  Bogdan-Andrei Iancu (@bogdan-iancu) Jul 2007 - Apr 2019
  212    4.  Liviu Chircu (@liviuchircu)         Mar 2014 - Nov 2018
  213    5.  Peter Lemenkov (@lemenkov)          Jun 2018 - Jun 2018
  214    6.  Ezequiel Lovelle                    Oct 2014 - Oct 2014
  215    7.  Ovidiu Sas (@ovidiusas)             Dec 2010 - Jan 2013
  216    8.  Vlad Paiu (@vladpaiu)               Aug 2011 - Aug 2011
  217    9.  Anca Vamanu                         Apr 2007 - Apr 2011
  218    10. Stanislaw Pitucha                   Jul 2010 - Jul 2010
  219 
  220    All remaining contributors: Sergio Gutierrez, Daniel-Constantin
  221    Mierla (@miconda), Konstantin Bokarius, Edson Gellert Schubert,
  222    Juha Heinanen (@juha-h).
  223 
  224    (1) including any documentation-related commits, excluding
  225    merge commits
  226 
  227 Chapter 3. Documentation
  228 
  229 3.1. Contributors
  230 
  231    Last edited by: Vlad Patrascu (@rvlad-patrascu), Peter Lemenkov
  232    (@lemenkov), Liviu Chircu (@liviuchircu), Bogdan-Andrei Iancu
  233    (@bogdan-iancu), Razvan Crainea (@razvancrainea), Anca Vamanu,
  234    Daniel-Constantin Mierla (@miconda), Konstantin Bokarius, Edson
  235    Gellert Schubert.
  236 
  237    Documentation Copyrights:
  238 
  239    Copyright © 2007 Voice Sistem SRL