Browse code

modules: readme files regenerated - pv ... [skip ci]

Kamailio Dev authored on 10/05/2022 17:46:22
Showing 1 changed files
... ...
@@ -58,15 +58,16 @@ Daniel-Constantin Mierla
58 58
               4.18. xavi_rm(rname)
59 59
               4.19. xavp_child_rm(rname, cname)
60 60
               4.20. xavi_child_rm(rname, cname)
61
-              4.21. sbranch_set_ruri()
62
-              4.22. sbranch_append()
63
-              4.23. sbranch_reset()
64
-              4.24. pv_xavp_print()
65
-              4.25. pv_xavu_print()
66
-              4.26. pv_xavi_print()
67
-              4.27. pv_var_to_xavp(varname, xname)
68
-              4.28. pv_xavp_to_var(xname)
69
-              4.29. pv_evalx(dst, fmt)
61
+              4.21. xavp_lshift(xname, idx)
62
+              4.22. sbranch_set_ruri()
63
+              4.23. sbranch_append()
64
+              4.24. sbranch_reset()
65
+              4.25. pv_xavp_print()
66
+              4.26. pv_xavu_print()
67
+              4.27. pv_xavi_print()
68
+              4.28. pv_var_to_xavp(varname, xname)
69
+              4.29. pv_xavp_to_var(xname)
70
+              4.30. pv_evalx(dst, fmt)
70 71
 
71 72
         5. RPC Commands
72 73
 
... ...
@@ -98,17 +99,18 @@ Daniel-Constantin Mierla
98 99
    1.21. xavi_rm usage
99 100
    1.22. xavp_child_rm usage
100 101
    1.23. xavi_child_rm usage
101
-   1.24. sbranch_set_ruri() usage
102
-   1.25. sbranch_append() usage
102
+   1.24. xavp_lshift usage
103
+   1.25. sbranch_set_ruri() usage
103 104
    1.26. sbranch_append() usage
104
-   1.27. pv_xavp_print() usage
105
-   1.28. pv_xavu_print() usage
106
-   1.29. pv_xavi_print() usage
107
-   1.30. pv_var_to_xavp() usage
108
-   1.31. pv_xavp_to_var() usage
105
+   1.27. sbranch_append() usage
106
+   1.28. pv_xavp_print() usage
107
+   1.29. pv_xavu_print() usage
108
+   1.30. pv_xavi_print() usage
109
+   1.31. pv_var_to_xavp() usage
109 110
    1.32. pv_xavp_to_var() usage
110
-   1.33. pv.shvSet usage
111
-   1.34. pv.shvGet usage
111
+   1.33. pv_xavp_to_var() usage
112
+   1.34. pv.shvSet usage
113
+   1.35. pv.shvGet usage
112 114
 
113 115
 Chapter 1. Admin Guide
114 116
 
... ...
@@ -150,15 +152,16 @@ Chapter 1. Admin Guide
150 152
         4.18. xavi_rm(rname)
151 153
         4.19. xavp_child_rm(rname, cname)
152 154
         4.20. xavi_child_rm(rname, cname)
153
-        4.21. sbranch_set_ruri()
154
-        4.22. sbranch_append()
155
-        4.23. sbranch_reset()
156
-        4.24. pv_xavp_print()
157
-        4.25. pv_xavu_print()
158
-        4.26. pv_xavi_print()
159
-        4.27. pv_var_to_xavp(varname, xname)
160
-        4.28. pv_xavp_to_var(xname)
161
-        4.29. pv_evalx(dst, fmt)
155
+        4.21. xavp_lshift(xname, idx)
156
+        4.22. sbranch_set_ruri()
157
+        4.23. sbranch_append()
158
+        4.24. sbranch_reset()
159
+        4.25. pv_xavp_print()
160
+        4.26. pv_xavu_print()
161
+        4.27. pv_xavi_print()
162
+        4.28. pv_var_to_xavp(varname, xname)
163
+        4.29. pv_xavp_to_var(xname)
164
+        4.30. pv_evalx(dst, fmt)
162 165
 
163 166
    5. RPC Commands
164 167
 
... ...
@@ -274,15 +277,16 @@ modparam("pv","avp_aliases","email=s:email_addr;tmp=i:100")
274 277
    4.18. xavi_rm(rname)
275 278
    4.19. xavp_child_rm(rname, cname)
276 279
    4.20. xavi_child_rm(rname, cname)
