modules: readme files regenerated - uac ... [skip ci] master
authorKamailio Dev <kamailio.dev@kamailio.org>
Fri, 7 May 2021 06:16:20 +0000 (08:16 +0200)
committerKamailio Dev <kamailio.dev@kamailio.org>
Fri, 7 May 2021 06:16:20 +0000 (08:16 +0200)
src/modules/uac/README

index 7b08451..45e159f 100644 (file)
@@ -67,11 +67,12 @@ Ramona-Elena Modroiu
               4.8. uac_auth_mode(vmode)
               4.9. uac_req_send()
               4.10. uac_reg_lookup(uuid, dst)
-              4.11. uac_reg_status(uuid)
-              4.12. uac_reg_request_to(user, mode)
-              4.13. uac_reg_enable(attr, val)
-              4.14. uac_reg_disable(attr, val)
-              4.15. uac_reg_refresh(luuid)
+              4.11. uac_reg_lookup_uri(uri, dst)
+              4.12. uac_reg_status(uuid)
+              4.13. uac_reg_request_to(user, mode)
+              4.14. uac_reg_enable(attr, val)
+              4.15. uac_reg_disable(attr, val)
+              4.16. uac_reg_refresh(luuid)
 
         5. Pseudo Variables
         6. Event Routes
@@ -129,23 +130,24 @@ Ramona-Elena Modroiu
    1.31. uac_auth_mode usage
    1.32. uac_req_send usage
    1.33. uac_reg_lookup usage
-   1.34. uac_reg_status usage
-   1.35. uac_reg_request_to usage
-   1.36. uac_reg_enable usage
-   1.37. uac_reg_disable usage
-   1.38. uac_reg_refresh usage
-   1.39. event_route[uac:reply] usage
-   1.40. uac.reg_dump usage
-   1.41. uac.reg_info usage
-   1.42. uac.reg_enable usage
-   1.43. uac.reg_disable usage
-   1.44. uac.reg_unregister usage
-   1.45. uac.reg_reload usage
-   1.46. uac.reg_refresh usage
-   1.47. uac.reg_active usage
-   1.48. uac.reg_add usage
-   1.49. uac.reg_remove usage
-   1.50. lookup remote registrations usage
+   1.34. uac_reg_lookup_uri usage
+   1.35. uac_reg_status usage
+   1.36. uac_reg_request_to usage
+   1.37. uac_reg_enable usage
+   1.38. uac_reg_disable usage
+   1.39. uac_reg_refresh usage
+   1.40. event_route[uac:reply] usage
+   1.41. uac.reg_dump usage
+   1.42. uac.reg_info usage
+   1.43. uac.reg_enable usage
+   1.44. uac.reg_disable usage
+   1.45. uac.reg_unregister usage
+   1.46. uac.reg_reload usage
+   1.47. uac.reg_refresh usage
+   1.48. uac.reg_active usage
+   1.49. uac.reg_add usage
+   1.50. uac.reg_remove usage
+   1.51. lookup remote registrations usage
 
 Chapter 1. Admin Guide
 
@@ -195,11 +197,12 @@ Chapter 1. Admin Guide
         4.8. uac_auth_mode(vmode)
         4.9. uac_req_send()
         4.10. uac_reg_lookup(uuid, dst)
-        4.11. uac_reg_status(uuid)
-        4.12. uac_reg_request_to(user, mode)
-        4.13. uac_reg_enable(attr, val)
-        4.14. uac_reg_disable(attr, val)
-        4.15. uac_reg_refresh(luuid)
+        4.11. uac_reg_lookup_uri(uri, dst)
+        4.12. uac_reg_status(uuid)
+        4.13. uac_reg_request_to(user, mode)
+        4.14. uac_reg_enable(attr, val)
+        4.15. uac_reg_disable(attr, val)
+        4.16. uac_reg_refresh(luuid)
 
    5. Pseudo Variables
    6. Event Routes
@@ -654,11 +657,12 @@ end
    4.8. uac_auth_mode(vmode)
    4.9. uac_req_send()
    4.10. uac_reg_lookup(uuid, dst)
