|
|
@@ -16,7 +16,7 @@ Edited by
|
|
|
|
|
|
Bogdan-Andre Iancu
|
|
|
|
|
|
- Copyright © 2003 FhG FOKUS
|
|
|
+ Copyright © 2003 FhG FOKUS
|
|
|
__________________________________________________________________
|
|
|
|
|
|
Table of Contents
|
|
|
@@ -68,7 +68,7 @@ Bogdan-Andre Iancu
|
|
|
4.3. lookup_branches(domain)
|
|
|
4.4. registered(domain [, uri])
|
|
|
4.5. add_sock_hdr(hdr_name)
|
|
|
- 4.6. unregister(domain, uri)
|
|
|
+ 4.6. unregister(domain, uri[, ruid])
|
|
|
4.7. reg_fetch_contacts(domain, uri, profile)
|
|
|
4.8. reg_free_contacts(profile)
|
|
|
|
|
|
@@ -176,7 +176,7 @@ Chapter 1. Admin Guide
|
|
|
4.3. lookup_branches(domain)
|
|
|
4.4. registered(domain [, uri])
|
|
|
4.5. add_sock_hdr(hdr_name)
|
|
|
- 4.6. unregister(domain, uri)
|
|
|
+ 4.6. unregister(domain, uri[, ruid])
|
|
|
4.7. reg_fetch_contacts(domain, uri, profile)
|
|
|
4.8. reg_free_contacts(profile)
|
|
|
|
|
|
@@ -216,8 +216,8 @@ Chapter 1. Admin Guide
|
|
|
* off - stores the value of the Path headers into usrloc without
|
|
|
passing it back to the UAC in the reply.
|
|
|
* lazy - stores the Path header and passes it back to the UAC if
|
|
|
- Path-support is indicated by the "path" param in the Supported HF.
|
|
|
- * strict - rejects the registration with "420 Bad Extension" if
|
|
|
+ Path-support is indicated by the “path� param in the Supported HF.
|
|
|
+ * strict - rejects the registration with “420 Bad Extension� if
|
|
|
there's a Path header but no support for it is indicated by the
|
|
|
UAC. Otherwise it's stored and passed back to the UAC.
|
|
|
|
|
|
@@ -229,8 +229,8 @@ Chapter 1. Admin Guide
|
|
|
client's NAT).
|
|
|
|
|
|
The whole process is transparent to the user, so no config changes are
|
|
|
- required beside setting the registrar-parameters "use_path" and
|
|
|
- "path_mode".
|
|
|
+ required beside setting the registrar-parameters “use_path� and
|
|
|
+ “path_mode�.
|
|
|
|
|
|
1.2. GRUU Support
|
|
|
|
|
|
@@ -294,7 +294,7 @@ Chapter 1. Admin Guide
|
|
|
contact parameters, this value will be used for newly created usrloc
|
|
|
records. The parameter contains number of second to expire (for example
|
|
|
use 3600 for one hour). If it is set to a lower value than the
|
|
|
- "min_expires" parameter then it will be ignored. This parameter can be
|
|
|
+ “min_expires� parameter then it will be ignored. This parameter can be
|
|
|
modified via ser config framework. A random value in a specific
|
|
|
interval can be selected by using the default_expires_range parameter
|
|
|
|
|
|
@@ -308,9 +308,9 @@ modparam("registrar", "default_expires", 1800)
|
|
|
3.2. default_expires_range (integer)
|
|
|
|
|
|
This parameter specifies that the expiry used for newly created usrloc
|
|
|
- records are not fixed(when "default_expires" applies), but a random
|
|
|
- value in the interval "[default_expires-default_expires_range%,
|
|
|
- default_expires+default_expires_range%]". The value is between 0 and
|
|
|
+ records are not fixed(when “default_expires� applies), but a random
|
|
|
+ value in the interval “[default_expires-default_expires_range%,
|
|
|
+ default_expires+default_expires_range%]�. The value is between 0 and
|
|
|
100 and represent the maximim percentage from default_expires that will
|
|
|
be substracted or added when computing the value. Default in 0, meaning
|
|
|
default_expires is left unmodified. This parameter can be modified via
|
|
|
@@ -529,7 +529,7 @@ modparam("registrar", "method_filtering", 1)
|
|
|
3.17. use_path (integer)
|
|
|
|
|
|
If set to 1, the Path header is handled according to the parameter This
|
|
|
- parameter can be modified via ser config framework. "path_mode".
|
|
|
+ parameter can be modified via ser config framework. “path_mode�.
|
|
|
|
|
|
Default value is 0 (disabled).
|
|
|
|
|
|
@@ -546,12 +546,12 @@ modparam("registrar", "use_path", 1)
|
|
|
the reply.
|
|
|
* 1 - The Path header is saved into usrloc, but is only included in
|
|
|
the reply if path support is indicated in the registration request
|
|
|
- by the "path" option of the "Supported" header.
|
|
|
+ by the “path� option of the “Supported� header.
|
|
|
* 2 - The path header is only saved into usrloc, if path support is
|
|
|
- indicated in the registration request by the "path" option of the
|
|
|
- "Supported" header. If no path support is indicated, the request is
|
|
|
- rejected with "420 - Bad Extension" and the header "Unsupported:
|
|
|
- path" is included in the reply along with the received "Path"
|
|
|
+ indicated in the registration request by the “path� option of the
|
|
|
+ “Supported� header. If no path support is indicated, the request is
|
|
|
+ rejected with “420 - Bad Extension� and the header “Unsupported:
|
|
|
+ path� is included in the reply along with the received “Path�
|
|
|
header. This mode is the one recommended by RFC-3327.
|
|
|
|
|
|
Default value is 2.
|
|
|
@@ -563,10 +563,10 @@ modparam("registrar", "path_mode", 0)
|
|
|
|
|
|
3.19. path_use_received (integer)
|
|
|
|
|
|
- If set to 1, the "received" parameter of the first Path URI of a
|
|
|
+ If set to 1, the “received� parameter of the first Path URI of a
|
|
|
registration is set as received-uri and the NAT branch flag is set for
|
|
|
this contact. This is useful if the registrar is placed behind a SIP
|
|
|
- loadbalancer, which passes the nat'ed UAC address as "received"
|
|
|
+ loadbalancer, which passes the nat'ed UAC address as “received�
|
|
|
parameter in it's Path uri.
|
|
|
|
|
|
Default value is 0 (disabled).
|
|
|
@@ -627,7 +627,7 @@ modparam("registrar", "xavp_cfg", "ulrcd")
|
|
|
|
|
|
3.23. gruu_enabled (integer)
|
|
|
|
|
|
- If set to 1 and GRUU "+sip.instance" parameter to Contact header of
|
|
|
+ If set to 1 and GRUU “+sip.instance� parameter to Contact header of
|
|
|
REGISTER is present, then the value of the parameter is saved to
|
|
|
location and pub-gruu and temp-gruu addresses are generated.
|
|
|
|
|
|
@@ -701,11 +701,11 @@ modparam("registrar", "flow_timer", 25)
|
|
|
4.3. lookup_branches(domain)
|
|
|
4.4. registered(domain [, uri])
|
|
|
4.5. add_sock_hdr(hdr_name)
|
|
|
- 4.6. unregister(domain, uri)
|
|
|
+ 4.6. unregister(domain, uri[, ruid])
|
|
|
4.7. reg_fetch_contacts(domain, uri, profile)
|
|
|
4.8. reg_free_contacts(profile)
|
|
|
|
|
|
-4.1. save(domain, [, flags [, uri]])
|
|
|
+4.1. save(domain, [, flags [, uri]])
|
|
|
|
|
|
The function processes a REGISTER message. It can add, remove or modify
|
|
|
usrloc records depending on Contact and Expires HFs in the REGISTER
|
|
|
@@ -749,7 +749,7 @@ save("location", "0x01");
|
|
|
save("location", "0x00", "sip:[email protected]");
|
|
|
...
|
|
|
|
|
|
-4.2. lookup(domain [, uri])
|
|
|
+4.2. lookup(domain [, uri])
|
|
|
|
|
|
The function extracts username from Request-URI and tries to find all
|
|
|
contacts for the username in usrloc. If there are no such contacts, -1
|
|
|
@@ -789,7 +789,7 @@ switch ($retcode) {
|
|
|
};
|
|
|
...
|
|
|
|
|
|
-4.3. lookup_branches(domain)
|
|
|
+4.3. lookup_branches(domain)
|
|
|
|
|
|
The function performs lookup(domain) on r-uri and additional branches
|
|
|
(only branches that have no other attributes set than uri).
|
|
|
@@ -806,7 +806,7 @@ switch ($retcode) {
|
|
|
lookup_branches("location");
|
|
|
...
|
|
|
|
|
|
-4.4. registered(domain [, uri])
|
|
|
+4.4. registered(domain [, uri])
|
|
|
|
|
|
The function returns true if the AOR in the Request-URI is registered,
|
|
|
false otherwise. The function does not modify the message being
|
|
|
@@ -828,9 +828,9 @@ if (registered("location")) {
|
|
|
};
|
|
|
...
|
|
|
|
|
|
-4.5. add_sock_hdr(hdr_name)
|
|
|
+4.5. add_sock_hdr(hdr_name)
|
|
|
|
|
|
- Adds to the current REGISTER request a new header with "hdr_name" which
|
|
|
+ Adds to the current REGISTER request a new header with “hdr_name� which
|
|
|
contains the description of the received socket (proto:ip:port)
|
|
|
|
|
|
This make sens only in multiple replicated servers scenarios.
|
|
|
@@ -845,9 +845,11 @@ if (registered("location")) {
|
|
|
add_sock_hdr("Sock-Info");
|
|
|
...
|
|
|
|
|
|
-4.6. unregister(domain, uri)
|
|
|
+4.6. unregister(domain, uri[, ruid])
|
|
|
|
|
|
- The function remove all the contact associated to 'uri'.
|
|
|
+ The function removes contacts associated with 'uri'. If 'ruid' is
|
|
|
+ provided a specific contact is removed, if 'ruid' is not provided all
|
|
|
+ contacts are removed.
|
|
|
|
|
|
Meaning of the parameters is as follows:
|
|
|
* domain - Name of table that should be used for the lookup or
|
|
|
@@ -855,6 +857,8 @@ add_sock_hdr("Sock-Info");
|
|
|
* uri - The SIP URI address of the user which to remove the contact
|
|
|
addresses for. It can contain pseudo-variables that are evaluated
|
|
|
at runtime.
|
|
|
+ * ruid - The record unique ID for a a specific contact to be removed.
|
|
|
+ It can contain pseudo-variables that are evaluated at runtime.
|
|
|
|
|
|
This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
|
|
|
|
|
|
@@ -862,9 +866,10 @@ add_sock_hdr("Sock-Info");
|
|
|
...
|
|
|
unregister("location", "$ru");
|
|
|
unregister("location", "sip:[email protected]");
|
|
|
+unregister("location", "$ru", "$ulc(caller=>ruid)");
|
|
|
...
|
|
|
|
|
|
-4.7. reg_fetch_contacts(domain, uri, profile)
|
|
|
+4.7. reg_fetch_contacts(domain, uri, profile)
|
|
|
|
|
|
The function fetches the contacts for 'uri' from table 'domain' to
|
|
|
pseudo-variable $ulc(profile).
|
|
|
@@ -886,7 +891,7 @@ reg_fetch_contacts("location", "$ru", "callee");
|
|
|
reg_fetch_contacts("location", "sip:[email protected]", "caller");
|
|
|
...
|
|
|
|
|
|
-4.8. reg_free_contacts(profile)
|
|
|
+4.8. reg_free_contacts(profile)
|
|
|
|
|
|
The function frees the contacts from pseudo-variable $ulc(profile).
|
|
|
Should be called to release the content of a profile. Anyhow, fetching
|
|
|
@@ -955,28 +960,32 @@ event_route[usrloc:contact-expired] {
|
|
|
7.1. $ulc(profile=>attr)
|
|
|
|
|
|
Access the attributes of contact addresses stored in 'profile'. It must
|
|
|
- be used after a call of "reg_fetch_contacts()".
|
|
|
+ be used after a call of “reg_fetch_contacts()�.
|
|
|
|
|
|
- The "profile" has to be one of the values used with
|
|
|
- "reg_fetch_contacts()".
|
|
|
+ The “profile� has to be one of the values used with
|
|
|
+ “reg_fetch_contacts()�.
|
|
|
|
|
|
- The "attr" can be:
|
|
|
+ The “attr� can be:
|
|
|
* aor - address of record
|
|
|
* domain - use location domain name
|
|
|
* aorhash - hash id for the record
|
|
|
- * count - number of contacts
|
|
|
* addr - contact address
|
|
|
* path - path vector
|
|
|
* received - received address
|
|
|
* expires - expires value
|
|
|
* callid - call-id header value
|
|
|
* q - the q value
|
|
|
+ * cseq - the cseq value
|
|
|
* flags - flags value
|
|
|
* cflags - cflags value
|
|
|
* user_agent - user agent
|
|
|
* socket - local socket
|
|
|
* modified - last modified time
|
|
|
* methods - methods value
|
|
|
+ * count - number of contacts
|
|
|
+ * ruid - record unique ID
|
|
|
+ * reg-id - reg-id value
|
|
|
+ * instance - instance value
|
|
|
|
|
|
The pseudo-variable accepts positive index value to access a specific
|
|
|
contact record.
|
|
|
@@ -1013,9 +1022,9 @@ if(reg_fetch_contacts("location", "$fu", "caller"))
|
|
|
|
|
|
Chapter 2. Frequently Asked Questions
|
|
|
|
|
|
- 2.1. What happend with the old "nat_flag" module parameter?
|
|
|
- 2.2. What happend with the old "use_domain" module parameter?
|
|
|
- 2.3. What happend with the old "save_noreply" and "save_memory"
|
|
|
+ 2.1. What happend with the old “nat_flag� module parameter?
|
|
|
+ 2.2. What happend with the old “use_domain� module parameter?
|
|
|
+ 2.3. What happend with the old “save_noreply� and “save_memory�
|
|
|
functions?
|
|
|
|
|
|
2.4. Where can I find more about Kamailio?
|
|
|
@@ -1025,23 +1034,23 @@ Chapter 2. Frequently Asked Questions
|
|
|
|
|
|
2.1.
|
|
|
|
|
|
- What happend with the old "nat_flag" module parameter?
|
|
|
+ What happend with the old “nat_flag� module parameter?
|
|
|
|
|
|
In was removed, as the module internally loads this value from the
|
|
|
- "USRLOC" module (see the "nat_bflag" USRLOC parameter).
|
|
|
+ “USRLOC� module (see the “nat_bflag� USRLOC parameter).
|
|
|
|
|
|
2.2.
|
|
|
|
|
|
- What happend with the old "use_domain" module parameter?
|
|
|
+ What happend with the old “use_domain� module parameter?
|
|
|
|
|
|
In was removed, as the module internally loads this option from the
|
|
|
- "USRLOC" module. This was done in order to simplify the configuration.
|
|
|
+ “USRLOC� module. This was done in order to simplify the configuration.
|
|
|
|
|
|
2.3.
|
|
|
|
|
|
- What happend with the old "save_noreply" and "save_memory" functions?
|
|
|
+ What happend with the old “save_noreply� and “save_memory� functions?
|
|
|
|
|
|
- There functions were merged into the new "save(domain,flags)"
|
|
|
+ There functions were merged into the new “save(domain,flags)�
|
|
|
functions. If a reply should be sent or if the DB should be updated
|
|
|
also is controlled via the flags.
|
|
|
|
Peter Dunkley