Browse code

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

Kamailio Dev authored on 25/07/2022 18:31:13
Showing 1 changed files
... ...
@@ -1016,7 +1016,7 @@ if (is_supported("outbound")) { ... }
1016 1016
 ...
1017 1017
 if(is_first_hop()) { ... }
1018 1018
 ...
1019
-if(is_first_hop_mode("1")) { ... }
1019
+if(is_first_hop("1")) { ... }
1020 1020
 ...
1021 1021
 
1022 1022
 4.34.  sip_p_charging_vector(flags)
Browse code

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

Kamailio Dev authored on 14/06/2022 08:31:17
Showing 1 changed files
... ...
@@ -60,6 +60,7 @@ Gabriel Vasile
60 60
               3.6. rpid_prefix (string)
61 61
               3.7. rpid_suffix (string)
62 62
               3.8. rpid_avp (string)
63
+              3.9. e164_max_len (int)
63 64
 
64 65
         4. Functions
65 66
 
... ...
@@ -121,45 +122,46 @@ Gabriel Vasile
121 122
    1.6. rpid_prefix parameter example
122 123
    1.7. rpid_suffix parameter example
123 124
    1.8. rpid_avp parameter example
124
-   1.9. options_reply usage
125
-   1.10. is_user usage
126
-   1.11. has_totag usage
127
-   1.12. uri_param usage
125
+   1.9. e164_max_len parameter example
126
+   1.10. options_reply usage
127
+   1.11. is_user usage
128
+   1.12. has_totag usage
128 129
    1.13. uri_param usage
129
-   1.14. uri_param_any usage
130
-   1.15. add_uri_param usage
130
+   1.14. uri_param usage
131
+   1.15. uri_param_any usage
131 132
    1.16. add_uri_param usage
132
-   1.17. uri_param_rm usage
133
-   1.18. tel2sip usage
134
-   1.19. is_e164 usage
135
-   1.20. is_uri_user_e164 usage
136
-   1.21. is_uri usage
137
-   1.22. is_tel_number usage
138
-   1.23. is_numeric usage
139
-   1.24. is_alphanum usage
140
-   1.25. is_alphanumex usage
141
-   1.26. encode_contact usage
142
-   1.27. decode_contact usage
143
-   1.28. decode_contact_header usage
144
-   1.29. cmp_uri usage
145
-   1.30. cmp_aor usage
146
-   1.31. cmp_hdr_name usage
147
-   1.32. append_rpid_hf usage
148
-   1.33. append_rpid_hf(prefix, suffix) usage
149
-   1.34. is_rpid_user_e164 usage
150
-   1.35. set_uri_user usage
151
-   1.36. set_uri_host usage
152
-   1.37. is_request usage
153
-   1.38. is_reply usage
154
-   1.39. is_gruu() usage
155
-   1.40. is_supported() usage
156
-   1.41. is_first_hop() usage
157
-   1.42. sip_p_charging_vector() usage
158
-   1.43. contact_param_encode usage
159
-   1.44. contact_param_decode usage
160
-   1.45. contact_param_decode_ruri usage
161
-   1.46. contact_param_rm usage
162
-   1.47. hdr_date_check usage
133
+   1.17. add_uri_param usage
134
+   1.18. uri_param_rm usage
135
+   1.19. tel2sip usage
136
+   1.20. is_e164 usage
137
+   1.21. is_uri_user_e164 usage
138
+   1.22. is_uri usage
139
+   1.23. is_tel_number usage
140
+   1.24. is_numeric usage
141
+   1.25. is_alphanum usage
142
+   1.26. is_alphanumex usage
143
+   1.27. encode_contact usage
144
+   1.28. decode_contact usage
145
+   1.29. decode_contact_header usage
146
+   1.30. cmp_uri usage
147
+   1.31. cmp_aor usage
148
+   1.32. cmp_hdr_name usage
149
+   1.33. append_rpid_hf usage
150
+   1.34. append_rpid_hf(prefix, suffix) usage
151
+   1.35. is_rpid_user_e164 usage
152
+   1.36. set_uri_user usage
153
+   1.37. set_uri_host usage
154
+   1.38. is_request usage
155
+   1.39. is_reply usage
156
+   1.40. is_gruu() usage
157
+   1.41. is_supported() usage
158
+   1.42. is_first_hop() usage
159
+   1.43. sip_p_charging_vector() usage
160
+   1.44. contact_param_encode usage
161
+   1.45. contact_param_decode usage
162
+   1.46. contact_param_decode_ruri usage
163
+   1.47. contact_param_rm usage
164
+   1.48. hdr_date_check usage
163 165
 
164 166
 Chapter 1. Admin Guide
165 167
 
... ...
@@ -181,6 +183,7 @@ Chapter 1. Admin Guide
181 183
         3.6. rpid_prefix (string)
182 184
         3.7. rpid_suffix (string)
183 185
         3.8. rpid_avp (string)
186
+        3.9. e164_max_len (int)
184 187
 
185 188
    4. Functions
186 189
 
... ...
@@ -273,6 +276,7 @@ Chapter 1. Admin Guide
273 276
    3.6. rpid_prefix (string)
274 277
    3.7. rpid_suffix (string)
275 278
    3.8. rpid_avp (string)