-   4.11. uac_reg_status(uuid)
-   4.12. uac_reg_request_to(user, mode)
-   4.13. uac_reg_enable(attr, val)
-   4.14. uac_reg_disable(attr, val)
-   4.15. uac_reg_refresh(luuid)
+   4.11. uac_reg_lookup_uri(uri, dst)
+   4.12. uac_reg_status(uuid)
+   4.13. uac_reg_request_to(user, mode)
+   4.14. uac_reg_enable(attr, val)
+   4.15. uac_reg_disable(attr, val)
+   4.16. uac_reg_refresh(luuid)
 
 4.1.  uac_replace_from(display,uri)
 
@@ -919,7 +923,24 @@ if(uac_reg_lookup("$rU", "$ru"))
 }
 ...
 
-4.11.  uac_reg_status(uuid)
+4.11.  uac_reg_lookup_uri(uri, dst)
+
+   This function sets the PV dst to SIP URI that correspond to the URI
+   user in uac registrations table. The uri can contain pseudo-variables
+   and dst must be the name of a pseudo-variable.
+
+   This function can be used from ANY_ROUTE.
+
+   Example 1.34. uac_reg_lookup_uri usage
+...
+
+if(uac_reg_lookup("$var(uri)", "$ru"))
+{
+    lookup("location");
+}
+...
+
+4.12.  uac_reg_status(uuid)
 
    This function returns the current registration status for the uuid.
 
@@ -934,12 +955,12 @@ if(uac_reg_lookup("$rU", "$ru"))
 
    This function can be used from ANY_ROUTE.
 
-   Example 1.34. uac_reg_status usage
+   Example 1.35. uac_reg_status usage
 ...
 $var(status) = uac_reg_status("$rU");
 ...
 
-4.12.  uac_reg_request_to(user, mode)
+4.13.  uac_reg_request_to(user, mode)
 
    This function can be used to send an authenticated request to a remote
    user in the uac registrations table. It sets the request-uri, dst-uri
@@ -959,7 +980,7 @@ $var(status) = uac_reg_status("$rU");
    This function can be used from REQUEST_ROUTE, FAILURE_ROUTE,
    BRANCH_ROUTE.
 
-   Example 1.35. uac_reg_request_to usage
+   Example 1.36. uac_reg_request_to usage
 ...
 
 if(uac_reg_request_to("$fU", 0))
@@ -978,7 +999,7 @@ failure_route[REMOTE_AUTH] {
 }
 ...
 
-4.13.  uac_reg_enable(attr, val)
+4.14.  uac_reg_enable(attr, val)
 
    Enable a remote registration record based on a filter specified by
    attribute and value. The attribute can be: l_uuid, l_username,
