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

Author: Olle E. Johansson oej@edvina.net Committer: Olle E. Johansson oej@edvina.net Date: Wed Jan 9 15:29:48 2013 +0100

usrloc(k) Reveal existing rpc command in README

---

modules_k/usrloc/README | 99 +++++++++++++++++++------------- modules_k/usrloc/doc/usrloc_admin.xml | 18 ++++++ 2 files changed, 77 insertions(+), 40 deletions(-)

diff --git a/modules_k/usrloc/README b/modules_k/usrloc/README index 77d1f83..b764fe1 100644 --- a/modules_k/usrloc/README +++ b/modules_k/usrloc/README @@ -78,12 +78,16 @@ Bogdan-Andrei Iancu 5.5. ul_add 5.6. ul_show_contact

- 6. Statistics + 6. RPC Commands

- 6.1. users - 6.2. contacts - 6.3. expires - 6.4. registered_users + 6.1. ul.dump + + 7. Statistics + + 7.1. users + 7.2. contacts + 7.3. expires + 7.4. registered_users

2. Developer Guide

@@ -200,12 +204,16 @@ Chapter 1. Admin Guide 5.5. ul_add 5.6. ul_show_contact

- 6. Statistics + 6. RPC Commands + + 6.1. ul.dump

- 6.1. users - 6.2. contacts - 6.3. expires - 6.4. registered_users + 7. Statistics + + 7.1. users + 7.2. contacts + 7.3. expires + 7.4. registered_users

1. Overview

@@ -730,7 +738,7 @@ modparam("usrloc", "xavp_contact", "ulattrs") 5.5. ul_add 5.6. ul_show_contact

-5.1. ul_rm +5.1. ul_rm

Deletes an entire AOR record (including its contacts).

@@ -739,7 +747,7 @@ modparam("usrloc", "xavp_contact", "ulattrs") * AOR - user AOR in username[@domain] format (domain must be supplied only if use_domain option is on).

-5.2. ul_rm_contact +5.2. ul_rm_contact

Deletes a contact from an AOR record.

@@ -749,7 +757,7 @@ modparam("usrloc", "xavp_contact", "ulattrs") only if use_domain option is on). * contact - exact contact to be removed

-5.3. ul_dump +5.3. ul_dump

Dumps the entire content of the USRLOC in memory cache

@@ -758,11 +766,11 @@ modparam("usrloc", "xavp_contact", "ulattrs") "brief", a brief dump will be done (only AOR and contacts, with no other details)

-5.4. ul_flush +5.4. ul_flush

Triggers the flush of USRLOC memory cache into DB.

-5.5. ul_add +5.5. ul_add

Adds a new contact for an user AOR.

@@ -778,7 +786,7 @@ modparam("usrloc", "xavp_contact", "ulattrs") * cflags - per branch flags of the contact * methods - mask with supported requests of the contact

-5.6. ul_show_contact +5.6. ul_show_contact

Dumps the contacts of an user AOR.

@@ -787,33 +795,44 @@ modparam("usrloc", "xavp_contact", "ulattrs") * AOR - user AOR in username[@domain] format (domain must be supplied only if use_domain option is on).

-6. Statistics +6. RPC Commands + + 6.1. ul.dump + +6.1. ul.dump + + Dumps the content of the location table + + Parameters: + * None. + +7. Statistics

- 6.1. users - 6.2. contacts - 6.3. expires - 6.4. registered_users + 7.1. users + 7.2. contacts + 7.3. expires + 7.4. registered_users

Exported statistics are listed in the next sections.

-6.1. users +7.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).

-6.2. contacts +7.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).

-6.3. expires +7.3. expires

Total number of expired contacts for that domain - can be resetted; this statistic will be register for each used domain (Ex: location).

-6.4. registered_users +7.4. registered_users

Total number of AOR existing in the USRLOC memory cache for all domains - can not be resetted. @@ -866,7 +885,7 @@ Chapter 2. Developer Guide 1.14. ul_register_ulcb(type ,callback, param) 1.15. ul_get_num_users()

-1.1. ul_register_domain(name) +1.1. ul_register_domain(name)

The function registers a new domain. Domain is just another name for table used in registrar. The function is called from fixups in @@ -881,7 +900,7 @@ Chapter 2. Developer Guide * const char* name - Name of the domain (also called table) to be registered.

-1.2. ul_insert_urecord(domain, aor, rec) +1.2. ul_insert_urecord(domain, aor, rec)

The function creates a new record structure and inserts it in the specified domain. The record is structure that contains all the @@ -896,7 +915,7 @@ Chapter 2. Developer Guide

* urecord_t** rec - The newly created record structure.

