modules: readme files regenerated - pv ... [skip ci]
authorKamailio Dev <kamailio.dev@kamailio.org>
Fri, 29 May 2020 21:46:12 +0000 (23:46 +0200)
committerKamailio Dev <kamailio.dev@kamailio.org>
Fri, 29 May 2020 21:46:12 +0000 (23:46 +0200)
src/modules/pv/README

index b9a701d..7533999 100644 (file)
@@ -48,17 +48,22 @@ Daniel-Constantin Mierla
               4.8. xavp_params_explode(sparams, xname)
               4.9. xavp_params_implode(xname, pvname)
               4.10. xavp_child_seti(rname, cname, ival)
-              4.11. xavp_child_sets(rname, cname, sval)
-              4.12. xavp_rm(rname)
-              4.13. xavp_child_rm(rname, cname)
-              4.14. sbranch_set_ruri()
-              4.15. sbranch_append()
-              4.16. sbranch_reset()
-              4.17. pv_xavp_print()
-              4.18. pv_xavu_print()
-              4.19. pv_var_to_xavp(varname, xname)
-              4.20. pv_xavp_to_var(xname)
-              4.21. pv_evalx(dst, fmt)
+              4.11. xavi_child_seti(rname, cname, ival)
+              4.12. xavp_child_sets(rname, cname, sval)
+              4.13. xavi_child_sets(rname, cname, sval)
+              4.14. xavp_rm(rname)
+              4.15. xavi_rm(rname)
+              4.16. xavp_child_rm(rname, cname)
+              4.17. xavi_child_rm(rname, cname)
+              4.18. sbranch_set_ruri()
+              4.19. sbranch_append()
+              4.20. sbranch_reset()
+              4.21. pv_xavp_print()
+              4.22. pv_xavu_print()
+              4.23. pv_xavi_print()
+              4.24. pv_var_to_xavp(varname, xname)
+              4.25. pv_xavp_to_var(xname)
+              4.26. pv_evalx(dst, fmt)
 
         5. RPC Commands
 
@@ -80,19 +85,24 @@ Daniel-Constantin Mierla
    1.11. xavp_params_explode usage
    1.12. xavp_params_implode usage
    1.13. xavp_child_seti usage
-   1.14. xavp_child_sets usage
-   1.15. xavp_rm usage
-   1.16. xavp_child_rm usage
-   1.17. sbranch_set_ruri() usage
-   1.18. sbranch_append() usage
-   1.19. sbranch_append() usage
-   1.20. pv_xavp_print() usage
-   1.21. pv_xavu_print() usage
-   1.22. pv_var_to_xavp() usage
-   1.23. pv_xavp_to_var() usage
-   1.24. pv_xavp_to_var() usage
-   1.25. pv.shvSet usage
-   1.26. pv.shvGet usage
+   1.14. xavi_child_seti usage
+   1.15. xavp_child_sets usage
+   1.16. xavi_child_sets usage
+   1.17. xavp_rm usage
+   1.18. xavi_rm usage
+   1.19. xavp_child_rm usage
+   1.20. xavi_child_rm usage
+   1.21. sbranch_set_ruri() usage
+   1.22. sbranch_append() usage
+   1.23. sbranch_append() usage
+   1.24. pv_xavp_print() usage
+   1.25. pv_xavu_print() usage
+   1.26. pv_xavi_print() usage
+   1.27. pv_var_to_xavp() usage
+   1.28. pv_xavp_to_var() usage
+   1.29. pv_xavp_to_var() usage
+   1.30. pv.shvSet usage
+   1.31. pv.shvGet usage
 
 Chapter 1. Admin Guide
 
@@ -124,17 +134,22 @@ Chapter 1. Admin Guide
         4.8. xavp_params_explode(sparams, xname)
         4.9. xavp_params_implode(xname, pvname)
         4.10. xavp_child_seti(rname, cname, ival)