277
-   4.21. sbranch_set_ruri()
278
-   4.22. sbranch_append()
279
-   4.23. sbranch_reset()
280
-   4.24. pv_xavp_print()
281
-   4.25. pv_xavu_print()
282
-   4.26. pv_xavi_print()
283
-   4.27. pv_var_to_xavp(varname, xname)
284
-   4.28. pv_xavp_to_var(xname)
285
-   4.29. pv_evalx(dst, fmt)
280
+   4.21. xavp_lshift(xname, idx)
281
+   4.22. sbranch_set_ruri()
282
+   4.23. sbranch_append()
283
+   4.24. sbranch_reset()
284
+   4.25. pv_xavp_print()
285
+   4.26. pv_xavu_print()
286
+   4.27. pv_xavi_print()
287
+   4.28. pv_var_to_xavp(varname, xname)
288
+   4.29. pv_xavp_to_var(xname)
289
+   4.30. pv_evalx(dst, fmt)
286 290
 
287 291
 4.1. pv_isset(pvar)
288 292
 
... ...
@@ -680,7 +684,29 @@ xavi_child_rm("WhatEver", "FoO");
680 684
 # same result as: $xavi(whatever=>foo) = $null;
681 685
 ...
682 686
 
683
-4.21.  sbranch_set_ruri()
687
+4.21.  xavp_lshift(xname, idx)
688
+
689
+   Left shift with rotation of the xavps with name xname so that the one
690
+   at the index idx becomes the first and the ones before it are at the
691
+   end of the list.
692
+
693
+   The first parameter has to be the name of XAVP in the root list. The
694
+   second parameter is the index of the XAVP that becomes the first one.
695
+
696
+   The parameters can be with variables.
697
+
698
+   Function can be used from ANY ROUTE.
699
+
700
+   Example 1.24. xavp_lshift usage
701
+...
702
+$xavp(n) = 10;
703
+$xavp(n) = 20;
704
+$xavp(n) = 30;
705
+xavp_lshift("n", "1");
706
+# results in: $xavp(n) having the list of values 20 30 10
707
+...
708
+
709
+4.22.  sbranch_set_ruri()
684 710
 
685 711
    Use the attributes from static branch ($sbranch(key) variable) to set
686 712
    request URI and the other fields of the branch associated with request
... ...
@@ -691,7 +717,7 @@ xavi_child_rm("WhatEver", "FoO");
691 717
 
692 718
    Function can be used from REQUEST_ROUTE, BRANCH_ROUTE or FAILURE_ROUTE.
693 719
 
694
-   Example 1.24. sbranch_set_ruri() usage
720
+   Example 1.25. sbranch_set_ruri() usage
695 721
 ...
696 722
 sbranch_reset();
697 723
 $sbranch(uri) = "sip:127.0.0.1:5080";
... ...
@@ -701,7 +727,7 @@ $sbranch(send_socket) =  "udp:127.0.0.1:5060";
701 727
 sbranch_set_ruri();
702 728
 ...
703 729
 
704
-4.22.  sbranch_append()
730
+4.23.  sbranch_append()
705 731
 
706 732
    Use the attributes from static branch ($sbranch(key) variable) to
707 733
    append a new branch to destination set. It is an alternative to
... ...
@@ -713,7 +739,7 @@ sbranch_set_ruri();
713 739
 
714 740
    Function can be used from REQUEST_ROUTE, BRANCH_ROUTE or FAILURE_ROUTE.
715 741
 
716
-   Example 1.25. sbranch_append() usage
742
+   Example 1.26. sbranch_append() usage
717 743
 ...
718 744
 sbranch_reset();
719 745
 $sbranch(uri) = "sip:127.0.0.1:5080";
... ...
@@ -722,51 +748,51 @@ $sbranch(send_socket) =  "udp:127.0.0.1:5060";
722 748
 sbranch_append();
723 749
 ...
724 750
 
725
-4.23.  sbranch_reset()
751
+4.24.  sbranch_reset()
726 752
 
