Browse code

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

Kamailio Dev authored on 09/03/2020 19:31:12
Showing 1 changed files
... ...
@@ -78,6 +78,7 @@ Bogdan-Andre Iancu
78 78
               3.31. contact_max_size (integer)
79 79
               3.32. event_callback (str)
80 80
               3.33. lookup_filter_mode (int)
81
+              3.34. use_expired_contacts (int)
81 82
 
82 83
         4. Functions
83 84
 
... ...
@@ -145,17 +146,18 @@ Bogdan-Andre Iancu
145 146
    1.30. Set contact_max_size parameter
146 147
    1.31. Set event_callback parameter
147 148
    1.32. Set xavp_cfg parameter
148
-   1.33. save usage
149
-   1.34. lookup usage
150
-   1.35. lookup_branches usage
151
-   1.36. registered usage
152
-   1.37. add_sock_hdr usage
153
-   1.38. unregister usage
154
-   1.39. reg_fetch_contacts usage
155
-   1.40. reg_free_contacts usage
156
-   1.41. reg_send_reply usage
157
-   1.42. event_route[usrloc:contact-expired] usage
158
-   1.43. $ulc(name) usage
149
+   1.33. Set use_expired_contacts parameter
150
+   1.34. save usage
151
+   1.35. lookup usage
152
+   1.36. lookup_branches usage
153
+   1.37. registered usage
154
+   1.38. add_sock_hdr usage
155
+   1.39. unregister usage
156
+   1.40. reg_fetch_contacts usage
157
+   1.41. reg_free_contacts usage
158
+   1.42. reg_send_reply usage
159
+   1.43. event_route[usrloc:contact-expired] usage
160
+   1.44. $ulc(name) usage
159 161
 
160 162
 Chapter 1. Admin Guide
161 163
 
... ...
@@ -206,6 +208,7 @@ Chapter 1. Admin Guide
206 208
         3.31. contact_max_size (integer)
207 209
         3.32. event_callback (str)
208 210
         3.33. lookup_filter_mode (int)
211
+        3.34. use_expired_contacts (int)
209 212
 
210 213
    4. Functions
211 214
 
... ...
@@ -334,6 +337,7 @@ Chapter 1. Admin Guide
334 337
    3.31. contact_max_size (integer)
335 338
    3.32. event_callback (str)
336 339
    3.33. lookup_filter_mode (int)
340
+   3.34. use_expired_contacts (int)
337 341
 
338 342
 3.1. default_expires (integer)
339 343
 
... ...
@@ -920,6 +924,22 @@ request_route {
920 924
 }
921 925
 ...
922 926
 
927
+3.34. use_expired_contacts (int)
928
+
929
+   Allow/Disallow the usage of the expired contacts.
930
+     * 0 Disallow the usage of the expired contacts.
931
+     * 1 Allow the usage of the expired contacts.
932
+
933
+   Default value is 0 (Disallow).
934
+
935
+   Example 1.33. Set use_expired_contacts parameter
936
+...
937
+modparam("registrar", "use_expired_contacts", 1)
938
+...
939
+
940
+kamcmd cfg.set_now_int registrar use_expired_contacts 1
941
+kamcmd cfg.set_now_int registrar use_expired_contacts 0
942
+
923 943
 4. Functions
924 944
 
925 945
    4.1. save(domain, [, flags [, uri]])
