Browse code

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

Kamailio Dev authored on 15/11/2021 09:46:22
Showing 1 changed files
... ...
@@ -61,6 +61,7 @@ Emmanuel Schmidbauer
61 61
               3.23. max_subnets (int)
62 62
               3.24. load_backends (int)
63 63
               3.25. reload_delta (int)
64
+              3.26. trusted_cleanup_interval (int)
64 65
 
65 66
         4. Functions
66 67
 
... ...
@@ -116,18 +117,19 @@ Emmanuel Schmidbauer
116 117
    1.23. Set max_subnets parameter
117 118
    1.24. Set load_backends parameter
118 119
    1.25. Set reload_delta parameter
119
-   1.26. allow_routing usage
120
-   1.27. allow_routing(basename) usage
121
-   1.28. allow_routing(allow_file, deny_file) usage
122
-   1.29. allow_register(basename) usage
123
-   1.30. allow_register(allow_file, deny_file) usage
124
-   1.31. allow_uri(basename, pvar) usage
125
-   1.32. allow_address() usage
126
-   1.33. allow_source_address(group_id) usage
127
-   1.34. allow_source_address_group() usage
120
+   1.26. Set trusted_cleanup_interval parameter
121
+   1.27. allow_routing usage
122
+   1.28. allow_routing(basename) usage
123
+   1.29. allow_routing(allow_file, deny_file) usage
124
+   1.30. allow_register(basename) usage
125
+   1.31. allow_register(allow_file, deny_file) usage
126
+   1.32. allow_uri(basename, pvar) usage
127
+   1.33. allow_address() usage
128
+   1.34. allow_source_address(group_id) usage
128 129
    1.35. allow_source_address_group() usage
129
-   1.36. allow_trusted() usage
130
-   1.37. Address File Sample
130
+   1.36. allow_source_address_group() usage
131
+   1.37. allow_trusted() usage
132
+   1.38. Address File Sample
131 133
 
132 134
 Chapter 1. Admin Guide
133 135
 
... ...
@@ -173,6 +175,7 @@ Chapter 1. Admin Guide
173 175
         3.23. max_subnets (int)
174 176
         3.24. load_backends (int)
175 177
         3.25. reload_delta (int)
178
+        3.26. trusted_cleanup_interval (int)
176 179
 
177 180
    4. Functions
178 181
 
... ...
@@ -405,6 +408,7 @@ Chapter 1. Admin Guide
405 408
    3.23. max_subnets (int)
406 409
    3.24. load_backends (int)
407 410
    3.25. reload_delta (int)
411
+   3.26. trusted_cleanup_interval (int)
408 412
 
409 413
 3.1. default_allow_file (string)
410 414
 
... ...
@@ -748,6 +752,19 @@ modparam("permissions", "load_backends", 1)
748 752
 modparam("permissions", "reload_delta", 1)
749 753
 ...
750 754
 
755
+3.26. trusted_cleanup_interval (int)
756
+
757
+   If module parameter db_mode is set to 1 a cleanup timer is set to the
758
+   trusted_cleanup_interval value in seconds. This process will cleanup
759
+   the previous values from memory after a RPC reload.
760
+
761
+   Default value is “60”.
762
+
763
+   Example 1.26. Set trusted_cleanup_interval parameter
764
+...
765
+modparam("permissions", "trusted_cleanup_interval", 120)
766
+...
767
+
751 768
 4. Functions
752 769
 
753 770
    4.1. allow_routing()
... ...
@@ -771,7 +788,7 @@ modparam("permissions", "reload_delta", 1)
771 788
 
772 789
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
773 790
 
774
-   Example 1.26. allow_routing usage
791
+   Example 1.27. allow_routing usage
775 792
 ...
