[sr-dev] git:master: Updating PDB readme as well...

[Olle E. Johansson]

Module: sip-router
Branch: master
Commit: ac4b0278d0ef00333155f804eca2cc7799e6dfbd
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=ac4b0278d0ef00333155f804eca2cc7799e6dfbd

Author: oej <oej at edvina.net>
Committer: oej <oej at edvina.net>
Date:   Fri Oct  9 22:25:34 2009 +0200

Updating PDB readme as well...

---

 modules/pdb/README |   18 ++++++++++++------
 1 files changed, 12 insertions(+), 6 deletions(-)

diff --git a/modules/pdb/README b/modules/pdb/README
index af034bf..9df036c 100644
--- a/modules/pdb/README
+++ b/modules/pdb/README
@@ -14,7 +14,7 @@ Henning Westerholt
    Copyright © 2009 1&1 Internet AG
    Revision History
    Revision $Revision: 4863 $ $Date: 2008-09-05 13:11:33 +0200 (Fri, 05
-                              Sep 2008) $
+   Sep 2008) $
      __________________________________________________________________
 
    Table of Contents
@@ -78,6 +78,12 @@ Chapter 1. Admin Guide
 
 1. Overview
 
+   This is a module for fast number portability handling. The client is
+   this module and the server exists in the /utils/pdbt directory. The PDB
+   module and server supports load-balancing and aggressive timeouts.i
+   Normally it does not need more than a few ms to query the remote server
+   and return the reply to the configuration script.
+
    The pdb module allows Kamailio to send queries to a list of servers and
    store the answer in an AVP. The idea is to ask all servers in parallel
    and use the first answer, that comes back. A timeout for the query can
@@ -99,7 +105,7 @@ Chapter 1. Admin Guide
 
    The following libraries or applications must be installed before
    running Kamailio with this module loaded:
-     * none
+     * The PDB server
 
 3. Exported Parameters
 
@@ -132,7 +138,7 @@ modparam("pdb", "server", "localhost:10001,host.name:10001,192.168.1.7:10002")
 
    4.1. pdb_query (string query, string dstavp)
 
-4.1.  pdb_query (string query, string dstavp)
+4.1. pdb_query (string query, string dstavp)
 
    Sends the query string to all configured servers and stores the answer
    in dstavp. If it takes more than the configured timeout, false is
@@ -156,7 +162,7 @@ cr_route("$avp(i:82)", "$rd", "$rU", "$rU", "call_id");
    5.2. pdb_activate
    5.3. pdb_deactivate
 
-5.1.  pdb_status
+5.1. pdb_status
 
    Prints the status of the module. This can either be "active" or
    "deactivated".
@@ -166,7 +172,7 @@ cr_route("$avp(i:82)", "$rd", "$rU", "$rU", "call_id");
 kamctl fifo pdb_status
 ...
 
-5.2.  pdb_activate
+5.2. pdb_activate
 
    Activates the module. This is the default after loading the module.
 
@@ -175,7 +181,7 @@ kamctl fifo pdb_status
 kamctl fifo pdb_activate
 ...
 
-5.3.  pdb_deactivate
+5.3. pdb_deactivate
 
    Deactivates the module. No more queries are performed until it is
    activated again. As long as the module is deactivated, the pdb_query