mtree,tmrec,tmx,uac: refresed the readme

modules/mtree/README

@@ -20,9 +20,9 @@ Juha Heinanen
 
    <jh@tutpro.com>
 
-   Copyright (c) 2010 Daniel-Constantin Mierla (asipto.com)
+   Copyright � 2010 Daniel-Constantin Mierla (asipto.com)
 
-   Copyright (c) 2011 Juha Heinanen
+   Copyright � 2011 Juha Heinanen
      __________________________________________________________________
 
    Table of Contents
@@ -130,8 +130,16 @@ Chapter 1. Admin Guide
 
 1. Overview
 
-   This module loads data indexed by prefixes from database and returns
-   associated string or precompiled value.
+   This module loads (prefix, value) records from database and indexes
+   them in a named memory tree. Name of the tree is specified for each
+   record or as module parameter.
+
+   It exports to configuration file functions to match against in-memory
+   trees and return the values (raw or precompiled) associated with
+   matched prefixes.
+
+   The maximum size of the prefix is limited internally to 63, database
+   table definition may enforce lower maximum size.
 
 2. Dependencies
 
@@ -323,7 +331,7 @@ modparam("mtree", "mt_allow_duplicates", 1)
 
    4.1. mt_match(mtree, pv, mode)
 
-4.1.  mt_match(mtree, pv, mode)
+4.1. mt_match(mtree, pv, mode)
 
    Match 'pv' value against 'mtree'. If 'mtree' type is 0 or 2 and value
    of 'mode' is NOT 2, sets a value of the longest matching prefix to
@@ -347,7 +355,7 @@ mt_match("mytree", "$rU", "0");
    5.3. mt_summary
    5.4. mt_match
 
-5.1.  mt_list
+5.1. mt_list
 
    List content of a tree.
 
@@ -361,7 +369,7 @@ mt_match("mytree", "$rU", "0");
                 _mtname_
                 _empty_line_
 
-5.2.  mt_reload
+5.2. mt_reload
 
    Reload mtree from database.
 
@@ -376,7 +384,7 @@ mt_match("mytree", "$rU", "0");
                 _mtname_
                 _empty_line_
 
-5.3.  mt_summary
+5.3. mt_summary
 
    List usage summary for all trees.
 
@@ -388,7 +396,7 @@ mt_match("mytree", "$rU", "0");
                 :mt_summary:_reply_fifo_file_
                 _empty_line_
 
-5.4.  mt_match
+5.4. mt_match
 
    Match prefix value against mtree.
 
@@ -412,23 +420,23 @@ mt_match("mytree", "$rU", "0");
    6.2. mtree.reload
    6.3. mtree.match
 
-6.1.  mtree.summary
+6.1. mtree.summary
 
    List usage summary for all trees or for the tree whose name is given as
    parameter.
 
    Parameters:
      * _mtree_ - (optional) the name of the tree.
 
-6.2.  mtree.reload
+6.2. mtree.reload
 
    Reload mtree from database to memory.
 
    Parameters:
      * _mtree_
        - name of mtree or empty string meaning all mtrees
 
-6.3.  mtree.match
+6.3. mtree.match
 
    Match prefix value against mtree
 

modules/tmrec/README

@@ -16,7 +16,15 @@ Alex Balashov
 
    <abalashov@evaristesys.com>
 
+Edited by
+
+Richard Fuchs
+
+   <rfuchs@sipwise.com>
+
    Copyright � 2012 asipto.com
+
+   Copyright � 2012 Sipwise GmbH
      __________________________________________________________________
 
    Table of Contents

modules/tmx/README

@@ -242,7 +242,7 @@ if (t_cancel_callid("123qaz", "5", "22", "200")) {
 
 4.3. t_reply_callid(callid, cseq, code, reason)
 
-   Send reply to first INVITE transaction identified by callid and cseq.
+   Send reply to first transaction identified by callid and cseq.
 
    Parameters:.
      * callid - call-id value.

modules/uac/README

@@ -180,8 +180,11 @@ Chapter 1. Admin Guide
 
    Known limitations in this version:
      * Authentication does not support qop auth-int, just qop auth;
-     * CSeq is not increased during authentication - the response may be
-       rejected.
+     * CSeq is not increased automatically by uac_auth() during
+       authentication - the follow up request may be rejected. CSeq can be
+       increased when authenticating INVITE requests - dialog module has
+       to be used, with CSeq tracking feature enabled (see the readme of
+       dialog module).
      * The "uac_replace_*" functions can only be run once on the same SIP
        request. Try to save needed changes in a pseudovariable and apply
        them once.
@@ -612,7 +615,31 @@ uac_restore_to();
 
    Example 1.23. uac_auth usage
 ...
-uac_auth();
+modparam("uac","auth_username_avp","$avp(auser)")
+modparam("uac","auth_password_avp","$avp(apass)")
+modparam("uac","auth_realm_avp","$avp(arealm)")
+
+request_route {
+   ...
+   if(is_method("INVITE")) {
+      t_on_failure("TRUNKAUTH");
+   }
+   ...
+}
+
+failure_route[TRUNKAUTH] {
+
+    if (t_is_canceled()) {
+        exit;
+    }
+    if(t_check_status("401|407")) {
+        $avp(auser) = "test";
+        $avp(apass) = "test";
+        uac_auth();
+        t_relay();
+        exit;
+    }
+}
 ...
 
 4.8. uac_req_send()