776 793
 if (allow_routing()) {
777 794
         t_relay();
... ...
@@ -794,7 +811,7 @@ if (allow_routing()) {
794 811
 
795 812
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
796 813
 
797
-   Example 1.27. allow_routing(basename) usage
814
+   Example 1.28. allow_routing(basename) usage
798 815
 ...
799 816
 if (allow_routing("basename")) {
800 817
         t_relay();
... ...
@@ -819,7 +836,7 @@ if (allow_routing("basename")) {
819 836
 
820 837
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
821 838
 
822
-   Example 1.28. allow_routing(allow_file, deny_file) usage
839
+   Example 1.29. allow_routing(allow_file, deny_file) usage
823 840
 ...
824 841
 if (allow_routing("rules.allow", "rules.deny")) {
825 842
         t_relay();
... ...
@@ -842,7 +859,7 @@ if (allow_routing("rules.allow", "rules.deny")) {
842 859
 
843 860
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
844 861
 
845
-   Example 1.29. allow_register(basename) usage
862
+   Example 1.30. allow_register(basename) usage
846 863
 ...
847 864
 if (method=="REGISTER") {
848 865
         if (allow_register("register")) {
... ...
@@ -872,7 +889,7 @@ if (method=="REGISTER") {
872 889
 
873 890
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
874 891
 
875
-   Example 1.30. allow_register(allow_file, deny_file) usage
892
+   Example 1.31. allow_register(allow_file, deny_file) usage
876 893
 ...
877 894
 if (method=="REGISTER") {
878 895
         if (allow_register("register.allow", "register.deny")) {
... ...
@@ -901,7 +918,7 @@ if (method=="REGISTER") {
901 918
 
902 919
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
903 920
 
904
-   Example 1.31. allow_uri(basename, pvar) usage
921
+   Example 1.32. allow_uri(basename, pvar) usage
905 922
 ...
906 923
 if (allow_uri("basename", "$rt")) {  // Check Refer-To URI
907 924
         t_relay();
... ...
@@ -927,7 +944,7 @@ if (allow_uri("basename", "$avp(i:705)") {  // Check URI stored in $avp(i:705)
927 944
 
928 945
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
929 946
 
930
-   Example 1.32. allow_address() usage
947
+   Example 1.33. allow_address() usage
931 948
 ...
932 949
 
933 950
 // Check if source address/port is in group 1
... ...
@@ -949,7 +966,7 @@ if (!allow_address("2", "$avp(dst_adr)", "$avp(dst_port)") {
949 966
 
950 967
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
951 968
 
952
-   Example 1.33. allow_source_address(group_id) usage
969
+   Example 1.34. allow_source_address(group_id) usage
953 970
 ...
954 971
 
955 972
 // Check source address/port of request
... ...
@@ -966,7 +983,7 @@ if (!allow_source_address("1")) {
966 983
 
967 984
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
968 985
 
969
-   Example 1.34. allow_source_address_group() usage
986
+   Example 1.35. allow_source_address_group() usage
970 987
 ...
971 988
 
972 989
 $var(group) = allow_source_address_group();
... ...
@@ -984,7 +1001,7 @@ if ($var(group) != -1) {
984 1001
 
985 1002
    This function can be used from ANY_ROUTE.
986 1003
 
987
-   Example 1.35. allow_source_address_group() usage
1004
+   Example 1.36. allow_source_address_group() usage
988 1005
 ...
989 1006
 
990 1007
 $var(group) = allow_address_group("1.2.3.4", "5060");
... ...
@@ -1014,7 +1031,7 @@ if ($var(group) != -1) {
1014 1031
 
1015 1032
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
1016 1033
 
1017
-   Example 1.36. allow_trusted() usage
1034
+   Example 1.37. allow_trusted() usage
1018 1035
 ...
1019 1036
 if (allow_trusted()) {
1020 1037
         t_relay();
... ...
@@ -1124,7 +1141,7 @@ if (allow_trusted("$si", "any", "$ai")) {
1124 1141
    provided, the tag value has to be a single token, without whitespaces
1125 1142
    (other punctuation signs can be in its value, like ',', '=', ';', ...).
1126 1143
 
1127
-   Example 1.37. Address File Sample
1144
+   Example 1.38. Address File Sample
1128 1145
 ...
1129 1146
 # address file - records to match with allow_address(...) and variants
1130 1147
 # * file format details