Browse code

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

Kamailio Dev authored on 07/05/2021 06:16:20
Showing 1 changed files
... ...
@@ -67,11 +67,12 @@ Ramona-Elena Modroiu
67 67
               4.8. uac_auth_mode(vmode)
68 68
               4.9. uac_req_send()
69 69
               4.10. uac_reg_lookup(uuid, dst)
70
-              4.11. uac_reg_status(uuid)
71
-              4.12. uac_reg_request_to(user, mode)
72
-              4.13. uac_reg_enable(attr, val)
73
-              4.14. uac_reg_disable(attr, val)
74
-              4.15. uac_reg_refresh(luuid)
70
+              4.11. uac_reg_lookup_uri(uri, dst)
71
+              4.12. uac_reg_status(uuid)
72
+              4.13. uac_reg_request_to(user, mode)
73
+              4.14. uac_reg_enable(attr, val)
74
+              4.15. uac_reg_disable(attr, val)
75
+              4.16. uac_reg_refresh(luuid)
75 76
 
76 77
         5. Pseudo Variables
77 78
         6. Event Routes
... ...
@@ -129,23 +130,24 @@ Ramona-Elena Modroiu
129 130
    1.31. uac_auth_mode usage
130 131
    1.32. uac_req_send usage
131 132
    1.33. uac_reg_lookup usage
132
-   1.34. uac_reg_status usage
133
-   1.35. uac_reg_request_to usage
134
-   1.36. uac_reg_enable usage
135
-   1.37. uac_reg_disable usage
136
-   1.38. uac_reg_refresh usage
137
-   1.39. event_route[uac:reply] usage
138
-   1.40. uac.reg_dump usage
139
-   1.41. uac.reg_info usage
140
-   1.42. uac.reg_enable usage
141
-   1.43. uac.reg_disable usage
142
-   1.44. uac.reg_unregister usage
143
-   1.45. uac.reg_reload usage
144
-   1.46. uac.reg_refresh usage
145
-   1.47. uac.reg_active usage
146
-   1.48. uac.reg_add usage
147
-   1.49. uac.reg_remove usage
148
-   1.50. lookup remote registrations usage
133
+   1.34. uac_reg_lookup_uri usage
134
+   1.35. uac_reg_status usage
135
+   1.36. uac_reg_request_to usage
136
+   1.37. uac_reg_enable usage
137
+   1.38. uac_reg_disable usage
138
+   1.39. uac_reg_refresh usage
139
+   1.40. event_route[uac:reply] usage
140
+   1.41. uac.reg_dump usage
141
+   1.42. uac.reg_info usage
142
+   1.43. uac.reg_enable usage
143
+   1.44. uac.reg_disable usage
144
+   1.45. uac.reg_unregister usage
145
+   1.46. uac.reg_reload usage
146
+   1.47. uac.reg_refresh usage
147
+   1.48. uac.reg_active usage
148
+   1.49. uac.reg_add usage
149
+   1.50. uac.reg_remove usage
150
+   1.51. lookup remote registrations usage
149 151
 
150 152
 Chapter 1. Admin Guide
151 153
 
... ...
@@ -195,11 +197,12 @@ Chapter 1. Admin Guide
195 197
         4.8. uac_auth_mode(vmode)
196 198
         4.9. uac_req_send()
197 199
         4.10. uac_reg_lookup(uuid, dst)
198
-        4.11. uac_reg_status(uuid)
199
-        4.12. uac_reg_request_to(user, mode)
200
-        4.13. uac_reg_enable(attr, val)
201
-        4.14. uac_reg_disable(attr, val)
202
-        4.15. uac_reg_refresh(luuid)
200
+        4.11. uac_reg_lookup_uri(uri, dst)
201
+        4.12. uac_reg_status(uuid)
202
+        4.13. uac_reg_request_to(user, mode)
203
+        4.14. uac_reg_enable(attr, val)
204
+        4.15. uac_reg_disable(attr, val)
205
+        4.16. uac_reg_refresh(luuid)
203 206
 
204 207
    5. Pseudo Variables
205 208
    6. Event Routes
... ...
@@ -654,11 +657,12 @@ end
654 657
    4.8. uac_auth_mode(vmode)
655 658
    4.9. uac_req_send()
656 659
    4.10. uac_reg_lookup(uuid, dst)
657
-   4.11. uac_reg_status(uuid)
658
-   4.12. uac_reg_request_to(user, mode)
659
-   4.13. uac_reg_enable(attr, val)
660
-   4.14. uac_reg_disable(attr, val)
661
-   4.15. uac_reg_refresh(luuid)
660
+   4.11. uac_reg_lookup_uri(uri, dst)
661
+   4.12. uac_reg_status(uuid)
662
+   4.13. uac_reg_request_to(user, mode)
663
+   4.14. uac_reg_enable(attr, val)
664
+   4.15. uac_reg_disable(attr, val)
665
+   4.16. uac_reg_refresh(luuid)
662 666
 