... ...
@@ -973,7 +993,7 @@ request_route {
973 993
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE and
974 994
    REPLY_ROUTE.
975 995
 
976
-   Example 1.33. save usage
996
+   Example 1.34. save usage
977 997
 ...
978 998
 save("location");
979 999
 save("location", "0x01");
... ...
@@ -1006,7 +1026,7 @@ save("location", "0x00", "sip:test@kamailio.org");
1006 1026
 
1007 1027
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
1008 1028
 
1009
-   Example 1.34. lookup usage
1029
+   Example 1.35. lookup usage
1010 1030
 ...
1011 1031
 lookup("location");
1012 1032
 switch ($retcode) {
... ...
@@ -1032,7 +1052,7 @@ switch ($retcode) {
1032 1052
 
1033 1053
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
1034 1054
 
1035
-   Example 1.35. lookup_branches usage
1055
+   Example 1.36. lookup_branches usage
1036 1056
 ...
1037 1057
 lookup_branches("location");
1038 1058
 ...
... ...
@@ -1064,7 +1084,7 @@ lookup_branches("location");
1064 1084
 
1065 1085
    This function can be used from ANY_ROUTE.
1066 1086
 
1067
-   Example 1.36. registered usage
1087
+   Example 1.37. registered usage
1068 1088
 ...
1069 1089
 if (registered("location")) {
1070 1090
         sl_send_reply("100", "Trying");
... ...
@@ -1091,7 +1111,7 @@ if (registered("location","$rz:$Au", 2)) {
1091 1111
 
1092 1112
    This function can be used from REQUEST_ROUTE.
1093 1113
 
1094
-   Example 1.37. add_sock_hdr usage
1114
+   Example 1.38. add_sock_hdr usage
1095 1115
 ...
1096 1116
 add_sock_hdr("Sock-Info");
1097 1117
 ...
... ...
@@ -1121,7 +1141,7 @@ add_sock_hdr("Sock-Info");
1121 1141
      * -2 - Error in unregistering user
1122 1142
      * -3 - Contacts for AOR not found
1123 1143
 
1124
-   Example 1.38. unregister usage
1144
+   Example 1.39. unregister usage
1125 1145
 ...
1126 1146
 unregister("location", "$ru");
1127 1147
 unregister("location", "sip:user@kamailio.org");
... ...
@@ -1145,7 +1165,7 @@ unregister("location", "", "$ruid");
1145 1165
 
1146 1166
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
1147 1167
 
1148
-   Example 1.39. reg_fetch_contacts usage
1168
+   Example 1.40. reg_fetch_contacts usage
1149 1169
 ...
1150 1170
 reg_fetch_contacts("location", "$ru", "callee");
1151 1171
 reg_fetch_contacts("location", "sip:user@kamailio.org", "caller");
... ...
@@ -1164,7 +1184,7 @@ reg_fetch_contacts("location", "sip:user@kamailio.org", "caller");
1164 1184
 
1165 1185
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
1166 1186
 
1167
-   Example 1.40. reg_free_contacts usage
1187
+   Example 1.41. reg_free_contacts usage
1168 1188
 ...
1169 1189
 reg_free_contacts("callee");
1170 1190
 ...
... ...
@@ -1178,7 +1198,7 @@ reg_free_contacts("callee");
1178 1198
 
1179 1199
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
1180 1200
 
1181
-   Example 1.41. reg_send_reply usage
1201
+   Example 1.42. reg_send_reply usage
1182 1202
 ...
1183 1203
 save("location", "0x2");
1184 1204
 ...
... ...
@@ -1194,7 +1214,7 @@ reg_send_reply();
1194 1214
    Executed when a contact in location table has expired. The variable
1195 1215
    $ulc(exp=>...) is filled with the attributes of the expired contact.
1196 1216
 
1197
-   Example 1.42. event_route[usrloc:contact-expired] usage
1217
+   Example 1.43. event_route[usrloc:contact-expired] usage
1198 1218
 ...
1199 1219
 event_route[usrloc:contact-expired] {
1200 1220
     xlog("expired contact for $ulc(exp=>aor)\n");
... ...
@@ -1268,7 +1288,7 @@ event_route[usrloc:contact-expired] {
1268 1288
    The pseudo-variable accepts positive index value to access a specific
1269 1289
    contact record.
1270 1290
 
1271
-   Example 1.43. $ulc(name) usage
1291
+   Example 1.44. $ulc(name) usage
1272 1292
 ...
1273 1293
 if(reg_fetch_contacts("location", "$fu", "caller"))
1274 1294
 {