-1.3. ul_delete_urecord(domain, aor) +1.3. ul_delete_urecord(domain, aor)

The function deletes all the contacts bound with the given Address Of Record. @@ -908,7 +927,7 @@ Chapter 2. Developer Guide * str* aor - Address of record (aka username) of the record, that should be deleted.

-1.4. ul_get_urecord(domain, aor) +1.4. ul_get_urecord(domain, aor)

The function returns pointer to record with given Address of Record.

@@ -918,7 +937,7 @@ Chapter 2. Developer Guide

* str* aor - Address of Record of request record.

-1.5. ul_lock_udomain(domain) +1.5. ul_lock_udomain(domain)

The function lock the specified domain, it means, that no other processes will be able to access during the time. This prevents race @@ -929,14 +948,14 @@ Chapter 2. Developer Guide Meaning of the parameters is as follows: * udomain_t* domain - Domain to be locked.

-1.6. ul_unlock_udomain(domain) +1.6. ul_unlock_udomain(domain)

Unlock the specified domain previously locked by ul_lock_udomain.

Meaning of the parameters is as follows: * udomain_t* domain - Domain to be unlocked.

-1.7. ul_release_urecord(record) +1.7. ul_release_urecord(record)

Do some sanity checks - if all contacts have been removed, delete the entire record structure. @@ -944,7 +963,7 @@ Chapter 2. Developer Guide Meaning of the parameters is as follows: * urecord_t* record - Record to be released.

-1.8. ul_insert_ucontact(record, contact, expires, q, callid, cseq, flags, +1.8. ul_insert_ucontact(record, contact, expires, q, callid, cseq, flags, cont, ua, sock)

The function inserts a new contact in the given record with specified @@ -965,7 +984,7 @@ cont, ua, sock) * struct socket_info *sock - socket on which the REGISTER message was received on.

-1.9. ul_delete_ucontact (record, contact) +1.9. ul_delete_ucontact (record, contact)

The function deletes given contact from record.

@@ -975,7 +994,7 @@ cont, ua, sock)

* ucontact_t* contact - Contact to be deleted.

-1.10. ul_get_ucontact(record, contact) +1.10. ul_get_ucontact(record, contact)

The function tries to find contact with given Contact URI and returns pointer to structure representing the contact. @@ -985,7 +1004,7 @@ cont, ua, sock)

* str_t* contact - URI of the request contact.

-1.11. ul_get_all_ucontacts (buf, len, flags) +1.11. ul_get_all_ucontacts (buf, len, flags)

The function retrieves all contacts of all registered users and returns them in the caller-supplied buffer. If the buffer is too small, the @@ -1006,7 +1025,7 @@ cont, ua, sock)

* unsigned int flags - Flags that must be set.

-1.12. ul_update_ucontact(contact, expires, q, callid, cseq, set, res, ua, +1.12. ul_update_ucontact(contact, expires, q, callid, cseq, set, res, ua, sock)

The function updates contact with new values. @@ -1025,7 +1044,7 @@ sock) * struct socket_info *sock - socket on which the REGISTER message was received on.

-1.13. ul_bind_ursloc( api ) +1.13. ul_bind_ursloc( api )

The function imports all functions that are exported by the USRLOC module. Overs for other modules which want to user the internal USRLOC @@ -1034,7 +1053,7 @@ sock) Meaning of the parameters is as follows: * usrloc_api_t* api - USRLOC API

-1.14. ul_register_ulcb(type ,callback, param) +1.14. ul_register_ulcb(type ,callback, param)

The function register with USRLOC a callback function to be called when some event occures inside USRLOC. @@ -1047,6 +1066,6 @@ sock) * void *param - some parameter to be passed to the callback each time when it is called.

-1.15. ul_get_num_users() +1.15. ul_get_num_users()

The function loops through all domains summing up the number of users. diff --git a/modules_k/usrloc/doc/usrloc_admin.xml b/modules_k/usrloc/doc/usrloc_admin.xml index 86c25cc..6143ea6 100644 --- a/modules_k/usrloc/doc/usrloc_admin.xml +++ b/modules_k/usrloc/doc/usrloc_admin.xml @@ -994,7 +994,25 @@ modparam("usrloc", "xavp_contact", "ulattrs") </itemizedlist> </section>

+ </section><!-- MI commands --> + <section> + <title>RPC Commands</title> + + <section> + <title> + <function moreinfo="none">ul.dump</function> + </title> + <para> + Dumps the content of the location table + </para> + <para>Parameters: </para> + <itemizedlist> + <listitem><para> + None. + </para></listitem> + </itemizedlist> </section> + </section><!-- RPC commands -->

<section>