Browse code

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

Kamailio Dev authored on 10/05/2021 07:46:22
Showing 1 changed files
... ...
@@ -52,8 +52,9 @@ Ramona-Elena Modroiu
52 52
               3.19. reg_keep_callid (int)
53 53
               3.20. reg_active (int)
54 54
               3.21. reg_gc_interval (int)
55
-              3.22. default_socket (str)
56
-              3.23. event_callback (str)
55
+              3.22. reg_use_domain (int)
56
+              3.23. default_socket (str)
57
+              3.24. event_callback (str)
57 58
 
58 59
         4. Functions
59 60
 
... ...
@@ -118,36 +119,37 @@ Ramona-Elena Modroiu
118 119
    1.19. Set reg_keep_callid parameter
119 120
    1.20. Set reg_active parameter
120 121
    1.21. Set reg_gc_interval parameter
121
-   1.22. Set the “default_socket” parameter
122
-   1.23. Set event_callback parameter
123
-   1.24. uac_replace_from usage
122
+   1.22. Set reg_use_domain parameter
123
+   1.23. Set the “default_socket” parameter
124
+   1.24. Set event_callback parameter
124 125
    1.25. uac_replace_from usage
125
-   1.26. uac_restore_from usage
126
-   1.27. uac_replace_to usage
126
+   1.26. uac_replace_from usage
127
+   1.27. uac_restore_from usage
127 128
    1.28. uac_replace_to usage
128
-   1.29. uac_restore_to usage
129
-   1.30. uac_auth usage
130
-   1.31. uac_auth_mode usage
131
-   1.32. uac_req_send usage
132
-   1.33. uac_reg_lookup 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
129
+   1.29. uac_replace_to usage
130
+   1.30. uac_restore_to usage
131
+   1.31. uac_auth usage
132
+   1.32. uac_auth_mode usage
133
+   1.33. uac_req_send usage
134
+   1.34. uac_reg_lookup usage
135
+   1.35. uac_reg_lookup_uri usage
136
+   1.36. uac_reg_status usage
137
+   1.37. uac_reg_request_to usage
138
+   1.38. uac_reg_enable usage
139
+   1.39. uac_reg_disable usage
140
+   1.40. uac_reg_refresh usage
141
+   1.41. event_route[uac:reply] usage
142
+   1.42. uac.reg_dump usage
143
+   1.43. uac.reg_info usage
144
+   1.44. uac.reg_enable usage
145
+   1.45. uac.reg_disable usage
146
+   1.46. uac.reg_unregister usage
147
+   1.47. uac.reg_reload usage
148
+   1.48. uac.reg_refresh usage
149
+   1.49. uac.reg_active usage
150
+   1.50. uac.reg_add usage
151
+   1.51. uac.reg_remove usage
152
+   1.52. lookup remote registrations usage
151 153
 
152 154
 Chapter 1. Admin Guide
153 155
 
... ...
@@ -182,8 +184,9 @@ Chapter 1. Admin Guide
182 184
         3.19. reg_keep_callid (int)
183 185
         3.20. reg_active (int)
184 186
         3.21. reg_gc_interval (int)
185
-        3.22. default_socket (str)
186
-        3.23. event_callback (str)
187
+        3.22. reg_use_domain (int)
188
+        3.23. default_socket (str)
189
+        3.24. event_callback (str)
187 190
 
188 191
    4. Functions
189 192
 
... ...
@@ -302,8 +305,9 @@ Chapter 1. Admin Guide
302 305
    3.19. reg_keep_callid (int)
303 306
    3.20. reg_active (int)
304 307
    3.21. reg_gc_interval (int)
305
-   3.22. default_socket (str)
306
-   3.23. event_callback (str)
308
+   3.22. reg_use_domain (int)
309
+   3.23. default_socket (str)
310
+   3.24. event_callback (str)
307 311
 
308 312
 3.1. rr_from_store_param (string)
309 313
 
... ...
@@ -602,7 +606,19 @@ modparam("uac", "reg_active", 0)
602 606
 modparam("uac", "reg_gc_interval", 60)
603 607
 ...
604 608
 
605
-3.22. default_socket (str)
609
+3.22. reg_use_domain (int)
610
+
611
+   If set to 1, domain part of URIs is used by functions doing lookup on
612
+   user name.
613
+
614
+   Default value is “0”.
615
+
616
+   Example 1.22. Set reg_use_domain parameter
617
+...
618
+modparam("uac", "reg_use_domain", 1)
619
+...
620
+
621
+3.23. default_socket (str)
606 622
 