663 667
 4.1.  uac_replace_from(display,uri)
664 668
 
... ...
@@ -919,7 +923,24 @@ if(uac_reg_lookup("$rU", "$ru"))
919 923
 }
920 924
 ...
921 925
 
922
-4.11.  uac_reg_status(uuid)
926
+4.11.  uac_reg_lookup_uri(uri, dst)
927
+
928
+   This function sets the PV dst to SIP URI that correspond to the URI
929
+   user in uac registrations table. The uri can contain pseudo-variables
930
+   and dst must be the name of a pseudo-variable.
931
+
932
+   This function can be used from ANY_ROUTE.
933
+
934
+   Example 1.34. uac_reg_lookup_uri usage
935
+...
936
+
937
+if(uac_reg_lookup("$var(uri)", "$ru"))
938
+{
939
+    lookup("location");
940
+}
941
+...
942
+
943
+4.12.  uac_reg_status(uuid)
923 944
 
924 945
    This function returns the current registration status for the uuid.
925 946
 
... ...
@@ -934,12 +955,12 @@ if(uac_reg_lookup("$rU", "$ru"))
934 955
 
935 956
    This function can be used from ANY_ROUTE.
936 957
 
937
-   Example 1.34. uac_reg_status usage
958
+   Example 1.35. uac_reg_status usage
938 959
 ...
939 960
 $var(status) = uac_reg_status("$rU");
940 961
 ...
941 962
 
942
-4.12.  uac_reg_request_to(user, mode)
963
+4.13.  uac_reg_request_to(user, mode)
943 964
 
944 965
    This function can be used to send an authenticated request to a remote
945 966
    user in the uac registrations table. It sets the request-uri, dst-uri
... ...
@@ -959,7 +980,7 @@ $var(status) = uac_reg_status("$rU");
959 980
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
960 981
    BRANCH_ROUTE.
961 982
 
962
-   Example 1.35. uac_reg_request_to usage
983
+   Example 1.36. uac_reg_request_to usage
963 984
 ...
964 985
 
965 986
 if(uac_reg_request_to("$fU", 0))
... ...
@@ -978,7 +999,7 @@ failure_route[REMOTE_AUTH] {
978 999
 }
979 1000
 ...
980 1001
 
981
-4.13.  uac_reg_enable(attr, val)
1002
+4.14.  uac_reg_enable(attr, val)
982 1003
 
983 1004
    Enable a remote registration record based on a filter specified by
984 1005
    attribute and value. The attribute can be: l_uuid, l_username,
