Browse code

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

Kamailio Dev authored on 13/05/2022 14:16:25
Showing 1 changed files
... ...
@@ -59,15 +59,16 @@ Daniel-Constantin Mierla
59 59
               4.19. xavp_child_rm(rname, cname)
60 60
               4.20. xavi_child_rm(rname, cname)
61 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)
62
+              4.22. xavp_push_dst(xname)
63
+              4.23. sbranch_set_ruri()
64
+              4.24. sbranch_append()
65
+              4.25. sbranch_reset()
66
+              4.26. pv_xavp_print()
67
+              4.27. pv_xavu_print()
68
+              4.28. pv_xavi_print()
69
+              4.29. pv_var_to_xavp(varname, xname)
70
+              4.30. pv_xavp_to_var(xname)
71
+              4.31. pv_evalx(dst, fmt)
71 72
 
72 73
         5. RPC Commands
73 74
 
... ...
@@ -100,17 +101,18 @@ Daniel-Constantin Mierla
100 101
    1.22. xavp_child_rm usage
101 102
    1.23. xavi_child_rm usage
102 103
    1.24. xavp_lshift usage
103
-   1.25. sbranch_set_ruri() usage
104
-   1.26. sbranch_append() usage
104
+   1.25. xavp_push_dst usage
105
+   1.26. sbranch_set_ruri() usage
105 106
    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
110
-   1.32. pv_xavp_to_var() usage
107
+   1.28. sbranch_append() usage
108
+   1.29. pv_xavp_print() usage
109
+   1.30. pv_xavu_print() usage
110
+   1.31. pv_xavi_print() usage
111
+   1.32. pv_var_to_xavp() usage
111 112
    1.33. pv_xavp_to_var() usage
112
-   1.34. pv.shvSet usage
113
-   1.35. pv.shvGet usage
113
+   1.34. pv_xavp_to_var() usage
114
+   1.35. pv.shvSet usage
115
+   1.36. pv.shvGet usage
114 116
 
115 117
 Chapter 1. Admin Guide
116 118
 
... ...
@@ -153,15 +155,16 @@ Chapter 1. Admin Guide
153 155
         4.19. xavp_child_rm(rname, cname)
154 156
         4.20. xavi_child_rm(rname, cname)
155 157
         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)
158
+        4.22. xavp_push_dst(xname)
159
+        4.23. sbranch_set_ruri()
160
+        4.24. sbranch_append()
161
+        4.25. sbranch_reset()
162
+        4.26. pv_xavp_print()
163
+        4.27. pv_xavu_print()
164
+        4.28. pv_xavi_print()
165
+        4.29. pv_var_to_xavp(varname, xname)
166
+        4.30. pv_xavp_to_var(xname)
167
+        4.31. pv_evalx(dst, fmt)
165 168
 
166 169
    5. RPC Commands
167 170
 
... ...
@@ -278,15 +281,16 @@ modparam("pv","avp_aliases","email=s:email_addr;tmp=i:100")
278 281
    4.19. xavp_child_rm(rname, cname)
279 282
    4.20. xavi_child_rm(rname, cname)
280 283
    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)
284
+   4.22. xavp_push_dst(xname)
285
+   4.23. sbranch_set_ruri()
286
+   4.24. sbranch_append()
287
+   4.25. sbranch_reset()
288
+   4.26. pv_xavp_print()
289
+   4.27. pv_xavu_print()
290
+   4.28. pv_xavi_print()
291
+   4.29. pv_var_to_xavp(varname, xname)
292
+   4.30. pv_xavp_to_var(xname)
293
+   4.31. pv_evalx(dst, fmt)
290 294
 
291 295
 4.1. pv_isset(pvar)
292 296
 
... ...
@@ -706,7 +710,30 @@ xavp_lshift("n", "1");
706 710
 # results in: $xavp(n) having the list of values 20 30 10
707 711
 ...
708 712
 