607 623
    Default socket to be used for generating registration requests and
608 624
    sending requests with the function uac_req_send(). Useful e.g. when
... ...
@@ -619,12 +635,12 @@ modparam("uac", "reg_gc_interval", 60)
619 635
    If you want to force a certain TCP port (e.g. 5060), you will need to
620 636
    set the tcp_reuse_port=yes core parameter as well.
621 637
 
622
-   Example 1.22. Set the “default_socket” parameter
638
+   Example 1.23. Set the “default_socket” parameter
623 639
  ...
624 640
  modparam("uac", "default_socket", "udp:192.168.0.125:5060")
625 641
  ...
626 642
 
627
-3.23. event_callback (str)
643
+3.24. event_callback (str)
628 644
 
629 645
    The name of the function in the kemi configuration file (embedded
630 646
    scripting language such as Lua, Python, ...) to be executed instead of
... ...
@@ -635,7 +651,7 @@ modparam("uac", "reg_gc_interval", 60)
635 651
 
636 652
    Default value is 'empty' (no function is executed for events).
637 653
 
638
-   Example 1.23. Set event_callback parameter
654
+   Example 1.24. Set event_callback parameter
639 655
  ...
640 656
 modparam("uac", "event_callback", "ksr_uac_event")
641 657
 
... ...
@@ -694,7 +710,7 @@ end
694 710
    dialog variables and registering callbacks in dialog module for in
695 711
    dialog requests.
696 712
 
697
-   Example 1.24. uac_replace_from usage
713
+   Example 1.25. uac_replace_from usage
698 714
 ...
699 715
 # replace both display and uri
700 716
 uac_replace_from("$avp(s:display)","$avp(s:uri)");
... ...
@@ -715,7 +731,7 @@ uac_replace_from("","");
715 731
 
716 732
    This function can be used from REQUEST_ROUTE and from BRANCH_ROUTE.
717 733
 
718
-   Example 1.25. uac_replace_from usage
734
+   Example 1.26. uac_replace_from usage
719 735
 ...
720 736
 uac_replace_from("sip:batman@gotham.org");
721 737
 ...
... ...
@@ -728,7 +744,7 @@ uac_replace_from("sip:batman@gotham.org");
728 744
 
729 745
    This function can be used from REQUEST_ROUTE.
730 746
 
731
-   Example 1.26. uac_restore_from usage
747
+   Example 1.27. uac_restore_from usage
732 748
 ...
733 749
 uac_restore_from();
734 750
 ...
... ...
@@ -745,7 +761,7 @@ uac_restore_from();
745 761
    automatically to display variable. That is no longer the case, if you
746 762
    expect that behavior, you will have to add the quotes by yourself.
747 763
 
748
-   Example 1.27. uac_replace_to usage
764
+   Example 1.28. uac_replace_to usage
749 765
 ...
750 766
 # replace both display and uri
751 767
 uac_replace_to("$avp(display)","$avp(uri)");
... ...
@@ -784,7 +800,7 @@ uac_replace_to("","");
784 800
    variables and registering callbacks in dialog module for in dialog
785 801
    requests.
786 802
 
787
-   Example 1.28. uac_replace_to usage
803
+   Example 1.29. uac_replace_to usage
788 804
 ...
789 805
 uac_replace_to("sip:batman@gotham.org");
790 806
 ...
... ...
@@ -797,7 +813,7 @@ uac_replace_to("sip:batman@gotham.org");
797 813
 
798 814
    This function can be used from REQUEST_ROUTE.
799 815
 
800
-   Example 1.29. uac_restore_to usage
816
+   Example 1.30. uac_restore_to usage
801 817
 ...
802 818
 uac_restore_to();
803 819
 ...
... ...
@@ -814,7 +830,7 @@ uac_restore_to();
814 830
 
815 831
    This function can be used from FAILURE_ROUTE.
816 832
 
817
-   Example 1.30. uac_auth usage
833
+   Example 1.31. uac_auth usage
818 834
 ...
819 835
 modparam("uac","auth_username_avp","$avp(auser)")
820 836
 modparam("uac","auth_password_avp","$avp(apass)")