727 753
    Reset the content of static branch ($sbranch(key) variable.
728 754
 
729 755
    Function can be used from REQUEST_ROUTE, BRANCH_ROUTE or FAILURE_ROUTE.
730 756
 
731
-   Example 1.26. sbranch_append() usage
757
+   Example 1.27. sbranch_append() usage
732 758
 ...
733 759
 sbranch_reset();
734 760
 ...
735 761
 
736
-4.24.  pv_xavp_print()
762
+4.25.  pv_xavp_print()
737 763
 
738 764
    Print all XAVPs to the syslog using INFO log level.
739 765
 
740 766
    Function can be used from ANY_ROUTE.
741 767
 
742
-   Example 1.27. pv_xavp_print() usage
768
+   Example 1.28. pv_xavp_print() usage
743 769
 ...
744 770
 pv_xavp_print();
745 771
 ...
746 772
 
747
-4.25.  pv_xavu_print()
773
+4.26.  pv_xavu_print()
748 774
 
749 775
    Print all XAVUs to the syslog using INFO log level.
750 776
 
751 777
    Function can be used from ANY_ROUTE.
752 778
 
753
-   Example 1.28. pv_xavu_print() usage
779
+   Example 1.29. pv_xavu_print() usage
754 780
 ...
755 781
 pv_xavu_print();
756 782
 ...
757 783
 
758
-4.26.  pv_xavi_print()
784
+4.27.  pv_xavi_print()
759 785
 
760 786
    Print all XAVIs to the syslog using INFO log level.
761 787
 
762 788
    Function can be used from ANY_ROUTE.
763 789
 
764
-   Example 1.29. pv_xavi_print() usage
790
+   Example 1.30. pv_xavi_print() usage
765 791
 ...
766 792
 pv_xavi_print();
767 793
 ...
768 794
 
769
-4.27.  pv_var_to_xavp(varname, xname)
795
+4.28.  pv_var_to_xavp(varname, xname)
770 796
 
771 797
    Copy the script variable value into an xavp.
772 798
 
... ...
@@ -778,7 +804,7 @@ pv_xavi_print();
778 804
 
779 805
    Function can be used from ANY_ROUTE.
780 806
 
781
-   Example 1.30. pv_var_to_xavp() usage
807
+   Example 1.31. pv_var_to_xavp() usage
782 808
 ...
783 809
 $var("temp") = 3;
784 810
 $var("foo") = "foo indeed";
... ...
@@ -792,7 +818,7 @@ $xavp("ok[0]=>temp") now is 3
792 818
 $xavp("ok[0]=>foo") now is "foo indeed"
793 819
 ...
794 820
 
795
-4.28.  pv_xavp_to_var(xname)
821
+4.29.  pv_xavp_to_var(xname)
796 822
 
797 823
    Copy xavp values into vars. Reverse of pv_var_to_xavp().
798 824
 
... ...
@@ -800,7 +826,7 @@ $xavp("ok[0]=>foo") now is "foo indeed"
800 826
 
801 827
    Function can be used from ANY_ROUTE.
802 828
 
803
-   Example 1.31. pv_xavp_to_var() usage
829
+   Example 1.32. pv_xavp_to_var() usage
804 830
 ...
805 831
 $xavp("bar=>temp") = 3;
806 832
 $xavp("bar[0]=>foo") = "foo indeed";
... ...
@@ -810,7 +836,7 @@ $var("temp") now is 3
810 836
 $var("foo") now is "foo indeed"
811 837
 ...
812 838
 
813
-4.29.  pv_evalx(dst, fmt)
839
+4.30.  pv_evalx(dst, fmt)
814 840
 
815 841
    The fmt string is evaluated twice for exiting variables, the result is
816 842
    stored in dst variable. The dst must be the name of a writable
... ...
@@ -819,7 +845,7 @@ $var("foo") now is "foo indeed"
819 845
 
820 846
    Function can be used from ANY_ROUTE.
821 847
 
822
-   Example 1.32. pv_xavp_to_var() usage
848
+   Example 1.33. pv_xavp_to_var() usage
823 849
 ...
824 850
 $var(x) = "test";
825 851
 $var(y) = "$var(x)"
... ...
@@ -844,7 +870,7 @@ pv_evalx("$var(z)", "$var(y) one");
844 870
           + “str”: string value
845 871
      * _value_: value to be set
846 872
 
847
-   Example 1.33. pv.shvSet usage
873
+   Example 1.34. pv.shvSet usage
848 874
 ...
849 875
 $ kamcmd pv.shvSet debug int 3
850 876
 ...
... ...
@@ -858,7 +884,7 @@ $ kamcmd pv.shvSet debug int 3
858 884
 
859 885
    If no name is given, all shared variables are listed.
860 886
 
861
-   Example 1.34. pv.shvGet usage
887
+   Example 1.35. pv.shvGet usage
862 888
 ...
863 889
 $ kamcmd pv.shvGet debug
864 890
 ...