709
-4.22.  sbranch_set_ruri()
713
+4.22.  xavp_push_dst(xname)
714
+
715
+   Set destination fields from XAVP attributes.
716
+
717
+   The first parameter has to be the name of XAVP in the root list.
718
+
719
+   The parameters can be with variables.
720
+
721
+   The attributes that can be stored in the XAVP fields:
722
+     * uri: SIP URI address to set R-URI
723
+     * dsturi: SIP URI address to set DST-URI
724
+     * socket: listen address to set outgoing socket
725
+
726
+   Function can be used from REQUEST_ROUTE|BRANCH_ROUTE|FAILURE_ROUTE.
727
+
728
+   Example 1.25. xavp_push_dst usage
729
+...
730
+$xavp(dst=>uri) = "sip:alice@server.com";
731
+$xavp(dst[0]=>dsturi) = "sip:proxy.com";
732
+$xavp(dst[0]=>socket) = "udp:1.2.3.4:5060";
733
+xavp_push_dst("dst");
734
+...
735
+
736
+4.23.  sbranch_set_ruri()
710 737
 
711 738
    Use the attributes from static branch ($sbranch(key) variable) to set
712 739
    request URI and the other fields of the branch associated with request
... ...
@@ -717,7 +744,7 @@ xavp_lshift("n", "1");
717 744
 
718 745
    Function can be used from REQUEST_ROUTE, BRANCH_ROUTE or FAILURE_ROUTE.
719 746
 
720
-   Example 1.25. sbranch_set_ruri() usage
747
+   Example 1.26. sbranch_set_ruri() usage
721 748
 ...
722 749
 sbranch_reset();
723 750
 $sbranch(uri) = "sip:127.0.0.1:5080";
... ...
@@ -727,7 +754,7 @@ $sbranch(send_socket) =  "udp:127.0.0.1:5060";
727 754
 sbranch_set_ruri();
728 755
 ...
729 756
 
730
-4.23.  sbranch_append()
757
+4.24.  sbranch_append()
731 758
 
732 759
    Use the attributes from static branch ($sbranch(key) variable) to
733 760
    append a new branch to destination set. It is an alternative to
... ...
@@ -739,7 +766,7 @@ sbranch_set_ruri();
739 766
 
740 767
    Function can be used from REQUEST_ROUTE, BRANCH_ROUTE or FAILURE_ROUTE.
741 768
 
742
-   Example 1.26. sbranch_append() usage
769
+   Example 1.27. sbranch_append() usage
743 770
 ...
744 771
 sbranch_reset();
745 772
 $sbranch(uri) = "sip:127.0.0.1:5080";
... ...
@@ -748,51 +775,51 @@ $sbranch(send_socket) =  "udp:127.0.0.1:5060";
748 775
 sbranch_append();
749 776
 ...
750 777
 
751
-4.24.  sbranch_reset()
778
+4.25.  sbranch_reset()
752 779
 
