
uri Module

Jan Janak

   FhG FOKUS

Edited by

Jan Janak

   Copyright © 2003 FhG FOKUS
     _________________________________________________________

   Table of Contents
   1. User's Guide

        1.1. Overview
        1.2. Dependencies

              1.2.1. SER Modules
              1.2.2. External Libraries or Applications

        1.3. Exported Parameters
        1.4. Exported Functions

              1.4.1. is_user(username)
              1.4.2. has_totag()
              1.4.3. uri_param(param)
              1.4.4. uri_param(param, value)
              1.4.5. add_uri_param(param)
              1.4.6. tel2sip()

   2. Developer's Guide
   3. Frequently Asked Questions

   List of Examples
   1-1. is_user usage
   1-2. has_totag usage
     _________________________________________________________

Chapter 1. User's Guide

1.1. Overview

   Various checks related to SIP URI.
     _________________________________________________________

1.2. Dependencies

1.2.1. SER Modules

   None.
     _________________________________________________________

1.2.2. External Libraries or Applications

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

     * None.
     _________________________________________________________

1.3. Exported Parameters

   None.
     _________________________________________________________

1.4. Exported Functions

1.4.1. is_user(username)

   Check if the username in credentials matches the given
   username.

   Meaning of the parameters is as follows:

     * username - Username string.

   Example 1-1. is_user usage
...
if (is_user("jan")) {
    ...
};
...
     _________________________________________________________

1.4.2. has_totag()

   Check if To header field uri contains tag parameter.

   Example 1-2. has_totag usage
...
if (has_totag()) {
    ...
};
...
     _________________________________________________________

1.4.3. uri_param(param)

   Check for existence of a specific parameter in a SIP URI.

   Meaning of the parameters is as follows:

     * param - Name of parameter.
     _________________________________________________________

1.4.4. uri_param(param, value)

   Check for existence of a parameter with given value in SIP
   URI.

   Meaning of the parameters is as follows:

     * param - Name of parameter.
     * value - Desired value of the parameter.
     _________________________________________________________

1.4.5. add_uri_param(param)

   Add a parameter to SIP URI.

   Meaning of the parameters is as follows:

     * param - Complete parameter including value, if any. The
       parameter will be added verbatim to the SIP URI.
     _________________________________________________________

1.4.6. tel2sip()

   Convert tel URI into SIP URI.
     _________________________________________________________

Chapter 2. Developer's Guide

   The module does not provide any sort of API to use in other
   SER modules.
     _________________________________________________________

Chapter 3. Frequently Asked Questions

   3.1. Where can I find more about SER?
   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 SER?

   Take a look at http://iptel.org/ser.

   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:

     * http://mail.iptel.org/mailman/listinfo/serusers
     * http://mail.iptel.org/mailman/listinfo/serdev

   E-mails regarding any stable version should be sent to
   <serusers@iptel.org> and e-mail regarding development versions
   or CVS snapshots should be send to <serdev@iptel.org>.

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

   3.3. How can I report a bug?

   Please follow the guidelines provided at:
   http://iptel.org/ser/bugs
