Module: sip-router
Branch: master
Commit: 54d7dcb7574589a831b1561f5ec93a7d9a572459
URL:
http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=54d7dcb…
Author: Daniel-Constantin Mierla <miconda(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: Mon Jul 21 13:25:38 2014 +0200
uac: documented the new rpc command uac.reg_info
---
modules/uac/README | 21 +++++++++++++++++++--
modules/uac/doc/uac_admin.xml | 22 ++++++++++++++++++++++
2 files changed, 41 insertions(+), 2 deletions(-)
diff --git a/modules/uac/README b/modules/uac/README
index ac635c7..6bd44b2 100644
--- a/modules/uac/README
+++ b/modules/uac/README
@@ -65,6 +65,7 @@ Ramona-Elena Modroiu
6. RPC Commands
6.1. uac.reg_dump
+ 6.2. uac.reg_info
7. Remote Registration
@@ -97,7 +98,8 @@ Ramona-Elena Modroiu
1.25. uac_reg_lookup usage
1.26. uac_reg_request_to usage
1.27. uac.reg_dump usage
- 1.28. lookup remote registrations usage
+ 1.28. uac.reg_info usage
+ 1.29. lookup remote registrations usage
Chapter 1. Admin Guide
@@ -145,6 +147,7 @@ Chapter 1. Admin Guide
6. RPC Commands
6.1. uac.reg_dump
+ 6.2. uac.reg_info
7. Remote Registration
@@ -677,6 +680,7 @@ failure_route[REMOTE_AUTH] {
6. RPC Commands
6.1. uac.reg_dump
+ 6.2. uac.reg_info
6.1. uac.reg_dump
@@ -687,6 +691,19 @@ failure_route[REMOTE_AUTH] {
kamcmd uac.reg_dump
...
+6.2. uac.reg_info
+
+ Return the details of a remote registration record based on a filter.
+ The command has two parameter: attribute and value. The attribute can
+ be: l_uuid, l_username, r_username or auth_username. The value is what
+ should be matcheg against the value of the attribute in the remote
+ registration record.
+
+ Example 1.28. uac.reg_info usage
+...
+ kamcmd uac.reg_info l_uuid account123
+...
+
7. Remote Registration
The module can register contact addresses to remote REGISTRAR servers.
@@ -720,7 +737,7 @@ failure_route[REMOTE_AUTH] {
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.28. lookup remote registrations usage
+ Example 1.29. 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 b312f5c..a579255 100644
--- a/modules/uac/doc/uac_admin.xml
+++ b/modules/uac/doc/uac_admin.xml
@@ -815,6 +815,28 @@ failure_route[REMOTE_AUTH] {
</example>
</section>
+ <section id="uac.r.uac.reg_info">
+ <title>
+ <function moreinfo="none">uac.reg_info</function>
+ </title>
+ <para>
+ Return the details of a remote registration record based on
+ a filter. The command has two parameter: attribute and value.
+ The attribute can be: l_uuid, l_username, r_username or auth_username.
+ The value is what should be matcheg against the value of the attribute
+ in the remote registration record.
+ </para>
+ <example>
+ <title><function>uac.reg_info</function> usage</title>
+ <programlisting format="linespecific">
+...
+ kamcmd uac.reg_info l_uuid account123
+...
+ </programlisting>
+ </example>
+
+ </section>
+
</section>
<section>