-        4.11. xavp_child_sets(rname, cname, sval)
-        4.12. xavp_rm(rname)
-        4.13. xavp_child_rm(rname, cname)
-        4.14. sbranch_set_ruri()
-        4.15. sbranch_append()
-        4.16. sbranch_reset()
-        4.17. pv_xavp_print()
-        4.18. pv_xavu_print()
-        4.19. pv_var_to_xavp(varname, xname)
-        4.20. pv_xavp_to_var(xname)
-        4.21. pv_evalx(dst, fmt)
+        4.11. xavi_child_seti(rname, cname, ival)
+        4.12. xavp_child_sets(rname, cname, sval)
+        4.13. xavi_child_sets(rname, cname, sval)
+        4.14. xavp_rm(rname)
+        4.15. xavi_rm(rname)
+        4.16. xavp_child_rm(rname, cname)
+        4.17. xavi_child_rm(rname, cname)
+        4.18. sbranch_set_ruri()
+        4.19. sbranch_append()
+        4.20. sbranch_reset()
+        4.21. pv_xavp_print()
+        4.22. pv_xavu_print()
+        4.23. pv_xavi_print()
+        4.24. pv_var_to_xavp(varname, xname)
+        4.25. pv_xavp_to_var(xname)
+        4.26. pv_evalx(dst, fmt)
 
    5. RPC Commands
 
@@ -236,17 +251,22 @@ modparam("pv","avp_aliases","email=s:email_addr;tmp=i:100")
    4.8. xavp_params_explode(sparams, xname)
    4.9. xavp_params_implode(xname, pvname)
    4.10. xavp_child_seti(rname, cname, ival)
-   4.11. xavp_child_sets(rname, cname, sval)
-   4.12. xavp_rm(rname)
-   4.13. xavp_child_rm(rname, cname)
-   4.14. sbranch_set_ruri()
-   4.15. sbranch_append()
-   4.16. sbranch_reset()
-   4.17. pv_xavp_print()
-   4.18. pv_xavu_print()
-   4.19. pv_var_to_xavp(varname, xname)
-   4.20. pv_xavp_to_var(xname)
-   4.21. pv_evalx(dst, fmt)
+   4.11. xavi_child_seti(rname, cname, ival)
+   4.12. xavp_child_sets(rname, cname, sval)
+   4.13. xavi_child_sets(rname, cname, sval)
+   4.14. xavp_rm(rname)
+   4.15. xavi_rm(rname)
+   4.16. xavp_child_rm(rname, cname)
+   4.17. xavi_child_rm(rname, cname)
+   4.18. sbranch_set_ruri()
+   4.19. sbranch_append()
+   4.20. sbranch_reset()
+   4.21. pv_xavp_print()
+   4.22. pv_xavu_print()
+   4.23. pv_xavi_print()
+   4.24. pv_var_to_xavp(varname, xname)
+   4.25. pv_xavp_to_var(xname)
+   4.26. pv_evalx(dst, fmt)
 
 4.1. pv_isset(pvar)
 
@@ -454,7 +474,24 @@ xavp_child_seti("x", "y", "$var(n)");
 # results in: $xavp(x=>y) is 10
 ...
 
-4.11.  xavp_child_sets(rname, cname, sval)
+4.11.  xavi_child_seti(rname, cname, ival)
+
+   Set the value of $xavi(rname=>cname) to integer value ival.
+
+   The first parameter has to be the name of XAVI in the root list. The
+   second parameter name of child XAVI. The third parameter can be an
+   integer number or a variable holding an integer.
+
+   Function can be used from ANY ROUTE.
+
+   Example 1.14. xavi_child_seti usage
+...
+$var(n) = 10;
+xavi_child_seti("WhatEver", "FoO", "$var(n)");
+# results in: $xavi(whatever=>foo) is 10
+...
+
+4.12.  xavp_child_sets(rname, cname, sval)
 
    Set the value of $xavp(rname=>cname) to string value sval.
 
@@ -464,14 +501,31 @@ xavp_child_seti("x", "y", "$var(n)");
 
    Function can be used from ANY ROUTE.
 
