Module: sip-router Branch: master Commit: 27570b56727e788da939fedc84304cf87fc1e179 URL: http://git.sip-router.org/cgi-bin/gitweb.cgi/sip-router/?a=commit;h=27570b5… Author: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Committer: Daniel-Constantin Mierla &lt;miconda(a)gmail.com&gt; Date: Fri Dec 28 22:25:29 2012 +0100 usrloc(k): fixed position of xavp_contact parameter in docs --- modules_k/usrloc/README | 107 +++++++++++++++++---------------- modules_k/usrloc/doc/usrloc_admin.xml | 17 +++--- 2 files changed, 62 insertions(+), 62 deletions(-) diff --git a/modules_k/usrloc/README b/modules_k/usrloc/README index 3fb1710..77d1f83 100644 --- a/modules_k/usrloc/README +++ b/modules_k/usrloc/README @@ -66,24 +66,24 @@ Bogdan-Andrei Iancu 3.28. db_update_as_insert (string) 3.29. db_check_update (string) 3.30. timer_procs (string) + 3.31. xavp_contact (string) 4. Functions - 5. xavp_contact (string) - 6. MI Commands + 5. MI Commands - 6.1. ul_rm - 6.2. ul_rm_contact - 6.3. ul_dump - 6.4. ul_flush - 6.5. ul_add - 6.6. ul_show_contact + 5.1. ul_rm + 5.2. ul_rm_contact + 5.3. ul_dump + 5.4. ul_flush + 5.5. ul_add + 5.6. ul_show_contact - 7. Statistics + 6. Statistics - 7.1. users - 7.2. contacts - 7.3. expires - 7.4. registered_users + 6.1. users + 6.2. contacts + 6.3. expires + 6.4. registered_users 2. Developer Guide @@ -188,24 +188,24 @@ Chapter 1. Admin Guide 3.28. db_update_as_insert (string) 3.29. db_check_update (string) 3.30. timer_procs (string) + 3.31. xavp_contact (string) 4. Functions - 5. xavp_contact (string) - 6. MI Commands + 5. MI Commands - 6.1. ul_rm - 6.2. ul_rm_contact - 6.3. ul_dump - 6.4. ul_flush - 6.5. ul_add - 6.6. ul_show_contact + 5.1. ul_rm + 5.2. ul_rm_contact + 5.3. ul_dump + 5.4. ul_flush + 5.5. ul_add + 5.6. ul_show_contact - 7. Statistics + 6. Statistics - 7.1. users - 7.2. contacts - 7.3. expires - 7.4. registered_users + 6.1. users + 6.2. contacts + 6.3. expires + 6.4. registered_users 1. Overview @@ -295,6 +295,7 @@ Chapter 1. Admin Guide 3.28. db_update_as_insert (string) 3.29. db_check_update (string) 3.30. timer_procs (string) + 3.31. xavp_contact (string) 3.1. nat_bflag (integer) @@ -704,11 +705,7 @@ modparam("usrloc", "db_check_update", 1) modparam("usrloc", "timer_procs", 4) ... -4. Functions - - There are no exported functions that could be used in scripts. - -5. xavp_contact (string) +3.31. xavp_contact (string) The name of XAVP storring the attributes per contact. They are saved in location record and restored at lookup. @@ -720,16 +717,20 @@ modparam("usrloc", "timer_procs", 4) modparam("usrloc", "xavp_contact", "ulattrs") ... -6. MI Commands +4. Functions + + There are no exported functions that could be used in scripts. + +5. MI Commands - 6.1. ul_rm - 6.2. ul_rm_contact - 6.3. ul_dump - 6.4. ul_flush - 6.5. ul_add - 6.6. ul_show_contact + 5.1. ul_rm + 5.2. ul_rm_contact + 5.3. ul_dump + 5.4. ul_flush + 5.5. ul_add + 5.6. ul_show_contact -6.1. ul_rm +5.1. ul_rm Deletes an entire AOR record (including its contacts). @@ -738,7 +739,7 @@ modparam("usrloc", "xavp_contact", "ulattrs") * AOR - user AOR in username[@domain] format (domain must be supplied only if use_domain option is on). -6.2. ul_rm_contact +5.2. ul_rm_contact Deletes a contact from an AOR record. @@ -748,7 +749,7 @@ modparam("usrloc", "xavp_contact", "ulattrs") only if use_domain option is on). * contact - exact contact to be removed -6.3. ul_dump +5.3. ul_dump Dumps the entire content of the USRLOC in memory cache @@ -757,11 +758,11 @@ modparam("usrloc", "xavp_contact", "ulattrs") "brief", a brief dump will be done (only AOR and contacts, with no other details) -6.4. ul_flush +5.4. ul_flush Triggers the flush of USRLOC memory cache into DB. -6.5. ul_add +5.5. ul_add Adds a new contact for an user AOR. @@ -777,7 +778,7 @@ modparam("usrloc", "xavp_contact", "ulattrs") * cflags - per branch flags of the contact * methods - mask with supported requests of the contact -6.6. ul_show_contact +5.6. ul_show_contact Dumps the contacts of an user AOR. @@ -786,33 +787,33 @@ modparam("usrloc", "xavp_contact", "ulattrs") * AOR - user AOR in username[@domain] format (domain must be supplied only if use_domain option is on). -7. Statistics +6. Statistics - 7.1. users - 7.2. contacts - 7.3. expires - 7.4. registered_users + 6.1. users + 6.2. contacts + 6.3. expires + 6.4. registered_users Exported statistics are listed in the next sections. -7.1. users +6.1. users Number of AOR existing in the USRLOC memory cache for that domain - can not be resetted; this statistic will be register for each used domain (Ex: location). -7.2. contacts +6.2. contacts Number of contacts existing in the USRLOC memory cache for that domain - can not be resetted; this statistic will be register for each used domain (Ex: location). -7.3. expires +6.3. expires Total number of expired contacts for that domain - can be resetted; this statistic will be register for each used domain (Ex: location). -7.4. registered_users +6.4. registered_users Total number of AOR existing in the USRLOC memory cache for all domains - can not be resetted. diff --git a/modules_k/usrloc/doc/usrloc_admin.xml b/modules_k/usrloc/doc/usrloc_admin.xml index 85fa2a2..86c25cc 100644 --- a/modules_k/usrloc/doc/usrloc_admin.xml +++ b/modules_k/usrloc/doc/usrloc_admin.xml @@ -823,15 +823,6 @@ modparam("usrloc", "timer_procs", 4) </example> </section> - </section> - - <section> - <title>Functions</title> - <para> - There are no exported functions that could be used in scripts. - </para> - </section> - <section id="xavp_contact"> <title><varname>xavp_contact</varname> (string)</title> <para> @@ -853,6 +844,14 @@ modparam("usrloc", "xavp_contact", "ulattrs") </example> </section> + </section> + + <section> + <title>Functions</title> + <para> + There are no exported functions that could be used in scripts. + </para> + </section> <section> <title>MI Commands</title>