753 780
    Reset the content of static branch ($sbranch(key) variable.
754 781
 
755 782
    Function can be used from REQUEST_ROUTE, BRANCH_ROUTE or FAILURE_ROUTE.
756 783
 
757
-   Example 1.27. sbranch_append() usage
784
+   Example 1.28. sbranch_append() usage
758 785
 ...
759 786
 sbranch_reset();
760 787
 ...
761 788
 
762
-4.25.  pv_xavp_print()
789
+4.26.  pv_xavp_print()
763 790
 
764 791
    Print all XAVPs to the syslog using INFO log level.
765 792
 
766 793
    Function can be used from ANY_ROUTE.
767 794
 
768
-   Example 1.28. pv_xavp_print() usage
795
+   Example 1.29. pv_xavp_print() usage
769 796
 ...
770 797
 pv_xavp_print();
771 798
 ...
772 799
 
773
-4.26.  pv_xavu_print()
800
+4.27.  pv_xavu_print()
774 801
 
775 802
    Print all XAVUs to the syslog using INFO log level.
776 803
 
777 804
    Function can be used from ANY_ROUTE.
778 805
 
779
-   Example 1.29. pv_xavu_print() usage
806
+   Example 1.30. pv_xavu_print() usage
780 807
 ...
781 808
 pv_xavu_print();
782 809
 ...
783 810
 
784
-4.27.  pv_xavi_print()
811
+4.28.  pv_xavi_print()
785 812
 
786 813
    Print all XAVIs to the syslog using INFO log level.
787 814
 
788 815
    Function can be used from ANY_ROUTE.
789 816
 
790
-   Example 1.30. pv_xavi_print() usage
817
+   Example 1.31. pv_xavi_print() usage
791 818
 ...
792 819
 pv_xavi_print();
793 820
 ...
794 821
 
795
-4.28.  pv_var_to_xavp(varname, xname)
822
+4.29.  pv_var_to_xavp(varname, xname)
796 823
 
797 824
    Copy the script variable value into an xavp.
798 825
 
... ...
@@ -804,7 +831,7 @@ pv_xavi_print();
804 831
 
805 832
    Function can be used from ANY_ROUTE.
806 833
 
807
-   Example 1.31. pv_var_to_xavp() usage
834
+   Example 1.32. pv_var_to_xavp() usage
808 835
 ...
809 836
 $var("temp") = 3;
810 837
 $var("foo") = "foo indeed";
... ...
@@ -818,7 +845,7 @@ $xavp("ok[0]=>temp") now is 3
818 845
 $xavp("ok[0]=>foo") now is "foo indeed"
819 846
 ...
820 847
 
821
-4.29.  pv_xavp_to_var(xname)
848
+4.30.  pv_xavp_to_var(xname)
822 849
 
823 850
    Copy xavp values into vars. Reverse of pv_var_to_xavp().
824 851
 
... ...
@@ -826,7 +853,7 @@ $xavp("ok[0]=>foo") now is "foo indeed"
826 853
 
827 854
    Function can be used from ANY_ROUTE.
828 855
 
829
-   Example 1.32. pv_xavp_to_var() usage
856
+   Example 1.33. pv_xavp_to_var() usage
830 857
 ...
831 858
 $xavp("bar=>temp") = 3;
832 859
 $xavp("bar[0]=>foo") = "foo indeed";
... ...
@@ -836,7 +863,7 @@ $var("temp") now is 3
836 863
 $var("foo") now is "foo indeed"
837 864
 ...
838 865
 
839
-4.30.  pv_evalx(dst, fmt)
866
+4.31.  pv_evalx(dst, fmt)
840 867
 
841 868
    The fmt string is evaluated twice for exiting variables, the result is
842 869
    stored in dst variable. The dst must be the name of a writable
... ...
@@ -845,7 +872,7 @@ $var("foo") now is "foo indeed"
845 872
 
846 873
    Function can be used from ANY_ROUTE.
847 874
 
848
-   Example 1.33. pv_xavp_to_var() usage
875
+   Example 1.34. pv_xavp_to_var() usage
849 876
 ...
850 877
 $var(x) = "test";
851 878
 $var(y) = "$var(x)"
... ...
@@ -870,7 +897,7 @@ pv_evalx("$var(z)", "$var(y) one");
870 897
           + “str”: string value
871 898
      * _value_: value to be set
872 899
 
873
-   Example 1.34. pv.shvSet usage
900
+   Example 1.35. pv.shvSet usage
874 901
 ...
875 902
 $ kamcmd pv.shvSet debug int 3
876 903
 ...
... ...
@@ -884,7 +911,7 @@ $ kamcmd pv.shvSet debug int 3
884 911
 
885 912
    If no name is given, all shared variables are listed.
886 913
 
887
-   Example 1.35. pv.shvGet usage
914
+   Example 1.36. pv.shvGet usage
888 915
 ...
889 916
 $ kamcmd pv.shvGet debug
890 917
 ...