diff --git a/src/modules/usrloc/doc/usrloc.xml b/src/modules/usrloc/doc/usrloc.xml
index 133672073a9..d9a7d3520e4 100644
--- a/src/modules/usrloc/doc/usrloc.xml
+++ b/src/modules/usrloc/doc/usrloc.xml
@@ -63,9 +63,9 @@
-
+
-
-
+
+
diff --git a/src/modules/usrloc/doc/usrloc_admin.xml b/src/modules/usrloc/doc/usrloc_admin.xml
index 5f244bc80e5..5c0796935c7 100644
--- a/src/modules/usrloc/doc/usrloc_admin.xml
+++ b/src/modules/usrloc/doc/usrloc_admin.xml
@@ -647,7 +647,7 @@ modparam("usrloc", "db_url", "&exampledb;")
The usrloc module can utilize a database for persistent contact storage.
If a database is used, the location database (contacts) will survive
- machine restarts or software crashes. The disadvantage is that accessing
+ machine restarts or software crashes. The disadvantage is that accessing
a database can be very time consuming. Therefore, usrloc module implements
four database accessing modes:
@@ -974,9 +974,9 @@ modparam("usrloc", "db_check_update", 1)
- If the number of timer processes is greater than 1, the workload
- of synchronization and record expiration is split up among the
- multiple processes. (Each process is assigned a range of slots
+ If the number of timer processes is greater than 1, the workload
+ of synchronization and record expiration is split up among the
+ multiple processes. (Each process is assigned a range of slots
from the internal hash table, and is responsible for cleanup and
storage on those slots.)
@@ -1276,7 +1276,7 @@ modparam("usrloc", "version_table", 0)
Keepalive mode - control the internal keepalive mechanism. With this feature
enabled, the module sends periodically (based on timer interval) SIP requests
to location contacts and measures the round trip in microseconds (the
- round trip value can be seen in the response of the RPC command 'ul.dump').
+ round trip value can be seen in the response of the RPC command 'ul.dump').
Its value is a set of flags:
diff --git a/src/modules/usrloc/doc/usrloc_devel.xml b/src/modules/usrloc/doc/usrloc_devel.xml
index 623daed8dc0..025b5f7b615 100644
--- a/src/modules/usrloc/doc/usrloc_devel.xml
+++ b/src/modules/usrloc/doc/usrloc_devel.xml
@@ -10,7 +10,7 @@
-
+
&develguide;
Available Functions
@@ -19,19 +19,19 @@
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
- registrar. It gets name of the domain as a parameter and returns
- pointer to a new domain structure. The fixup than 'fixes' the
+ The function registers a new domain. Domain is just another name for
+ table used in registrar. The function is called from fixups in
+ registrar. It gets name of the domain as a parameter and returns
+ pointer to a new domain structure. The fixup than 'fixes' the
parameter in registrar so that it will pass the pointer instead of the
- name every time save() or lookup() is called. Some usrloc functions
- get the pointer as parameter when called. For more details see
+ name every time save() or lookup() is called. Some usrloc functions
+ get the pointer as parameter when called. For more details see
implementation of save function in registrar.
Meaning of the parameters is as follows:
- const char* name - Name of the domain
+ const char* name - Name of the domain
(also called table) to be registered.
@@ -43,29 +43,29 @@
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
+ The function creates a new record structure and inserts it in the
+ specified domain. The record is structure that contains all the
contacts for belonging to the specified username.
Meaning of the parameters is as follows:
- udomain_t* domain - Pointer to domain
+ udomain_t* domain - Pointer to domain
returned by ul_register_udomain.
- str* aor - Address of Record (aka
- username) of the new record (at this time the record will
+ str* aor - Address of Record (aka
+ username) of the new record (at this time the record will
contain no contacts yet).
- urecord_t** rec - The newly created
+ urecord_t** rec - The newly created
record structure.
@@ -78,20 +78,20 @@
ul_delete_urecord(domain, aor)
- The function deletes all the contacts bound with the given Address
+ The function deletes all the contacts bound with the given Address
Of Record.
Meaning of the parameters is as follows:
- udomain_t* domain - Pointer to domain
+ udomain_t* domain - Pointer to domain
returned by ul_register_udomain.
- str* aor - Address of record (aka
+ str* aor - Address of record (aka
username) of the record, that should be deleted.
@@ -133,14 +133,14 @@
Meaning of the parameters is as follows:
- udomain_t* domain - Pointer to domain
+ udomain_t* domain - Pointer to domain
returned by ul_register_udomain.
- str* aor - Address of Record of request
+ str* aor - Address of Record of request
record.
@@ -152,10 +152,10 @@
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
- conditions. Scope of the lock is the specified domain, that means,
- that multiple domain can be accessed simultaneously, they don't block
+ The function lock the specified domain, it means, that no other
+ processes will be able to access during the time. This prevents race
+ conditions. Scope of the lock is the specified domain, that means,
+ that multiple domain can be accessed simultaneously, they don't block
each other.
Meaning of the parameters is as follows:
@@ -177,7 +177,7 @@
Meaning of the parameters is as follows:
- udomain_t* domain - Domain to be
+ udomain_t* domain - Domain to be
unlocked.
@@ -189,13 +189,13 @@
ul_release_urecord(record)
- Do some sanity checks - if all contacts have been removed, delete
+ Do some sanity checks - if all contacts have been removed, delete
the entire record structure.
Meaning of the parameters is as follows:
- urecord_t* record - Record to be
+ urecord_t* record - Record to be
released.
@@ -204,17 +204,17 @@
- <function moreinfo="none">ul_insert_ucontact(record, contact,
+ <function moreinfo="none">ul_insert_ucontact(record, contact,
expires, q, callid, cseq, flags, cont, ua, sock)</function>
- The function inserts a new contact in the given record with
+ The function inserts a new contact in the given record with
specified parameters.
Meaning of the parameters is as follows:
- urecord_t* record - Record in which
+ urecord_t* record - Record in which
the contact should be inserted.
@@ -223,7 +223,7 @@
- time_t expires - Expires of the
+ time_t expires - Expires of the
contact in absolute value.
@@ -232,26 +232,26 @@
- str* callid - Call-ID of the REGISTER
+ str* callid - Call-ID of the REGISTER
message that contained the contact.
- int cseq - CSeq of the REGISTER
+ int cseq - CSeq of the REGISTER
message that contained the contact.
unsigned int flags - Flags to be set.
-
+
- ucontact_t* cont - Pointer to newly
+ ucontact_t* cont - Pointer to newly
created structure.
- str* ua - User-Agent of the REGISTER
+ str* ua - User-Agent of the REGISTER
message that contained the contact.
@@ -274,14 +274,14 @@
Meaning of the parameters is as follows:
- urecord_t* record - Record from which
+ urecord_t* record - Record from which
the contact should be removed.
- ucontact_t* contact - Contact to be
+ ucontact_t* contact - Contact to be
deleted.
@@ -293,13 +293,13 @@
ul_get_ucontact(record, contact)
- The function tries to find contact with given Contact &uri; and
+ The function tries to find contact with given Contact &uri; and
returns pointer to structure representing the contact.
Meaning of the parameters is as follows:
- urecord_t* record - Record to be
+ urecord_t* record - Record to be
searched for the contact.
@@ -319,24 +319,24 @@
(buf, len, flags)
- The function retrieves all contacts of all registered users and
+ The function retrieves all contacts of all registered users and
returns them in the caller-supplied buffer. If the buffer is too small,
- the function returns positive value indicating how much additional
- space would be necessary to accommodate all of them. Please note
- that the positive return value should be used only as a
- hint
, as there is no guarantee that during the time
- between two subsequent calls number of registered contacts will
+ the function returns positive value indicating how much additional
+ space would be necessary to accommodate all of them. Please note
+ that the positive return value should be used only as a
+ hint
, as there is no guarantee that during the time
+ between two subsequent calls number of registered contacts will
remain the same.
- If flag parameter is set to non-zero value then only contacts that
- have the specified flags set will be returned. It is, for example,
+ If flag parameter is set to non-zero value then only contacts that
+ have the specified flags set will be returned. It is, for example,
possible to list only contacts that are behind NAT.
Meaning of the parameters is as follows:
- void* buf - Buffer for returning
+ void* buf - Buffer for returning
contacts.
@@ -358,7 +358,7 @@
- <function moreinfo="none">ul_update_ucontact(contact, expires, q,
+ <function moreinfo="none">ul_update_ucontact(contact, expires, q,
callid, cseq, set, res, ua, sock)</function>
@@ -371,7 +371,7 @@
- time_t expires - Expires of the
+ time_t expires - Expires of the
contact in absolute value.
@@ -380,29 +380,29 @@
- str* callid - Call-ID of the REGISTER
+ str* callid - Call-ID of the REGISTER
message that contained the contact.
- int cseq - CSeq of the REGISTER message
+ int cseq - CSeq of the REGISTER message
that contained the contact.
- unsigned int set - OR value of flags to
+ unsigned int set - OR value of flags to
be set.
- unsigned int res - OR value of flags to be
+ unsigned int res - OR value of flags to be
reset.
- str* ua - User-Agent of the REGISTER
+ str* ua - User-Agent of the REGISTER
message that contained the contact.
@@ -420,7 +420,7 @@
- The function imports all functions that are exported by the
+ The function imports all functions that are exported by the
USRLOC module. Overs for other modules which want to user the
internal USRLOC API an easy way to load and access the functions.