[sr-dev] git:master: uac Fixing formatting
Olle E. Johansson
oej at edvina.net
Mon Oct 29 19:51:10 CET 2012
Module: sip-router
Branch: master
Commit: c244c7aeac06e4707ae76571dc73b804af31640f
URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=c244c7aeac06e4707ae76571dc73b804af31640f
Author: Olle E. Johansson <oej at edvina.net>
Committer: Olle E. Johansson <oej at edvina.net>
Date: Mon Oct 29 19:50:48 2012 +0100
uac Fixing formatting
---
modules_k/uac/README | 107 ++++++++++++++++++++-------------------
modules_k/uac/doc/uac_admin.xml | 26 +++++-----
2 files changed, 67 insertions(+), 66 deletions(-)
diff --git a/modules_k/uac/README b/modules_k/uac/README
index 699b78b..7c115c3 100644
--- a/modules_k/uac/README
+++ b/modules_k/uac/README
@@ -44,23 +44,23 @@ Ramona-Elena Modroiu
3.11. auth_password_avp (string)
3.12. reg_db_url (string)
3.13. reg_timer_interval (string)
+ 3.14. reg_contact_addr (string)
- 4. reg_contact_addr (string)
- 5. Functions
+ 4. Functions
- 5.1. uac_replace_from(display,uri)
- 5.2. uac_replace_from(uri)
- 5.3. uac_restore_from()
- 5.4. uac_replace_to(display,uri)
- 5.5. uac_replace_to(uri)
- 5.6. uac_restore_to()
- 5.7. uac_auth()
- 5.8. uac_req_send()
- 5.9. uac_reg_lookup(uuid, dst)
- 5.10. uac_reg_request_to(user, mode)
+ 4.1. uac_replace_from(display,uri)
+ 4.2. uac_replace_from(uri)
+ 4.3. uac_restore_from()
+ 4.4. uac_replace_to(display,uri)
+ 4.5. uac_replace_to(uri)
+ 4.6. uac_restore_to()
+ 4.7. uac_auth()
+ 4.8. uac_req_send()
+ 4.9. uac_reg_lookup(uuid, dst)
+ 4.10. uac_reg_request_to(user, mode)
- 6. Exported pseudo-variables
- 7. Remote Registration
+ 5. Exported pseudo-variables
+ 6. Remote Registration
List of Examples
@@ -115,23 +115,23 @@ Chapter 1. Admin Guide
3.11. auth_password_avp (string)
3.12. reg_db_url (string)
3.13. reg_timer_interval (string)
+ 3.14. reg_contact_addr (string)
- 4. reg_contact_addr (string)
- 5. Functions
+ 4. Functions
- 5.1. uac_replace_from(display,uri)
- 5.2. uac_replace_from(uri)
- 5.3. uac_restore_from()
- 5.4. uac_replace_to(display,uri)
- 5.5. uac_replace_to(uri)
- 5.6. uac_restore_to()
- 5.7. uac_auth()
- 5.8. uac_req_send()
- 5.9. uac_reg_lookup(uuid, dst)
- 5.10. uac_reg_request_to(user, mode)
+ 4.1. uac_replace_from(display,uri)
+ 4.2. uac_replace_from(uri)
+ 4.3. uac_restore_from()
+ 4.4. uac_replace_to(display,uri)
+ 4.5. uac_replace_to(uri)
+ 4.6. uac_restore_to()
+ 4.7. uac_auth()
+ 4.8. uac_req_send()
+ 4.9. uac_reg_lookup(uuid, dst)
+ 4.10. uac_reg_request_to(user, mode)
- 6. Exported pseudo-variables
- 7. Remote Registration
+ 5. Exported pseudo-variables
+ 6. Remote Registration
1. Overview
@@ -189,6 +189,7 @@ Chapter 1. Admin Guide
3.11. auth_password_avp (string)
3.12. reg_db_url (string)
3.13. reg_timer_interval (string)
+ 3.14. reg_contact_addr (string)
3.1. rr_from_store_param (string)
@@ -357,7 +358,7 @@ modparam("uac","auth_password_avp","$avp(i:12)")
Example 1.12. Set reg_db_url parameter
...
modparam("uac", "reg_db_url",
- "mysql://openser:openserrw@localhost/openser")
+ "mysql://kamailio:kamailiorw@localhost/kamailio")
...
3.13. reg_timer_interval (string)
@@ -372,7 +373,7 @@ modparam("uac", "reg_db_url",
modparam("uac", "reg_timer_interval", 60)
...
-4. reg_contact_addr (string)
+3.14. reg_contact_addr (string)
Address to be used to build contact address. Must be at least host
part, can have port and parameters. Must not include 'sip:'.
@@ -382,20 +383,20 @@ modparam("uac", "reg_timer_interval", 60)
modparam("uac", "reg_contact_addr", "192.168.1.2:5080")
...
-5. Functions
+4. Functions
- 5.1. uac_replace_from(display,uri)
- 5.2. uac_replace_from(uri)
- 5.3. uac_restore_from()
- 5.4. uac_replace_to(display,uri)
- 5.5. uac_replace_to(uri)
- 5.6. uac_restore_to()
- 5.7. uac_auth()
- 5.8. uac_req_send()
- 5.9. uac_reg_lookup(uuid, dst)
- 5.10. uac_reg_request_to(user, mode)
+ 4.1. uac_replace_from(display,uri)
+ 4.2. uac_replace_from(uri)
+ 4.3. uac_restore_from()
+ 4.4. uac_replace_to(display,uri)
+ 4.5. uac_replace_to(uri)
+ 4.6. uac_restore_to()
+ 4.7. uac_auth()
+ 4.8. uac_req_send()
+ 4.9. uac_reg_lookup(uuid, dst)
+ 4.10. uac_reg_request_to(user, mode)
-5.1. uac_replace_from(display,uri)
+4.1. uac_replace_from(display,uri)
Replace in FROM header the display name and the URI part.
@@ -433,7 +434,7 @@ uac_replace_from("","sip:robin at gotham.org");
uac_replace_from("","");
...
-5.2. uac_replace_from(uri)
+4.2. uac_replace_from(uri)
Replace in FROM header the URI part without altering the display name.
@@ -446,7 +447,7 @@ uac_replace_from("","");
uac_replace_from("sip:batman at gotham.org");
...
-5.3. uac_restore_from()
+4.3. uac_restore_from()
This function will check if the FROM URI was modified and will use the
information stored in header parameter to restore the original FROM URI
@@ -459,7 +460,7 @@ uac_replace_from("sip:batman at gotham.org");
uac_restore_from();
...
-5.4. uac_replace_to(display,uri)
+4.4. uac_replace_to(display,uri)
Replace in TO header the display name and the URI part.
@@ -479,7 +480,7 @@ uac_replace_to("","sip:robin at gotham.org");
uac_replace_to("","");
...
-5.5. uac_replace_to(uri)
+4.5. uac_replace_to(uri)
Replace in TO header the URI part without altering the display name.
@@ -510,7 +511,7 @@ uac_replace_to("","");
uac_replace_to("sip:batman at gotham.org");
...
-5.6. uac_restore_to()
+4.6. uac_restore_to()
This function will check if the TO URI was modified and will use the
information stored in header parameter to restore the original TO URI
@@ -523,7 +524,7 @@ uac_replace_to("sip:batman at gotham.org");
uac_restore_to();
...
-5.7. uac_auth()
+4.7. uac_auth()
This function can be called only from failure route and will build the
authentication response header and insert it into the request without
@@ -536,7 +537,7 @@ uac_restore_to();
uac_auth();
...
-5.8. uac_req_send()
+4.8. uac_req_send()
This function sends a SIP message from the configuration file. The
message is built out of $uac_req(...) pseudo-variable.
@@ -553,7 +554,7 @@ $uac_req(turi)="sip:kamailio.org";
uac_req_send();
...
-5.9. uac_reg_lookup(uuid, dst)
+4.9. uac_reg_lookup(uuid, dst)
This function sets the PV dst to SIP URI that correspond to uuid in uac
registations table. uuid and dst must be pseudo-variables.
@@ -569,7 +570,7 @@ if(uac_reg_lookup("$rU", "$ru"))
}
...
-5.10. uac_reg_request_to(user, mode)
+4.10. 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
@@ -602,14 +603,14 @@ failure_route[REMOTE_AUTH] {
}
...
-6. Exported pseudo-variables
+5. Exported pseudo-variables
* $uac_req(key)
Exported pseudo-variables are documented at
http://www.kamailio.org/dokuwiki/.
-7. Remote Registration
+6. Remote Registration
The module can register contact addresses to remote REGISTRAR servers.
You have to add records to uacreg table. The table stores following
diff --git a/modules_k/uac/doc/uac_admin.xml b/modules_k/uac/doc/uac_admin.xml
index 53a1fa1..f663688 100644
--- a/modules_k/uac/doc/uac_admin.xml
+++ b/modules_k/uac/doc/uac_admin.xml
@@ -395,25 +395,25 @@ modparam("uac", "reg_timer_interval", 60)
</example>
</section>
- </section>
- <section id="reg-contact-addr-id">
- <title><varname>reg_contact_addr</varname> (string)</title>
- <para>
- Address to be used to build contact address. Must be at least
- host part, can have port and parameters. Must not include 'sip:'.
- </para>
- <example>
- <title>Set <varname>reg_contact_addr</varname> parameter</title>
- <programlisting format="linespecific">
+ <section id="reg-contact-addr-id">
+ <title><varname>reg_contact_addr</varname> (string)</title>
+ <para>
+ Address to be used to build contact address. Must be at least
+ host part, can have port and parameters. Must not include 'sip:'.
+ </para>
+ <example>
+ <title>Set <varname>reg_contact_addr</varname> parameter</title>
+ <programlisting format="linespecific">
...
modparam("uac", "reg_contact_addr", "192.168.1.2:5080")
...
- </programlisting>
- </example>
- </section>
+ </programlisting>
+ </example>
+ </section>
+ </section>
<section>
<title>Functions</title>
More information about the sr-dev
mailing list