279
+   3.9. e164_max_len (int)
276 280
 
277 281
 3.1. options_accept (string)
278 282
 
... ...
@@ -358,7 +362,7 @@ modparam("siputils", "options_support", "100rel")
358 362
    Default value is “”.
359 363
 
360 364
    Example 1.6. rpid_prefix parameter example
361
-modparam("auth", "rpid_prefix", "Whatever <")
365
+modparam("siputils", "rpid_prefix", "Whatever <")
362 366
 
363 367
 3.7. rpid_suffix (string)
364 368
 
... ...
@@ -368,7 +372,7 @@ modparam("auth", "rpid_prefix", "Whatever <")
368 372
    Default value is “;party=calling;id-type=subscriber;screen=yes”.
369 373
 
370 374
    Example 1.7. rpid_suffix parameter example
371
-modparam("auth", "rpid_suffix", "@1.2.3.4>")
375
+modparam("siputils", "rpid_suffix", "@1.2.3.4>")
372 376
 
373 377
 3.8. rpid_avp (string)
374 378
 
... ...
@@ -382,7 +386,17 @@ modparam("auth", "rpid_suffix", "@1.2.3.4>")
382 386
    Default value is “$avp(s:rpid)”.
383 387
 
384 388
    Example 1.8. rpid_avp parameter example
385
-modparam("auth", "rpid_avp", "$avp(myrpid)")
389
+modparam("siputils", "rpid_avp", "$avp(myrpid)")
390
+
391
+3.9. e164_max_len (int)
392
+
393
+   The maximum length for checking e164 numbers, including the leading
394
+   '+'.
395
+
396
+   Default value is “16”.
397
+
398
+   Example 1.9. e164_max_len parameter example
399
+modparam("siputils", "e164_max_len", 20)
386 400
 
387 401
 4. Functions
388 402
 
... ...
@@ -445,7 +459,7 @@ modparam("auth", "rpid_avp", "$avp(myrpid)")
445 459
 
446 460
    This function can be used from REQUEST_ROUTE.
447 461
 
448
-   Example 1.9. options_reply usage
462
+   Example 1.10. options_reply usage
449 463
 ...