-   Example 1.14. xavp_child_sets usage
+   Example 1.15. xavp_child_sets usage
 ...
 $var(n) = 10;
 xavp_child_sets("x", "y", "Count: $var(n)");
 # results in: $xavp(x=>y) is "Count: 10"
 ...
 
-4.12.  xavp_rm(rname)
+4.13.  xavi_child_sets(rname, cname, sval)
+
+   Set the value of $xavi(rname=>cname) to string value sval.
+
+   The first parameter has to be the name of XAVI in the root list. The
+   second parameter name of child XAVI. The third parameter can be a
+   static or dynamic (with variables) string.
+
+   Function can be used from ANY ROUTE.
+
+   Example 1.16. xavi_child_sets usage
+...
+$var(n) = 10;
+xavi_child_sets("WhatEver", "FoO", "Count: $var(n)");
+# results in: $xavi(whatever=>foo) is "Count: 10"
+...
+
+4.14.  xavp_rm(rname)
 
    Remove the value of $xavp(rname).
 
@@ -480,13 +534,28 @@ xavp_child_sets("x", "y", "Count: $var(n)");
 
    Function can be used from ANY ROUTE.
 
-   Example 1.15. xavp_rm usage
+   Example 1.17. xavp_rm usage
 ...
 xavp_rm("x");
 # same result as: $xavp(x) = $null;
 ...
 
-4.13.  xavp_child_rm(rname, cname)
+4.15.  xavi_rm(rname)
+
+   Remove the value of $xavi(rname).
+
+   The parameter has to be the name of XAVI in the root list. It can be
+   static or dynamic string (to include variables).
+
+   Function can be used from ANY ROUTE.
+
+   Example 1.18. xavi_rm usage
+...
+xavi_rm("WhatEver");
+# same result as: $xavi(whatever) = $null;
+...
+
+4.16.  xavp_child_rm(rname, cname)
 
    Remove the value of $xavp(rname=>cname).
 
@@ -496,13 +565,29 @@ xavp_rm("x");
 
    Function can be used from ANY ROUTE.
 
-   Example 1.16. xavp_child_rm usage
+   Example 1.19. xavp_child_rm usage
 ...
 xavp_child_rm("x", "y");
 # same result as: $xavp(x=>y) = $null;
 ...
 
-4.14.  sbranch_set_ruri()
+4.17.  xavi_child_rm(rname, cname)
+
+   Remove the value of $xavi(rname=>cname).
+
+   The first parameter has to be the name of XAVI in the root list. The
+   second parameter name of child XAVI. Both parameters can be static or
+   dynamic strings (to include variables).
+
+   Function can be used from ANY ROUTE.
+
+   Example 1.20. xavi_child_rm usage
+...
+xavi_child_rm("WhatEver", "FoO");
+# same result as: $xavi(whatever=>foo) = $null;
+...
+
+4.18.  sbranch_set_ruri()
 
    Use the attributes from static branch ($sbranch(key) variable) to set
    request URI and the other fields of the branch associated with request
@@ -513,7 +598,7 @@ xavp_child_rm("x", "y");
 
    Function can be used from REQUEST_ROUTE, BRANCH_ROUTE or FAILURE_ROUTE.
 
-   Example 1.17. sbranch_set_ruri() usage
+   Example 1.21. sbranch_set_ruri() usage
 ...
 sbranch_reset();
 $sbranch(uri) = "sip:127.0.0.1:5080";
@@ -523,7 +608,7 @@ $sbranch(send_socket) =  "udp:127.0.0.1:5060";
 sbranch_set_ruri();
 ...
 
-4.15.  sbranch_append()
+4.19.  sbranch_append()
 
    Use the attributes from static branch ($sbranch(key) variable) to
    append a new branch to destination set. It is an alternative to
@@ -535,7 +620,7 @@ sbranch_set_ruri();
 
    Function can be used from REQUEST_ROUTE, BRANCH_ROUTE or FAILURE_ROUTE.
 
-   Example 1.18. sbranch_append() usage
+   Example 1.22. sbranch_append() usage
 ...
 sbranch_reset();
 $sbranch(uri) = "sip:127.0.0.1:5080";