@@ -987,12 +1008,12 @@ failure_route[REMOTE_AUTH] {
 
    The SIP processing is done on the next timer routine.
 
-   Example 1.36. uac_reg_enable usage
+   Example 1.37. uac_reg_enable usage
 ...
    uac_reg_enable("l_uuid", "account123");
 ...
 
-4.14.  uac_reg_disable(attr, val)
+4.15.  uac_reg_disable(attr, val)
 
    Disable a remote registration record based on a filter specified by
    attribute and value. The attribute can be: l_uuid, l_username,
@@ -1001,18 +1022,18 @@ failure_route[REMOTE_AUTH] {
 
    The SIP processing is done on the next timer routine.
 
-   Example 1.37. uac_reg_disable usage
+   Example 1.38. uac_reg_disable usage
 ...
    uac_reg_disable("l_uuid", "account123");
 ...
 
-4.15.  uac_reg_refresh(luuid)
+4.16.  uac_reg_refresh(luuid)
 
    Refresh the uac remote registration record based on local uuid. If the
    record was already loaded, new values are taken from database,
    otherwise a new record is created.
 
-   Example 1.38. uac_reg_refresh usage
+   Example 1.39. uac_reg_refresh usage
 ...
    uac_reg_refresh("account123");
 ...
@@ -1036,7 +1057,7 @@ failure_route[REMOTE_AUTH] {
    then the event_route is executed twice, first for 401/407 and second
    for final reply of the transaction.
 
-   Example 1.39. event_route[uac:reply] usage
+   Example 1.40. event_route[uac:reply] usage
 ...
 $uac_req(method)="OPTIONS";
 $uac_req(ruri)="sip:kamailio.org";
@@ -1076,7 +1097,7 @@ event_route[uac:reply] {
 
    Dump the content of remote registration table from memory.
 
-   Example 1.40. uac.reg_dump usage
+   Example 1.41. uac.reg_dump usage
 ...
    kamcmd uac.reg_dump
 ...
@@ -1097,7 +1118,7 @@ event_route[uac:reply] {
      * 16 (2^4) - registration initialized (after loading from database,
        the registration process was initialized)
 
-   Example 1.41. uac.reg_info usage
+   Example 1.42. uac.reg_info usage
 ...
    kamcmd uac.reg_info l_uuid account123
    kamcmd uac.reg_info l_uuid s:12345678
@@ -1111,7 +1132,7 @@ event_route[uac:reply] {
    matched against the value of the attribute in the remote registration
    record.
 
-   Example 1.42. uac.reg_enable usage
+   Example 1.43. uac.reg_enable usage
 ...
    kamcmd uac.reg_enable l_uuid account123
    kamcmd uac.reg_enable l_uuid s:12345678
@@ -1125,7 +1146,7 @@ event_route[uac:reply] {
    matched against the value of the attribute in the remote registration
    record.
 
-   Example 1.43. uac.reg_disable usage
+   Example 1.44. uac.reg_disable usage
 ...
    kamcmd uac.reg_disable l_uuid account123
    kamcmd uac.reg_disable l_uuid s:12345678
@@ -1139,7 +1160,7 @@ event_route[uac:reply] {
    should be matched against the value of the attribute in the remote
    registration record.
 
-   Example 1.44. uac.reg_unregister usage
+   Example 1.45. uac.reg_unregister usage
 ...
    kamcmd uac.reg_unregister l_uuid account123
    kamcmd uac.reg_unregister l_uuid s:12345678
@@ -1152,7 +1173,7 @@ event_route[uac:reply] {
    150 seconds between reloads -- see the reg_gc_interval parameter for
    more details.
 
-   Example 1.45. uac.reg_reload usage
+   Example 1.46. uac.reg_reload usage
 ...
    kamcmd uac.reg_reload
 ...
@@ -1163,7 +1184,7 @@ event_route[uac:reply] {
    the record exists in memory, it will be replaced with the new values
    loaded from database.
 
-   Example 1.46. uac.reg_refresh usage
+   Example 1.47. uac.reg_refresh usage
 ...
    kamcmd uac.reg_refresh account123
    kamcmd uac.reg_refresh s:12345678
@@ -1175,7 +1196,7 @@ event_route[uac:reply] {
    1 enables remote registrations for all records and 0 disables doing
    them.
 
-   Example 1.47. uac.reg_active usage
+   Example 1.48. uac.reg_active usage
 ...
    kamctl rpc uac.reg_active 0
    kamctl rpc uac.reg_active 1
@@ -1206,7 +1227,7 @@ event_route[uac:reply] {
    Use a dot (.) if no value should be set for auth_password, auth_ha1, or
    contact_addr.
 
-   Example 1.48. uac.reg_add usage
+   Example 1.49. uac.reg_add usage
 ...
    kamcmd uac.reg_add ...
 ...
@@ -1215,7 +1236,7 @@ event_route[uac:reply] {
 
    Remove a UAC remote registration record by l_uuid.
 
-   Example 1.49. uac.reg_remove usage
+   Example 1.50. uac.reg_remove usage
 ...
    kamcmd uac.reg_remove my_l_uuid
 ...
@@ -1271,7 +1292,7 @@ event_route[uac:reply] {
    if the call is coming from a remote SIP provider and can change the
    R-URI to local username@domain. Afterwards you can run location lookup.
 
-   Example 1.50. lookup remote registrations usage
+   Example 1.51. lookup remote registrations usage
 ...
     if(uac_reg_lookup("$rU", "$ru")) {
         xlog("request from a remote SIP provider [$ou => $ru]\n");