... ...
@@ -987,12 +1008,12 @@ failure_route[REMOTE_AUTH] {
987 1008
 
988 1009
    The SIP processing is done on the next timer routine.
989 1010
 
990
-   Example 1.36. uac_reg_enable usage
1011
+   Example 1.37. uac_reg_enable usage
991 1012
 ...
992 1013
    uac_reg_enable("l_uuid", "account123");
993 1014
 ...
994 1015
 
995
-4.14.  uac_reg_disable(attr, val)
1016
+4.15.  uac_reg_disable(attr, val)
996 1017
 
997 1018
    Disable a remote registration record based on a filter specified by
998 1019
    attribute and value. The attribute can be: l_uuid, l_username,
... ...
@@ -1001,18 +1022,18 @@ failure_route[REMOTE_AUTH] {
1001 1022
 
1002 1023
    The SIP processing is done on the next timer routine.
1003 1024
 
1004
-   Example 1.37. uac_reg_disable usage
1025
+   Example 1.38. uac_reg_disable usage
1005 1026
 ...
1006 1027
    uac_reg_disable("l_uuid", "account123");
1007 1028
 ...
1008 1029
 
1009
-4.15.  uac_reg_refresh(luuid)
1030
+4.16.  uac_reg_refresh(luuid)
1010 1031
 
1011 1032
    Refresh the uac remote registration record based on local uuid. If the
1012 1033
    record was already loaded, new values are taken from database,
1013 1034
    otherwise a new record is created.
1014 1035
 
1015
-   Example 1.38. uac_reg_refresh usage
1036
+   Example 1.39. uac_reg_refresh usage
1016 1037
 ...
1017 1038
    uac_reg_refresh("account123");
1018 1039
 ...
... ...
@@ -1036,7 +1057,7 @@ failure_route[REMOTE_AUTH] {
1036 1057
    then the event_route is executed twice, first for 401/407 and second
1037 1058
    for final reply of the transaction.
1038 1059
 
1039
-   Example 1.39. event_route[uac:reply] usage
1060
+   Example 1.40. event_route[uac:reply] usage
1040 1061
 ...
1041 1062
 $uac_req(method)="OPTIONS";
1042 1063
 $uac_req(ruri)="sip:kamailio.org";
... ...
@@ -1076,7 +1097,7 @@ event_route[uac:reply] {
1076 1097
 
1077 1098
    Dump the content of remote registration table from memory.
1078 1099
 
1079
-   Example 1.40. uac.reg_dump usage
1100
+   Example 1.41. uac.reg_dump usage
1080 1101
 ...
1081 1102
    kamcmd uac.reg_dump
1082 1103
 ...
... ...
@@ -1097,7 +1118,7 @@ event_route[uac:reply] {
1097 1118
      * 16 (2^4) - registration initialized (after loading from database,
1098 1119
        the registration process was initialized)
1099 1120
 
1100
-   Example 1.41. uac.reg_info usage
1121
+   Example 1.42. uac.reg_info usage
1101 1122
 ...
1102 1123
    kamcmd uac.reg_info l_uuid account123
1103 1124
    kamcmd uac.reg_info l_uuid s:12345678
... ...
@@ -1111,7 +1132,7 @@ event_route[uac:reply] {
1111 1132
    matched against the value of the attribute in the remote registration
1112 1133
    record.
1113 1134
 
1114
-   Example 1.42. uac.reg_enable usage
1135
+   Example 1.43. uac.reg_enable usage
1115 1136
 ...
1116 1137
    kamcmd uac.reg_enable l_uuid account123
1117 1138
    kamcmd uac.reg_enable l_uuid s:12345678
... ...
@@ -1125,7 +1146,7 @@ event_route[uac:reply] {
1125 1146
    matched against the value of the attribute in the remote registration
1126 1147
    record.
1127 1148
 
1128
-   Example 1.43. uac.reg_disable usage
1149
+   Example 1.44. uac.reg_disable usage
1129 1150
 ...
1130 1151
    kamcmd uac.reg_disable l_uuid account123
1131 1152
    kamcmd uac.reg_disable l_uuid s:12345678
... ...
@@ -1139,7 +1160,7 @@ event_route[uac:reply] {
1139 1160
    should be matched against the value of the attribute in the remote
1140 1161
    registration record.
1141 1162
 
1142
-   Example 1.44. uac.reg_unregister usage
1163
+   Example 1.45. uac.reg_unregister usage
1143 1164
 ...
1144 1165
    kamcmd uac.reg_unregister l_uuid account123
1145 1166
    kamcmd uac.reg_unregister l_uuid s:12345678
... ...
@@ -1152,7 +1173,7 @@ event_route[uac:reply] {
1152 1173
    150 seconds between reloads -- see the reg_gc_interval parameter for
1153 1174
    more details.
1154 1175
 
1155
-   Example 1.45. uac.reg_reload usage
1176
+   Example 1.46. uac.reg_reload usage
1156 1177
 ...
1157 1178
    kamcmd uac.reg_reload
1158 1179
 ...
... ...
@@ -1163,7 +1184,7 @@ event_route[uac:reply] {
1163 1184
    the record exists in memory, it will be replaced with the new values
1164 1185
    loaded from database.
1165 1186
 
1166
-   Example 1.46. uac.reg_refresh usage
1187
+   Example 1.47. uac.reg_refresh usage
1167 1188
 ...
1168 1189
    kamcmd uac.reg_refresh account123
1169 1190
    kamcmd uac.reg_refresh s:12345678
... ...
@@ -1175,7 +1196,7 @@ event_route[uac:reply] {
1175 1196
    1 enables remote registrations for all records and 0 disables doing
1176 1197
    them.
1177 1198
 
1178
-   Example 1.47. uac.reg_active usage
1199
+   Example 1.48. uac.reg_active usage
1179 1200
 ...
1180 1201
    kamctl rpc uac.reg_active 0
1181 1202
    kamctl rpc uac.reg_active 1
... ...
@@ -1206,7 +1227,7 @@ event_route[uac:reply] {
1206 1227
    Use a dot (.) if no value should be set for auth_password, auth_ha1, or
1207 1228
    contact_addr.
1208 1229
 
1209
-   Example 1.48. uac.reg_add usage
1230
+   Example 1.49. uac.reg_add usage
1210 1231
 ...
1211 1232
    kamcmd uac.reg_add ...
1212 1233
 ...
... ...
@@ -1215,7 +1236,7 @@ event_route[uac:reply] {
1215 1236
 
1216 1237
    Remove a UAC remote registration record by l_uuid.
1217 1238
 
1218
-   Example 1.49. uac.reg_remove usage
1239
+   Example 1.50. uac.reg_remove usage
1219 1240
 ...
1220 1241
    kamcmd uac.reg_remove my_l_uuid
1221 1242
 ...
... ...
@@ -1271,7 +1292,7 @@ event_route[uac:reply] {
1271 1292
    if the call is coming from a remote SIP provider and can change the
1272 1293
    R-URI to local username@domain. Afterwards you can run location lookup.
1273 1294
 
1274
-   Example 1.50. lookup remote registrations usage
1295
+   Example 1.51. lookup remote registrations usage
1275 1296
 ...
1276 1297
     if(uac_reg_lookup("$rU", "$ru")) {
1277 1298
         xlog("request from a remote SIP provider [$ou => $ru]\n");