@@ -544,40 +629,51 @@ $sbranch(send_socket) =  "udp:127.0.0.1:5060";
 sbranch_append();
 ...
 
-4.16.  sbranch_reset()
+4.20.  sbranch_reset()
 
    Reset the content of static branch ($sbranch(key) variable.
 
    Function can be used from REQUEST_ROUTE, BRANCH_ROUTE or FAILURE_ROUTE.
 
-   Example 1.19. sbranch_append() usage
+   Example 1.23. sbranch_append() usage
 ...
 sbranch_reset();
 ...
 
-4.17.  pv_xavp_print()
+4.21.  pv_xavp_print()
 
    Print all XAVPs to the syslog using INFO log level.
 
    Function can be used from ANY_ROUTE.
 
-   Example 1.20. pv_xavp_print() usage
+   Example 1.24. pv_xavp_print() usage
 ...
 pv_xavp_print();
 ...
 
-4.18.  pv_xavu_print()
+4.22.  pv_xavu_print()
 
    Print all XAVUs to the syslog using INFO log level.
 
    Function can be used from ANY_ROUTE.
 
-   Example 1.21. pv_xavu_print() usage
+   Example 1.25. pv_xavu_print() usage
 ...
 pv_xavu_print();
 ...
 
-4.19.  pv_var_to_xavp(varname, xname)
+4.23.  pv_xavi_print()
+
+   Print all XAVIs to the syslog using INFO log level.
+
+   Function can be used from ANY_ROUTE.
+
+   Example 1.26. pv_xavi_print() usage
+...
+pv_xavi_print();
+...
+
+4.24.  pv_var_to_xavp(varname, xname)
 
    Copy the script variable value into an xavp.
 
@@ -589,7 +685,7 @@ pv_xavu_print();
 
    Function can be used from ANY_ROUTE.
 
-   Example 1.22. pv_var_to_xavp() usage
+   Example 1.27. pv_var_to_xavp() usage
 ...
 $var("temp") = 3;
 $var("foo") = "foo indeed";
@@ -603,7 +699,7 @@ $xavp("ok[0]=>temp") now is 3
 $xavp("ok[0]=>foo") now is "foo indeed"
 ...
 
-4.20.  pv_xavp_to_var(xname)
+4.25.  pv_xavp_to_var(xname)
 
    Copy xavp values into vars. Reverse of pv_var_to_xavp().
 
@@ -611,7 +707,7 @@ $xavp("ok[0]=>foo") now is "foo indeed"
 
    Function can be used from ANY_ROUTE.
 
-   Example 1.23. pv_xavp_to_var() usage
+   Example 1.28. pv_xavp_to_var() usage
 ...
 $xavp("bar=>temp") = 3;
 $xavp("bar[0]=>foo") = "foo indeed";
@@ -621,7 +717,7 @@ $var("temp") now is 3
 $var("foo") now is "foo indeed"
 ...
 
-4.21.  pv_evalx(dst, fmt)
+4.26.  pv_evalx(dst, fmt)
 
    The fmt string is evaluated twice for exiting variables, the result is
    stored in dst variable. The dst must be the name of a writable
@@ -630,7 +726,7 @@ $var("foo") now is "foo indeed"
 
    Function can be used from ANY_ROUTE.
 
-   Example 1.24. pv_xavp_to_var() usage
+   Example 1.29. pv_xavp_to_var() usage
 ...
 $var(x) = "test";
 $var(y) = "$var(x)"
@@ -655,7 +751,7 @@ pv_evalx("$var(z)", "$var(y) one");
           + “str”: string value
      * _value_: value to be set
 
-   Example 1.25. pv.shvSet usage
+   Example 1.30. pv.shvSet usage
 ...
 $ kamcmd pv.shvSet debug int 3
 ...
@@ -669,7 +765,7 @@ $ kamcmd pv.shvSet debug int 3
 
    If no name is given, all shared variables are listed.
 
-   Example 1.26. pv.shvGet usage
+   Example 1.31. pv.shvGet usage
 ...
 $ kamcmd pv.shvGet debug
 ...