450 464
 if (uri==myself) {
451 465
         if ((method==OPTIONS) && (! uri=~"sip:.*[@]+.*")) {
... ...
@@ -463,7 +477,7 @@ if (uri==myself) {
463 477
 
464 478
    This function can be used from REQUEST_ROUTE.
465 479
 
466
-   Example 1.10. is_user usage
480
+   Example 1.11. is_user usage
467 481
 ...
468 482
 if (is_user("john")) {
469 483
         ...
... ...
@@ -476,7 +490,7 @@ if (is_user("john")) {
476 490
 
477 491
    This function can be used from ANY_ROUTE.
478 492
 
479
-   Example 1.11. has_totag usage
493
+   Example 1.12. has_totag usage
480 494
 ...
481 495
 if (has_totag()) {
482 496
         ...
... ...
@@ -492,7 +506,7 @@ if (has_totag()) {
492 506
 
493 507
    This function can be used from REQUEST_ROUTE.
494 508
 
495
-   Example 1.12. uri_param usage
509
+   Example 1.13. uri_param usage
496 510
 ...
497 511
 if (uri_param("param1")) {
498 512
         ...
... ...
@@ -509,7 +523,7 @@ if (uri_param("param1")) {
509 523
 
510 524
    This function can be used from REQUEST_ROUTE.
511 525
 
512
-   Example 1.13. uri_param usage
526
+   Example 1.14. uri_param usage
513 527
 ...
514 528
 if (uri_param("param1","value1")) {
515 529
         ...
... ...
@@ -525,7 +539,7 @@ if (uri_param("param1","value1")) {
525 539
 
526 540
    This function can be used from REQUEST_ROUTE.
527 541
 
528
-   Example 1.14. uri_param_any usage
542
+   Example 1.15. uri_param_any usage
529 543
 ...
530 544
 if (uri_param_any("param1")) {
531 545
         ...
... ...
@@ -541,7 +555,7 @@ if (uri_param_any("param1")) {
541 555
 
542 556
    This function can be used from REQUEST_ROUTE.
543 557
 
544
-   Example 1.15. add_uri_param usage
558
+   Example 1.16. add_uri_param usage
545 559
 ...
546 560
 add_uri_param("nat=yes");
547 561
 ...
... ...
@@ -556,7 +570,7 @@ add_uri_param("nat=yes");
556 570
 
557 571
    This function can be used from REQUEST_ROUTE.
558 572
 
559
-   Example 1.16. add_uri_param usage
573
+   Example 1.17. add_uri_param usage
560 574
 ...
561 575
 get_uri_param("nat", "$var(nat)");
562 576
 ...
... ...
@@ -570,7 +584,7 @@ get_uri_param("nat", "$var(nat)");
570 584
 
571 585
    This function can be used from REQUEST_ROUTE.
572 586
 
573
-   Example 1.17. uri_param_rm usage
587
+   Example 1.18. uri_param_rm usage
574 588
 ...
575 589
 if (uri_param_rm("param1")) {
576 590
         ...
... ...
@@ -596,7 +610,7 @@ if (uri_param_rm("param1")) {
596 610
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
597 611
    BRANCH_ROUTE, or ONREPLY_ROUTE.
598 612
 
599
-   Example 1.18. tel2sip usage
613
+   Example 1.19. tel2sip usage
600 614
 ...
601 615
 # $ru: tel:+(34)-999-888-777
602 616
 # $fu: sip:test@foo.com
... ...
@@ -616,7 +630,7 @@ tel2sip("$ru", $fd", "$ru");
616 630
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE, and
617 631
    LOCAL_ROUTE.
618 632
 
619
-   Example 1.19. is_e164 usage
633
+   Example 1.20. is_e164 usage
620 634
 ...
621 635
 if (is_e164("$fU")) {  # Check From header URI user part
622 636
    ...
... ...
@@ -633,7 +647,7 @@ if (is_e164("$avp(i:705)") {
633 647
 
634 648
    This function can be used from ANY_ROUTE.
635 649
 
636
-   Example 1.20. is_uri_user_e164 usage
650
+   Example 1.21. is_uri_user_e164 usage
637 651
 ...
638 652
 if (is_uri_user_e164("$fu")) {  # Check From header URI user part
639 653
    ...
... ...
@@ -650,7 +664,7 @@ if (is_uri_user_e164("$avp(i:705)") {
650 664
 
651 665
    This function can be used from ANY_ROUTE.
652 666
 
653
-   Example 1.21. is_uri usage
667
+   Example 1.22. is_uri usage
654 668
 ...
655 669
 if (is_uri("$var(x)")) {  # Check if variable contains a uri
656 670
    ...
... ...
@@ -668,7 +682,7 @@ if (is_uri("$avp(i:705)") {
668 682
 
669 683
    This function can be used from ANY_ROUTE.
670 684
 
671
-   Example 1.22. is_tel_number usage
685
+   Example 1.23. is_tel_number usage
672 686
 ...
673 687
 if (is_tel_number("$rU")) {  # Test if R-URI user is telephone number
674 688
    ...
... ...
@@ -685,7 +699,7 @@ if (is_tel_number("+24242424")) {
685 699
 
686 700
    This function can be used from ANY_ROUTE.
687 701
 
688
-   Example 1.23. is_numeric usage
702
+   Example 1.24. is_numeric usage
689 703
 ...
690 704
 if (is_numeric("$rU")) {  # Test if R-URI user consists of decimal digits
691 705
    ...
... ...
@@ -699,7 +713,7 @@ if (is_numeric("$rU")) {  # Test if R-URI user consists of decimal digits
699 713
 
700 714
    This function can be used from ANY_ROUTE.
701 715
 
702
-   Example 1.24. is_alphanum usage
716
+   Example 1.25. is_alphanum usage
703 717
 ...
704 718
 if (is_alphanum("$rU")) {
705 719
    ...
... ...
@@ -714,7 +728,7 @@ if (is_alphanum("$rU")) {
714 728
 
715 729
    This function can be used from ANY_ROUTE.
716 730
 
717
-   Example 1.25. is_alphanumex usage
731
+   Example 1.26. is_alphanumex usage
718 732
 ...
719 733
 if (is_alphanumex("$rU", "+.-_")) {
720 734
    ...
... ...
@@ -743,7 +757,7 @@ if (is_alphanumex("$rU", "+.-_")) {
743 757
 
744 758
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE.
745 759
 
746
-   Example 1.26. encode_contact usage
760
+   Example 1.27. encode_contact usage
747 761
 ...
748 762
 if (src_ip == 10.0.0.0/8) encode_contact("natted_client","1.2.3.4");
749 763
 ...
... ...
@@ -761,7 +775,7 @@ if (src_ip == 10.0.0.0/8) encode_contact("natted_client","1.2.3.4");
761 775
 
762 776
    This function can be used from REQUEST_ROUTE.
763 777
 
764
-   Example 1.27. decode_contact usage
778
+   Example 1.28. decode_contact usage
765 779
 ...
766 780
 if (uri =~ "^sip:natted_client") { decode_contact(); }
767 781
 ...
... ...
@@ -779,7 +793,7 @@ if (uri =~ "^sip:natted_client") { decode_contact(); }
779 793
 
780 794
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE.
781 795
 
782
-   Example 1.28. decode_contact_header usage
796
+   Example 1.29. decode_contact_header usage
783 797
 ...
784 798
 reply_route[2] {
785 799
         ...
... ...
@@ -794,7 +808,7 @@ reply_route[2] {
794 808
 
795 809
    This function can be used from ANY_ROUTE.
796 810
 
797
-   Example 1.29. cmp_uri usage
811
+   Example 1.30. cmp_uri usage
798 812
 ...
799 813
 if(cmp_uri("$ru", "sip:kamailio@kamailio.org"))
800 814
 {
... ...
@@ -809,7 +823,7 @@ if(cmp_uri("$ru", "sip:kamailio@kamailio.org"))
809 823
 
810 824
    This function can be used from ANY_ROUTE.
811 825
 
812
-   Example 1.30. cmp_aor usage
826
+   Example 1.31. cmp_aor usage
813 827
 ...
814 828
 if(cmp_aor("$rU@KaMaIlIo.org", "sip:kamailio@$fd"))
815 829
 {
... ...
@@ -824,7 +838,7 @@ if(cmp_aor("$rU@KaMaIlIo.org", "sip:kamailio@$fd"))
824 838
 
825 839
    This function can be used from ANY_ROUTE.
826 840
 
827
-   Example 1.31. cmp_hdr_name usage
841
+   Example 1.32. cmp_hdr_name usage
828 842
 ...
829 843
 if(cmp_hdr_name("$var(hname)", "From"))
830 844
 {
... ...
@@ -843,7 +857,7 @@ if(cmp_hdr_name("$var(hname)", "From"))
843 857
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
844 858
    BRANCH_ROUTE.
845 859
 
846
-   Example 1.32. append_rpid_hf usage
860
+   Example 1.33. append_rpid_hf usage
847 861
 ...
848 862
 append_rpid_hf();  # Append Remote-Party-ID header field
849 863
 ...
... ...
@@ -867,7 +881,7 @@ append_rpid_hf();  # Append Remote-Party-ID header field
867 881
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
868 882
    BRANCH_ROUTE.
869 883
 
870
-   Example 1.33. append_rpid_hf(prefix, suffix) usage
884
+   Example 1.34. append_rpid_hf(prefix, suffix) usage
871 885
 ...
872 886
 # Append Remote-Party-ID header field
873 887
 append_rpid_hf("", ";party=calling;id-type=subscriber;screen=yes");
... ...
@@ -883,7 +897,7 @@ append_rpid_hf("", ";party=calling;id-type=subscriber;screen=yes");
883 897
 
884 898
    This function can be used from REQUEST_ROUTE.
885 899
 
886
-   Example 1.34. is_rpid_user_e164 usage
900
+   Example 1.35. is_rpid_user_e164 usage
887 901
 ...
888 902
 if (is_rpid_user_e164()) {
889 903
     # do something here
... ...
@@ -897,7 +911,7 @@ if (is_rpid_user_e164()) {
897 911
 
898 912
    This function can be used from ANY_ROUTE.
899 913
 
900
-   Example 1.35. set_uri_user usage
914
+   Example 1.36. set_uri_user usage
901 915
 ...
902 916
 $var(uri) = "sip:user@host";
903 917
 $var(user) = "new_user";
... ...
@@ -911,7 +925,7 @@ set_uri_user("$var(uri)", "$var(user)");
911 925
 
912 926
    This function can be used from ANY_ROUTE.
913 927
 
914
-   Example 1.36. set_uri_host usage
928
+   Example 1.37. set_uri_host usage
915 929
 ...
916 930
 $var(uri) = "sip:user@host";
917 931
 $var(host) = "new_host";
... ...
@@ -924,7 +938,7 @@ set_uri_host("$var(uri)", "$var(host)");
924 938
 
925 939
    This function can be used from ANY_ROUTE.
926 940
 
927
-   Example 1.37. is_request usage
941
+   Example 1.38. is_request usage
928 942
 ...
929 943
 if (is_request()) {
930 944
         ...
... ...
@@ -937,7 +951,7 @@ if (is_request()) {
937 951
 
938 952
    This function can be used from ANY_ROUTE.
939 953
 
940
-   Example 1.38. is_reply usage
954
+   Example 1.39. is_reply usage
941 955
 ...
942 956
 if (is_reply()) {
943 957
         ...
... ...
@@ -955,7 +969,7 @@ if (is_reply()) {
955 969
 
956 970
    This function can be used from ANY_ROUTE.
957 971
 
958
-   Example 1.39. is_gruu() usage
972
+   Example 1.40. is_gruu() usage
959 973
 ...
960 974
 if(is_gruu()) { ... }
961 975
 ...
... ...
@@ -968,7 +982,7 @@ if(is_gruu()) { ... }
968 982
 
969 983
    This function can be used from ANY_ROUTE.
970 984
 
971
-   Example 1.40. is_supported() usage
985
+   Example 1.41. is_supported() usage
972 986
 ...
973 987
 if (is_supported("outbound")) { ... }
974 988
 ...
... ...
@@ -998,7 +1012,7 @@ if (is_supported("outbound")) { ... }
998 1012
 
999 1013
    This function can be used from ANY_ROUTE.
1000 1014
 
1001
-   Example 1.41. is_first_hop() usage
1015
+   Example 1.42. is_first_hop() usage
1002 1016
 ...
1003 1017
 if(is_first_hop()) { ... }
1004 1018
 ...
... ...
@@ -1012,7 +1026,7 @@ if(is_first_hop_mode("1")) { ... }
1012 1026
 
1013 1027
    This function can be used from ANY_ROUTE.
1014 1028
 
1015
-   Example 1.42. sip_p_charging_vector() usage
1029
+   Example 1.43. sip_p_charging_vector() usage
1016 1030
 ...
1017 1031
 sip_p_charging_vector("g");
1018 1032
 ...
... ...
@@ -1030,7 +1044,7 @@ sip_p_charging_vector("g");
1030 1044
 
1031 1045
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE.
1032 1046
 
1033
-   Example 1.43. contact_param_encode usage
1047
+   Example 1.44. contact_param_encode usage
1034 1048
 ...
1035 1049
 if (is_method("REGISTER") and src_ip == 10.0.0.0/8) {
1036 1050
     contact_param_encode("ksu", "sip:1.2.3.4:5060;transport=tcp");
... ...
@@ -1048,7 +1062,7 @@ if (is_method("REGISTER") and src_ip == 10.0.0.0/8) {
1048 1062
 
1049 1063
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE.
1050 1064
 
1051
-   Example 1.44. contact_param_decode usage
1065
+   Example 1.45. contact_param_decode usage
1052 1066
 ...
1053 1067
 if (is_method("REGISTER") and src_ip == 1.2.3.4) {
1054 1068
     contact_param_decode("ksu");
... ...
@@ -1066,7 +1080,7 @@ if (is_method("REGISTER") and src_ip == 1.2.3.4) {
1066 1080
 
1067 1081
    This function can be used from REQUEST_ROUTE.
1068 1082
 
1069
-   Example 1.45. contact_param_decode_ruri usage
1083
+   Example 1.46. contact_param_decode_ruri usage
1070 1084
 ...
1071 1085
 if (is_method("INVITE") and src_ip == 1.2.3.4) {
1072 1086
     contact_param_decode_ruri("ksu");
... ...
@@ -1083,7 +1097,7 @@ if (is_method("INVITE") and src_ip == 1.2.3.4) {
1083 1097
 
1084 1098
    This function can be used from REQUEST_ROUTE, ONREPLY_ROUTE.
1085 1099
 
1086
-   Example 1.46. contact_param_rm usage
1100
+   Example 1.47. contact_param_rm usage
1087 1101
 ...
1088 1102
 if (is_method("REGISTER") and src_ip == 1.2.3.4) {
1089 1103
     contact_param_rm("myparam");
... ...
@@ -1101,7 +1115,7 @@ if (is_method("REGISTER") and src_ip == 1.2.3.4) {
1101 1115
 
1102 1116
    This function can be used from ANY_ROUTE.
1103 1117
 
1104
-   Example 1.47. hdr_date_check usage
1118
+   Example 1.48. hdr_date_check usage
1105 1119
 ...
1106 1120
 if (!hdr_date_check("10")) {
1107 1121
     sl_send_reply("403", "Outdated date");
Browse code

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

Kamailio Dev authored on 10/01/2022 14:01:23
Showing 1 changed files
... ...
@@ -52,58 +52,56 @@ Gabriel Vasile
52 52
 
53 53
         3. Parameters
54 54
 
55
-              3.1. ring_timeout (int)
56
-              3.2. options_accept (string)
57
-              3.3. options_accept_encoding (string)
58
-              3.4. contact_flds_separator (string)
59
-              3.5. options_accept_language (string)
60
-              3.6. options_support (string)
61
-              3.7. rpid_prefix (string)
62
-              3.8. rpid_suffix (string)
63
-              3.9. rpid_avp (string)
55
+              3.1. options_accept (string)
56
+              3.2. options_accept_encoding (string)
57
+              3.3. contact_flds_separator (string)
58
+              3.4. options_accept_language (string)
59
+              3.5. options_support (string)
60
+              3.6. rpid_prefix (string)
61
+              3.7. rpid_suffix (string)
62
+              3.8. rpid_avp (string)
64 63
 
65 64
         4. Functions
66 65
 
67
-              4.1. ring_insert_callid()
68
-              4.2. options_reply()
69
-              4.3. is_user(username)
70
-              4.4. has_totag()
71
-              4.5. uri_param(param)
72
-              4.6. uri_param(param,value)
73
-              4.7. uri_param_any(param)
74
-              4.8. add_uri_param(param)
75
-              4.9. get_uri_param(name, var)
76
-              4.10. uri_param_rm(param)
77
-              4.11. tel2sip(uri, hostpart, result)
78
-              4.12. is_e164(pseudo-variable)
79
-              4.13. is_uri_user_e164(pseudo-variable)
80
-              4.14. is_uri(pseudo-variable)
81
-              4.15. is_tel_number(tval)
82
-              4.16. is_numeric(tval)
83
-              4.17. is_alphanum(tval)
84
-              4.18. is_alphanumex(tval, eset)
85
-              4.19. encode_contact(encoding_prefix,hostpart)
86
-              4.20. decode_contact()
87
-              4.21. decode_contact_header()
88
-              4.22. cmp_uri(str1, str2)
89
-              4.23. cmp_aor(str1, str2)
90
-              4.24. cmp_hdr_name(str1, str2)
91
-              4.25. append_rpid_hf()
92
-              4.26. append_rpid_hf(prefix, suffix)
93
-              4.27. is_rpid_user_e164()
94
-              4.28. set_uri_user(uri, user)
95
-              4.29. set_uri_host(uri, host)
96
-              4.30. is_request()
97
-              4.31. is_reply()
98
-              4.32. is_gruu([uri])
99
-              4.33. is_supported(option)
100
-              4.34. is_first_hop([mode])
101
-              4.35. sip_p_charging_vector(flags)
102
-              4.36. contact_param_encode(pname, saddr)
103
-              4.37. contact_param_decode(pname)
104
-              4.38. contact_param_decode_uri(pname)
105
-              4.39. contact_param_rm(pname)
106
-              4.40. hdr_date_check(tdiff)
66
+              4.1. options_reply()
67
+              4.2. is_user(username)
68
+              4.3. has_totag()
69
+              4.4. uri_param(param)
70
+              4.5. uri_param(param,value)
71
+              4.6. uri_param_any(param)
72
+              4.7. add_uri_param(param)
73
+              4.8. get_uri_param(name, var)
74
+              4.9. uri_param_rm(param)
75
+              4.10. tel2sip(uri, hostpart, result)
76
+              4.11. is_e164(pseudo-variable)
77
+              4.12. is_uri_user_e164(pseudo-variable)
78
+              4.13. is_uri(pseudo-variable)
79
+              4.14. is_tel_number(tval)
80
+              4.15. is_numeric(tval)
81
+              4.16. is_alphanum(tval)
82
+              4.17. is_alphanumex(tval, eset)
83
+              4.18. encode_contact(encoding_prefix,hostpart)
84
+              4.19. decode_contact()
85
+              4.20. decode_contact_header()
86
+              4.21. cmp_uri(str1, str2)
87
+              4.22. cmp_aor(str1, str2)
88
+              4.23. cmp_hdr_name(str1, str2)
89
+              4.24. append_rpid_hf()
90
+              4.25. append_rpid_hf(prefix, suffix)
91
+              4.26. is_rpid_user_e164()
92
+              4.27. set_uri_user(uri, user)
93
+              4.28. set_uri_host(uri, host)
94
+              4.29. is_request()
95
+              4.30. is_reply()
96
+              4.31. is_gruu([uri])
97
+              4.32. is_supported(option)
98
+              4.33. is_first_hop([mode])
99
+              4.34. sip_p_charging_vector(flags)
100
+              4.35. contact_param_encode(pname, saddr)
101
+              4.36. contact_param_decode(pname)
102
+              4.37. contact_param_decode_uri(pname)
103
+              4.38. contact_param_rm(pname)
104
+              4.39. hdr_date_check(tdiff)
107 105
 
108 106
         5. Exported pseudo-variables
109 107
 
... ...
@@ -115,55 +113,53 @@ Gabriel Vasile
115 113
 
116 114
    List of Examples
117 115
 
118
-   1.1. Set ring_timeout parameter
119
-   1.2. Set options_accept parameter
120
-   1.3. Set options_accept_encoding parameter
121
-   1.4. Set contact_flds_separator parameter
122
-   1.5. Set options_accept_language parameter
123
-   1.6. Set options_support parameter
124
-   1.7. rpid_prefix parameter example
125
-   1.8. rpid_suffix parameter example
126
-   1.9. rpid_avp parameter example
127
-   1.10. ring_insert_callid() usage
128
-   1.11. options_reply usage
129
-   1.12. is_user usage
130
-   1.13. has_totag usage
131
-   1.14. uri_param usage
132
-   1.15. uri_param usage
133
-   1.16. uri_param_any usage
134
-   1.17. add_uri_param usage
135
-   1.18. add_uri_param usage
136
-   1.19. uri_param_rm usage
137
-   1.20. tel2sip usage
138
-   1.21. is_e164 usage
139
-   1.22. is_uri_user_e164 usage
140
-   1.23. is_uri usage
141
-   1.24. is_tel_number usage
142
-   1.25. is_numeric usage
143
-   1.26. is_alphanum usage
144
-   1.27. is_alphanumex usage
145
-   1.28. encode_contact usage
146
-   1.29. decode_contact usage
147
-   1.30. decode_contact_header usage
148
-   1.31. cmp_uri usage
149
-   1.32. cmp_aor usage
150
-   1.33. cmp_hdr_name usage
151
-   1.34. append_rpid_hf usage
152
-   1.35. append_rpid_hf(prefix, suffix) usage
153
-   1.36. is_rpid_user_e164 usage
154
-   1.37. set_uri_user usage
155
-   1.38. set_uri_host usage
156
-   1.39. is_request usage
157
-   1.40. is_reply usage
158
-   1.41. is_gruu() usage
159
-   1.42. is_supported() usage
160
-   1.43. is_first_hop() usage
161
-   1.44. sip_p_charging_vector() usage
162
-   1.45. contact_param_encode usage
163
-   1.46. contact_param_decode usage
164
-   1.47. contact_param_decode_ruri usage
165
-   1.48. contact_param_rm usage
166
-   1.49. hdr_date_check usage
116
+   1.1. Set options_accept parameter
117
+   1.2. Set options_accept_encoding parameter
118
+   1.3. Set contact_flds_separator parameter
119
+   1.4. Set options_accept_language parameter
120
+   1.5. Set options_support parameter
121
+   1.6. rpid_prefix parameter example
122
+   1.7. rpid_suffix parameter example
123
+   1.8. rpid_avp parameter example
124
+   1.9. options_reply usage
125
+   1.10. is_user usage
126
+   1.11. has_totag usage
127
+   1.12. uri_param usage
128
+   1.13. uri_param usage
129
+   1.14. uri_param_any usage
130
+   1.15. add_uri_param usage
131
+   1.16. add_uri_param usage
132
+   1.17. uri_param_rm usage
133
+   1.18. tel2sip usage
134
+   1.19. is_e164 usage
135
+   1.20. is_uri_user_e164 usage
136
+   1.21. is_uri usage
137
+   1.22. is_tel_number usage
138
+   1.23. is_numeric usage
139
+   1.24. is_alphanum usage
140
+   1.25. is_alphanumex usage
141
+   1.26. encode_contact usage
142
+   1.27. decode_contact usage
143
+   1.28. decode_contact_header usage
144
+   1.29. cmp_uri usage
145
+   1.30. cmp_aor usage
146
+   1.31. cmp_hdr_name usage
147
+   1.32. append_rpid_hf usage
148
+   1.33. append_rpid_hf(prefix, suffix) usage
149
+   1.34. is_rpid_user_e164 usage
150
+   1.35. set_uri_user usage
151
+   1.36. set_uri_host usage
152
+   1.37. is_request usage
153
+   1.38. is_reply usage
154
+   1.39. is_gruu() usage
155
+   1.40. is_supported() usage
156
+   1.41. is_first_hop() usage
157
+   1.42. sip_p_charging_vector() usage
158
+   1.43. contact_param_encode usage
159
+   1.44. contact_param_decode usage
160
+   1.45. contact_param_decode_ruri usage
161
+   1.46. contact_param_rm usage
162
+   1.47. hdr_date_check usage
167 163
 
168 164
 Chapter 1. Admin Guide
169 165
 
... ...
@@ -177,58 +173,56 @@ Chapter 1. Admin Guide
177 173
 
178 174
    3. Parameters
179 175
 
180
-        3.1. ring_timeout (int)
181
-        3.2. options_accept (string)
182
-        3.3. options_accept_encoding (string)
183
-        3.4. contact_flds_separator (string)
184
-        3.5. options_accept_language (string)
185
-        3.6. options_support (string)
186
-        3.7. rpid_prefix (string)
187
-        3.8. rpid_suffix (string)
188
-        3.9. rpid_avp (string)
176
+        3.1. options_accept (string)
177
+        3.2. options_accept_encoding (string)
178
+        3.3. contact_flds_separator (string)
179
+        3.4. options_accept_language (string)
180
+        3.5. options_support (string)
181
+        3.6. rpid_prefix (string)
182
+        3.7. rpid_suffix (string)
183
+        3.8. rpid_avp (string)
189 184
 
190 185
    4. Functions
191 186
 
192
-        4.1. ring_insert_callid()
193
-        4.2. options_reply()
194
-        4.3. is_user(username)
195
-        4.4. has_totag()
196
-        4.5. uri_param(param)
197
-        4.6. uri_param(param,value)
198
-        4.7. uri_param_any(param)
199
-        4.8. add_uri_param(param)
200
-        4.9. get_uri_param(name, var)
201
-        4.10. uri_param_rm(param)
202
-        4.11. tel2sip(uri, hostpart, result)
203
-        4.12. is_e164(pseudo-variable)
204
-        4.13. is_uri_user_e164(pseudo-variable)
205
-        4.14. is_uri(pseudo-variable)
206
-        4.15. is_tel_number(tval)
207
-        4.16. is_numeric(tval)
208
-        4.17. is_alphanum(tval)
209
-        4.18. is_alphanumex(tval, eset)
210
-        4.19. encode_contact(encoding_prefix,hostpart)
211
-        4.20. decode_contact()
212
-        4.21. decode_contact_header()
213
-        4.22. cmp_uri(str1, str2)
214
-        4.23. cmp_aor(str1, str2)
215
-        4.24. cmp_hdr_name(str1, str2)
216
-        4.25. append_rpid_hf()
217
-        4.26. append_rpid_hf(prefix, suffix)
218
-        4.27. is_rpid_user_e164()
219
-        4.28. set_uri_user(uri, user)
220
-        4.29. set_uri_host(uri, host)
221
-        4.30. is_request()
222
-        4.31. is_reply()
223
-        4.32. is_gruu([uri])
224
-        4.33. is_supported(option)
225
-        4.34. is_first_hop([mode])
226
-        4.35. sip_p_charging_vector(flags)
227
-        4.36. contact_param_encode(pname, saddr)
228
-        4.37. contact_param_decode(pname)
229
-        4.38. contact_param_decode_uri(pname)
230
-        4.39. contact_param_rm(pname)
231
-        4.40. hdr_date_check(tdiff)
187
+        4.1. options_reply()
188
+        4.2. is_user(username)
189
+        4.3. has_totag()
190
+        4.4. uri_param(param)
191
+        4.5. uri_param(param,value)
192
+        4.6. uri_param_any(param)
193
+        4.7. add_uri_param(param)
194
+        4.8. get_uri_param(name, var)
195
+        4.9. uri_param_rm(param)
196
+        4.10. tel2sip(uri, hostpart, result)
197
+        4.11. is_e164(pseudo-variable)
198
+        4.12. is_uri_user_e164(pseudo-variable)
199
+        4.13. is_uri(pseudo-variable)
200
+        4.14. is_tel_number(tval)
201
+        4.15. is_numeric(tval)
202
+        4.16. is_alphanum(tval)
203
+        4.17. is_alphanumex(tval, eset)
204
+        4.18. encode_contact(encoding_prefix,hostpart)
205
+        4.19. decode_contact()
206
+        4.20. decode_contact_header()
207
+        4.21. cmp_uri(str1, str2)
208
+        4.22. cmp_aor(str1, str2)
209
+        4.23. cmp_hdr_name(str1, str2)
210
+        4.24. append_rpid_hf()
211
+        4.25. append_rpid_hf(prefix, suffix)
212
+        4.26. is_rpid_user_e164()
213
+        4.27. set_uri_user(uri, user)
214
+        4.28. set_uri_host(uri, host)
215
+        4.29. is_request()
216
+        4.30. is_reply()
217
+        4.31. is_gruu([uri])
218
+        4.32. is_supported(option)
219
+        4.33. is_first_hop([mode])
220
+        4.34. sip_p_charging_vector(flags)
221
+        4.35. contact_param_encode(pname, saddr)
222
+        4.36. contact_param_decode(pname)
223
+        4.37. contact_param_decode_uri(pname)
224
+        4.38. contact_param_rm(pname)
225
+        4.39. hdr_date_check(tdiff)
232 226
 
233 227
    5. Exported pseudo-variables
234 228
 
... ...
@@ -243,12 +237,6 @@ Chapter 1. Admin Guide
243 237
    This module implement various functions and checks related to SIP
244 238
    message handling and URI handling.
245 239
 
246
-   It offers some functions related to handle ringing. In a parallel
247
-   forking scenario you get several 183s with SDP. You don't want that
248
-   your customers hear more than one ringtone or answer machine in
249
-   parallel on the phone. So its necessary to drop the 183 in this cases
250
-   and send a 180 instead.
251
-
252 240
    This module also provides a function to answer OPTIONS requests which
253 241
    are directed to the server itself. This means an OPTIONS request which
254 242
    has the address of the server in the request URI, and no username in
... ...
@@ -277,30 +265,16 @@ Chapter 1. Admin Guide
277 265
 
278 266
 3. Parameters
279 267
 
280
-   3.1. ring_timeout (int)
281
-   3.2. options_accept (string)
282
-   3.3. options_accept_encoding (string)
283
-   3.4. contact_flds_separator (string)
284
-   3.5. options_accept_language (string)
285
-   3.6. options_support (string)
286
-   3.7. rpid_prefix (string)
287
-   3.8. rpid_suffix (string)
288
-   3.9. rpid_avp (string)
289
-
290
-3.1. ring_timeout (int)
291
-
292
-   Timeout value in seconds, define how long the call-id is stored in the
293
-   internal list kept for replacing 183 messages with 180. A reasonable
294
-   value is “30”.
295
-
296
-   Default value is “0”. This means functionality is disabled.
297
-
298
-   Example 1.1. Set ring_timeout parameter
299
-...
300
-modparam("siputils", "ring_timeout", 30)
301
-...
268
+   3.1. options_accept (string)
269
+   3.2. options_accept_encoding (string)
270
+   3.3. contact_flds_separator (string)
271
+   3.4. options_accept_language (string)
272
+   3.5. options_support (string)
273
+   3.6. rpid_prefix (string)
274
+   3.7. rpid_suffix (string)
275
+   3.8. rpid_avp (string)
302 276
 
303
-3.2. options_accept (string)
277
+3.1. options_accept (string)
304 278
 
305 279
    This parameter is the content of the Accept header field. Note: it is
306 280
    not clearly written in RFC3261 if a proxy should accept any content
... ...
@@ -309,12 +283,12 @@ modparam("siputils", "ring_timeout", 30)
309 283
 
310 284
    Default value is “*/*”.
311 285
 
312
-   Example 1.2. Set options_accept parameter
286
+   Example 1.1. Set options_accept parameter
313 287
 ...
314 288
 modparam("siputils", "options_accept", "application/*")
315 289
 ...
316 290
 
317
-3.3. options_accept_encoding (string)
291
+3.2. options_accept_encoding (string)
318 292
 
319 293
    This parameter is the content of the Accept-Encoding header field.
320 294
    Please do not change the default value because Kamailio does not
... ...
@@ -322,12 +296,12 @@ modparam("siputils", "options_accept", "application/*")
322 296
 
323 297
    Default value is “”.
324 298
 
325
-   Example 1.3. Set options_accept_encoding parameter
299
+   Example 1.2. Set options_accept_encoding parameter
326 300
 ...
327 301
 modparam("siputils", "options_accept_encoding", "gzip")
328 302
 ...
329 303
 
330
-3.4. contact_flds_separator (string)
304
+3.3. contact_flds_separator (string)
331 305
 
332 306
    First char of this parameter is used as separator for encoding/decoding
333 307
    Contact header.
... ...
@@ -340,7 +314,7 @@ Warning
340 314
 
341 315
    Default value is “*”.
342 316
 
343
-   Example 1.4. Set contact_flds_separator parameter
317
+   Example 1.3. Set contact_flds_separator parameter
344 318
 ...
345 319
 modparam("siputils", "contact_flds_separator", "-")
346 320
 ...
... ...
@@ -348,7 +322,7 @@ modparam("siputils", "contact_flds_separator", "-")
348 322
    then an encoded uri might look
349 323
    sip:user-password-ip-port-protocol@PublicIP
350 324
 
351
-3.5. options_accept_language (string)
325
+3.4. options_accept_language (string)
352 326
 
353 327
    This parameter is the content of the Accept-Language header field. You
354 328
    can set any language code which you prefer for error descriptions from
... ...
@@ -357,12 +331,12 @@ modparam("siputils", "contact_flds_separator", "-")
357 331