... ...
@@ -858,7 +874,7 @@ failure_route[TRUNKAUTH] {
858 874
 
859 875
    This function can be used from FAILURE_ROUTE.
860 876
 
861
-   Example 1.31. uac_auth_mode usage
877
+   Example 1.32. uac_auth_mode usage
862 878
 ...
863 879
 modparam("uac","auth_username_avp","$avp(auser)")
864 880
 modparam("uac","auth_password_avp","$avp(apass)")
... ...
@@ -897,7 +913,7 @@ failure_route[TRUNKAUTH] {
897 913
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
898 914
    BRANCH_ROUTE, ONREPLY_ROUTE, LOCAL_ROUTE.
899 915
 
900
-   Example 1.32. uac_req_send usage
916
+   Example 1.33. uac_req_send usage
901 917
 ...
902 918
 $uac_req(method)="OPTIONS";
903 919
 $uac_req(ruri)="sip:kamailio.org";
... ...
@@ -914,7 +930,7 @@ uac_req_send();
914 930
 
915 931
    This function can be used from ANY_ROUTE.
916 932
 
917
-   Example 1.33. uac_reg_lookup usage
933
+   Example 1.34. uac_reg_lookup usage
918 934
 ...
919 935
 
920 936
 if(uac_reg_lookup("$rU", "$ru"))
... ...
@@ -931,7 +947,7 @@ if(uac_reg_lookup("$rU", "$ru"))
931 947
 
932 948
    This function can be used from ANY_ROUTE.
933 949
 
934
-   Example 1.34. uac_reg_lookup_uri usage
950
+   Example 1.35. uac_reg_lookup_uri usage
935 951
 ...
936 952
 
937 953
 if(uac_reg_lookup("$var(uri)", "$ru"))
... ...
@@ -955,7 +971,7 @@ if(uac_reg_lookup("$var(uri)", "$ru"))
955 971
 
956 972
    This function can be used from ANY_ROUTE.
957 973
 
958
-   Example 1.35. uac_reg_status usage
974
+   Example 1.36. uac_reg_status usage
959 975
 ...
960 976
 $var(status) = uac_reg_status("$rU");
961 977
 ...
... ...
@@ -980,7 +996,7 @@ $var(status) = uac_reg_status("$rU");
980 996
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
981 997
    BRANCH_ROUTE.
982 998
 
983
-   Example 1.36. uac_reg_request_to usage
999
+   Example 1.37. uac_reg_request_to usage
984 1000
 ...
985 1001
 
986 1002
 if(uac_reg_request_to("$fU", 0))
... ...
@@ -1008,7 +1024,7 @@ failure_route[REMOTE_AUTH] {
1008 1024
 
1009 1025
    The SIP processing is done on the next timer routine.
1010 1026
 
1011
-   Example 1.37. uac_reg_enable usage
1027
+   Example 1.38. uac_reg_enable usage
1012 1028
 ...
1013 1029
    uac_reg_enable("l_uuid", "account123");
1014 1030
 ...
... ...
@@ -1022,7 +1038,7 @@ failure_route[REMOTE_AUTH] {
1022 1038
 
1023 1039
    The SIP processing is done on the next timer routine.
1024 1040
 
1025
-   Example 1.38. uac_reg_disable usage
1041
+   Example 1.39. uac_reg_disable usage
1026 1042
 ...
1027 1043
    uac_reg_disable("l_uuid", "account123");
1028 1044
 ...
... ...
@@ -1033,7 +1049,7 @@ failure_route[REMOTE_AUTH] {
1033 1049
    record was already loaded, new values are taken from database,
1034 1050
    otherwise a new record is created.
1035 1051
 
1036
-   Example 1.39. uac_reg_refresh usage
1052
+   Example 1.40. uac_reg_refresh usage
1037 1053
 ...
1038 1054
    uac_reg_refresh("account123");
1039 1055
 ...
... ...
@@ -1057,7 +1073,7 @@ failure_route[REMOTE_AUTH] {
1057 1073
    then the event_route is executed twice, first for 401/407 and second
1058 1074
    for final reply of the transaction.
1059 1075
 
1060
-   Example 1.40. event_route[uac:reply] usage
1076
+   Example 1.41. event_route[uac:reply] usage
1061 1077
 ...
1062 1078
 $uac_req(method)="OPTIONS";
1063 1079
 $uac_req(ruri)="sip:kamailio.org";
... ...
@@ -1097,7 +1113,7 @@ event_route[uac:reply] {
1097 1113
 
1098 1114
    Dump the content of remote registration table from memory.
1099 1115
 
1100
-   Example 1.41. uac.reg_dump usage
1116
+   Example 1.42. uac.reg_dump usage
1101 1117
 ...
1102 1118
    kamcmd uac.reg_dump
1103 1119
 ...
... ...
@@ -1118,7 +1134,7 @@ event_route[uac:reply] {
1118 1134
      * 16 (2^4) - registration initialized (after loading from database,
1119 1135
        the registration process was initialized)
1120 1136
 
1121
-   Example 1.42. uac.reg_info usage
1137
+   Example 1.43. uac.reg_info usage
1122 1138
 ...
1123 1139
    kamcmd uac.reg_info l_uuid account123
1124 1140
    kamcmd uac.reg_info l_uuid s:12345678
... ...
@@ -1132,7 +1148,7 @@ event_route[uac:reply] {
1132 1148
    matched against the value of the attribute in the remote registration
1133 1149
    record.
1134 1150
 
1135
-   Example 1.43. uac.reg_enable usage
1151
+   Example 1.44. uac.reg_enable usage
1136 1152
 ...
1137 1153
    kamcmd uac.reg_enable l_uuid account123
1138 1154
    kamcmd uac.reg_enable l_uuid s:12345678
... ...
@@ -1146,7 +1162,7 @@ event_route[uac:reply] {
1146 1162
    matched against the value of the attribute in the remote registration
1147 1163
    record.
1148 1164
 
1149
-   Example 1.44. uac.reg_disable usage
1165
+   Example 1.45. uac.reg_disable usage
1150 1166
 ...
1151 1167
    kamcmd uac.reg_disable l_uuid account123
1152 1168
    kamcmd uac.reg_disable l_uuid s:12345678
... ...
@@ -1160,7 +1176,7 @@ event_route[uac:reply] {
1160 1176
    should be matched against the value of the attribute in the remote
1161 1177
    registration record.
1162 1178
 
1163
-   Example 1.45. uac.reg_unregister usage
1179
+   Example 1.46. uac.reg_unregister usage
1164 1180
 ...
1165 1181
    kamcmd uac.reg_unregister l_uuid account123
1166 1182
    kamcmd uac.reg_unregister l_uuid s:12345678
... ...
@@ -1173,7 +1189,7 @@ event_route[uac:reply] {
1173 1189
    150 seconds between reloads -- see the reg_gc_interval parameter for
1174 1190
    more details.
1175 1191
 
1176
-   Example 1.46. uac.reg_reload usage
1192
+   Example 1.47. uac.reg_reload usage
1177 1193
 ...
1178 1194
    kamcmd uac.reg_reload
1179 1195
 ...
... ...
@@ -1184,7 +1200,7 @@ event_route[uac:reply] {
1184 1200
    the record exists in memory, it will be replaced with the new values
1185 1201
    loaded from database.
1186 1202
 
1187
-   Example 1.47. uac.reg_refresh usage
1203
+   Example 1.48. uac.reg_refresh usage
1188 1204
 ...
1189 1205
    kamcmd uac.reg_refresh account123
1190 1206
    kamcmd uac.reg_refresh s:12345678
... ...
@@ -1196,7 +1212,7 @@ event_route[uac:reply] {
1196 1212
    1 enables remote registrations for all records and 0 disables doing
1197 1213
    them.
1198 1214
 
1199
-   Example 1.48. uac.reg_active usage
1215
+   Example 1.49. uac.reg_active usage
1200 1216
 ...
1201 1217
    kamctl rpc uac.reg_active 0
1202 1218
    kamctl rpc uac.reg_active 1
... ...
@@ -1227,7 +1243,7 @@ event_route[uac:reply] {
1227 1243
    Use a dot (.) if no value should be set for auth_password, auth_ha1, or
1228 1244
    contact_addr.
1229 1245
 
1230
-   Example 1.49. uac.reg_add usage
1246
+   Example 1.50. uac.reg_add usage
1231 1247
 ...
1232 1248
    kamcmd uac.reg_add ...
1233 1249
 ...
... ...
@@ -1236,7 +1252,7 @@ event_route[uac:reply] {
1236 1252
 
1237 1253
    Remove a UAC remote registration record by l_uuid.
1238 1254
 
1239
-   Example 1.50. uac.reg_remove usage
1255
+   Example 1.51. uac.reg_remove usage
1240 1256
 ...
1241 1257
    kamcmd uac.reg_remove my_l_uuid
1242 1258
 ...
... ...
@@ -1292,7 +1308,7 @@ event_route[uac:reply] {
1292 1308
    if the call is coming from a remote SIP provider and can change the
1293 1309
    R-URI to local username@domain. Afterwards you can run location lookup.
1294 1310
 
1295
-   Example 1.51. lookup remote registrations usage
1311
+   Example 1.52. lookup remote registrations usage
1296 1312
 ...
1297 1313
     if(uac_reg_lookup("$rU", "$ru")) {
1298 1314
         xlog("request from a remote SIP provider [$ou => $ru]\n");