[sr-dev] git:master: uac: documentation for rpc command uac.reg_refresh

[Daniel-Constantin Mierla]

Module: sip-router
Branch: master
Commit: b61ac1ca1cc410915e61c122350b8af3e4690a93
URL:    http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=b61ac1ca1cc410915e61c122350b8af3e4690a93

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date:   Fri Jul 25 18:08:41 2014 +0200

uac: documentation for rpc command uac.reg_refresh

---

 modules/uac/README            |   20 ++++++++++++++++++--
 modules/uac/doc/uac_admin.xml |   20 ++++++++++++++++++++
 2 files changed, 38 insertions(+), 2 deletions(-)

diff --git a/modules/uac/README b/modules/uac/README
index a709f8d..79070c0 100644
--- a/modules/uac/README
+++ b/modules/uac/README
@@ -69,6 +69,7 @@ Ramona-Elena Modroiu
               6.3. uac.reg_enable
               6.4. uac.reg_disable
               6.5. uac.reg_reload
+              6.6. uac.reg_refresh
 
         7. Remote Registration
 
@@ -105,7 +106,8 @@ Ramona-Elena Modroiu
    1.29. uac.reg_enable usage
    1.30. uac.reg_disable usage
    1.31. uac.reg_reload usage
-   1.32. lookup remote registrations usage
+   1.32. uac.reg_refresh usage
+   1.33. lookup remote registrations usage
 
 Chapter 1. Admin Guide
 
@@ -157,6 +159,7 @@ Chapter 1. Admin Guide
         6.3. uac.reg_enable
         6.4. uac.reg_disable
         6.5. uac.reg_reload
+        6.6. uac.reg_refresh
 
    7. Remote Registration
 
@@ -693,6 +696,7 @@ failure_route[REMOTE_AUTH] {
    6.3. uac.reg_enable
    6.4. uac.reg_disable
    6.5. uac.reg_reload
+   6.6. uac.reg_refresh
 
 6.1. uac.reg_dump
 
@@ -751,6 +755,18 @@ failure_route[REMOTE_AUTH] {
    kamcmd uac.reg_reload
 ...
 
+6.6. uac.reg_refresh
+
+   Load one record by l_uuid from database for remote registrations. If
+   the record exists in memory, its authentication password is updated,
+   otherwise a new record is added. The command has a parameter, which is
+   the value of l_uuid field.
+
+   Example 1.32. uac.reg_refresh usage
+...
+   kamcmd uac.reg_refresh account123
+...
+
 7. Remote Registration
 
    The module can register contact addresses to remote REGISTRAR servers.
@@ -784,7 +800,7 @@ failure_route[REMOTE_AUTH] {
    if the call is coming from a remote SIP provider and can change the
    R-URI to local username at domain. Afterwards you can run location lookup.
 
-   Example 1.32. lookup remote registrations usage
+   Example 1.33. lookup remote registrations usage
 ...
     if(uac_reg_lookup("$rU", "$ru")) {
         xlog("request from a remote SIP provider [$ou => $ru]\n");
diff --git a/modules/uac/doc/uac_admin.xml b/modules/uac/doc/uac_admin.xml
index 45cab3c..f4c5580 100644
--- a/modules/uac/doc/uac_admin.xml
+++ b/modules/uac/doc/uac_admin.xml
@@ -895,6 +895,26 @@ failure_route[REMOTE_AUTH] {
 		</example>
 		</section>
 
+		<section id="uac.r.uac.reg_refresh">
+			<title>
+				<function moreinfo="none">uac.reg_refresh</function>
+			</title>
+		<para>
+			Load one record by l_uuid from database for remote registrations.
+			If the record exists in memory, its authentication password is
+			updated, otherwise a new record is added. The command has a
+			parameter, which is the value of l_uuid field.
+		</para>
+		<example>
+		<title><function>uac.reg_refresh</function> usage</title>
+			<programlisting format="linespecific">
+...
+   kamcmd uac.reg_refresh account123
+...
+			</programlisting>
+		</example>
+		</section>
+
 	</section>
 
 	<section>