[sr-dev] git:master: modules/debugger: refresh README

[Victor Seva]

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

Author: Victor Seva <linuxmaniac at torreviejawireless.org>
Committer: Victor Seva <linuxmaniac at torreviejawireless.org>
Date:   Sun Jul  7 07:25:34 2013 +0200

modules/debugger: refresh README

---

 modules/debugger/README |   49 +++++++++++++++++++++++++++++++++++++++++++++++
 1 files changed, 49 insertions(+), 0 deletions(-)

diff --git a/modules/debugger/README b/modules/debugger/README
index d7b350b..03e069d 100644
--- a/modules/debugger/README
+++ b/modules/debugger/README
@@ -40,6 +40,7 @@ Daniel-Constantin Mierla
         4. Functions
 
               4.1. dbg_breakpoint(mode)
+              4.2. dbg_pv_dump([mask] [, level])
 
         5. Exported RPC Functions
 
@@ -64,6 +65,7 @@ Daniel-Constantin Mierla
    1.10. Set mod_level parameter
    1.11. Set log_assign parameter
    1.12. dbg_breakpoint usage
+   1.13. dbg_pv_dump usage
 
 Chapter 1. Admin Guide
 
@@ -92,6 +94,7 @@ Chapter 1. Admin Guide
    4. Functions
 
         4.1. dbg_breakpoint(mode)
+        4.2. dbg_pv_dump([mask] [, level])
 
    5. Exported RPC Functions
 
@@ -294,6 +297,7 @@ modparam("debugger", "log_assign", 1)
 4. Functions
 
    4.1. dbg_breakpoint(mode)
+   4.2. dbg_pv_dump([mask] [, level])
 
 4.1. dbg_breakpoint(mode)
 
@@ -310,6 +314,51 @@ if($si=="10.0.0.10")
         dbg_breakpoint("1");
 ...
 
+4.2. dbg_pv_dump([mask] [, level])
+
+   Prints the content of pv_cache on json format. Defaults are mask=31 and
+   level = "L_DBG"
+
+   mask - Controls the content to dump:
+     * 1 - dump null values
+     * 2 - dump avp vars
+     * 4 - dump script vars
+     * 8 - dump xavp vars
+     * 16 - dump DP_OTHER vars
+
+   level - The level that will be used in LOG function. It can be:
+     * L_ALERT - log level -5
+     * L_BUG - log level -4
+     * L_CRIT - log level -3
+     * L_ERR - log level -1
+     * L_WARN - log level 0
+     * L_NOTICE - log level 1
+     * L_INFO - log level 2
+     * L_DBG - log level 3
+
+   Example 1.13. dbg_pv_dump usage
+...
+$var(temp) = 1;
+$avp(s:more_avp) = 2;
+$avp(s:more_avp) = 3;
+$xavp(x=>more) = "bye";
+$xavp(x[0]=>more) = "hi";
+$xavp(x[0]=>other) = 1;
+$xavp(x[0]=>other) = 2;
+$xavp(x=>different) = "foo";
+$var(empty) = $null;
+
+dbg_pv_dump(30, "L_DBG");
+...
+
+   Output
+...
+ 4(30943) DEBUG: debugger [debugger_api.c:1613]: dbg_dump_json(): {"$sp":37597,"
+$var(rc)":0,"$var(temp)":1,"$avp(more_avp)":[3,2],"$si":"127.0.0.1","$rc":0,"$xa
+vp(x)":[{"different":["foo"]},{"other":[2,1],"more":["hi","bye"]}],"$T_branch_id
+x":0,"$var(empty)":0}
+ ...
+
 5. Exported RPC Functions
 
    5.1. dbg.ls