diff --git a/src/modules/registrar/doc/registrar.xml b/src/modules/registrar/doc/registrar.xml index 7e425dc6c90..a761ed41eae 100644 --- a/src/modules/registrar/doc/registrar.xml +++ b/src/modules/registrar/doc/registrar.xml @@ -54,8 +54,8 @@ - + - + diff --git a/src/modules/registrar/doc/registrar_admin.xml b/src/modules/registrar/doc/registrar_admin.xml index a83607423e4..848e5ae40e1 100644 --- a/src/modules/registrar/doc/registrar_admin.xml +++ b/src/modules/registrar/doc/registrar_admin.xml @@ -21,35 +21,35 @@
PATH support - The Register module includes Path support (according to RFC 3327) + The Register module includes Path support (according to RFC 3327) for usage in registrars and home-proxies. If path support is enabled in the registrar module, a call to save(...) - stores the values of the Path Header(s) along with the contact into usrloc. + stores the values of the Path Header(s) along with the contact into usrloc. There are three modes regarding the reply to a REGISTER including one or more Path header fields: - off - stores the value of the - Path headers into usrloc without passing it back to + 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 + lazy - stores the Path header and + passes it back to the UAC if Path-support is indicated by the path param in the Supported header field. - strict - rejects the registration - with 420 Bad Extension if there's a Path - header but no support for it is indicated by the UAC. + 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. @@ -66,7 +66,7 @@ The whole process is transparent to the user, so no config changes are required beside setting the - registrar-parameters use_path and + registrar-parameters use_path and path_mode.
@@ -86,7 +86,7 @@ contact validity. - + @@ -113,7 +113,7 @@
External Libraries or Applications - The following libraries or applications must be installed before + The following libraries or applications must be installed before running &kamailio; with this module loaded: @@ -130,9 +130,9 @@
<varname>default_expires</varname> (integer) - If the processed message contains neither Expires - header fields nor expires contact parameters, this value - will be used for newly created usrloc records. The parameter contains + If the processed message contains neither Expires + header fields nor expires 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 modified via ser config framework. @@ -180,7 +180,7 @@ modparam("registrar", "default_expires_range", 30) # +- 30% from default_expires <varname>expires_range</varname> (integer) Similar to default_expires_range, but it applies to the incoming expires - value. Default in 0, meaning the expires is left unmodified. + value. Default in 0, meaning the expires is left unmodified. This parameter can be modified via the &kamailio; config framework. @@ -246,8 +246,8 @@ modparam("registrar", "min_expires_mode", 1)
<varname>max_expires</varname> (integer) - The maximum accepted expires value of a Contact, values higher than this - maximum will be automatically set to the maximum. Value 0 disables + The maximum accepted expires value of a Contact, values higher than this + maximum will be automatically set to the maximum. Value 0 disables the checking. This parameter can be modified via the &kamailio; config framework. @@ -268,10 +268,10 @@ modparam("registrar", "max_expires", 120)
<varname>default_q</varname> (integer) - The parameter represents default q value for new contacts. Because - &kamailio; doesn't support float parameter types, the value in the parameter - is divided by 1000 and stored as float. For example, if you want - default_q to be 0.38, use value 380 here. This parameter can be modified via + The parameter represents default q value for new contacts. Because + &kamailio; doesn't support float parameter types, the value in the parameter + is divided by 1000 and stored as float. For example, if you want + default_q to be 0.38, use value 380 here. This parameter can be modified via the &kamailio; config framework. @@ -292,12 +292,12 @@ modparam("registrar", "default_q", 1000)
<varname>realm_prefix</varname> (string) - Prefix to be automatically stripped from realm. As an alternative to - SRV records (not all SIP clients support SRV lookup), a subdomain of - the master domain can be defined for SIP purposes (like - sip.mydomain.net pointing to same IP address as the SRV record for + Prefix to be automatically stripped from realm. As an alternative to + SRV records (not all SIP clients support SRV lookup), a subdomain of + the master domain can be defined for SIP purposes (like + sip.mydomain.net pointing to same IP address as the SRV record for mydomain.net). By ignoring the realm_prefix "sip.", at registration, - sip.mydomain.net will be equivalent to mydomain.net. This parameter + sip.mydomain.net will be equivalent to mydomain.net. This parameter can be modified via the &kamailio; config framework. @@ -319,12 +319,12 @@ modparam("registrar", "realm_prefix", "sip.")
<varname>append_branches</varname> (integer) - The parameter controls how lookup function processes multiple - contacts. If there are multiple contacts for the given username in - usrloc and this parameter is set to 1, Request-URI will be - overwritten with the highest-q rated contact. The rest will be + The parameter controls how lookup function processes multiple + contacts. If there are multiple contacts for the given username in + usrloc and this parameter is set to 1, Request-URI will be + overwritten with the highest-q rated contact. The rest will be appended to sip_msg structure and can be later used by tm for forking. - If the parameter is set to 0, only Request-URI will be overwritten + If the parameter is set to 0, only Request-URI will be overwritten with the highest-q rated contact and the rest will be left unprocessed. This parameter can be modified via &kamailio; config framework. @@ -377,15 +377,15 @@ modparam("registrar", "case_sensitive", 1)
<varname>received_avp</varname> (str) - Registrar will store the value of the AVP configured by this - parameter in the received column in the user location database. - It will leave the column empty if the AVP is empty. The AVP should + Registrar will store the value of the AVP configured by this + parameter in the received column in the user location database. + It will leave the column empty if the AVP is empty. The AVP should contain a SIP URI consisting of the source IP, port, and transport protocol of the REGISTER message being processed. - The value of this parameter should be the same as the value of + The value of this parameter should be the same as the value of corresponding parameter of nathelper module. @@ -407,7 +407,7 @@ modparam("registrar", "received_avp", "$avp(s:rcv)")
<varname>received_param</varname> (string) - The name of the parameter that will be appended to Contact URI's of + The name of the parameter that will be appended to Contact URI's of 200 OK when the received URI was set by the nathelper module. If the value is an empty string, then the parameter is not appended anymore. @@ -429,11 +429,11 @@ modparam("registrar", "received_param", "rcv")
<varname>max_contacts</varname> (integer) - The parameter can be used to limit the number of contacts per + The parameter can be used to limit the number of contacts per AOR (Address of Record) in the user location database. If the maximum number of contacts is exceeded, &kamailio; will not - accept the registration and send an error response. - Value 0 disables the check. This parameter can be modified via + accept the registration and send an error response. + Value 0 disables the check. This parameter can be modified via the &kamailio; config framework. (Please also check the flag for save() if you only want only one active registration). @@ -457,16 +457,16 @@ modparam("registrar", "max_contacts", 10)
<varname>retry_after</varname> (integer) - The registrar can generate a 5xx reply to REGISTER requests in various - situations. It can, for example, happen when the + The registrar can generate a 5xx reply to REGISTER requests in various + situations. It can, for example, happen when the max_contacts parameter is set and the - processing of REGISTER request would exceed the limit. In this case + processing of REGISTER request would exceed the limit. In this case the registrar would generate "503 Service Unavailable" response. This parameter can be modified via the &kamailio; config framework. - If you want to add the Retry-After header field in 5xx replies, set - this parameter to a value grater than zero (0 means do not add the + If you want to add the Retry-After header field in 5xx replies, set + this parameter to a value grater than zero (0 means do not add the header field). See section 20.33 of RFC3261 for more details. @@ -487,9 +487,9 @@ modparam("registrar", "retry_after", 30)
<varname>sock_flag</varname> (integer) - Message flag to signal to the registrar module to look into REGISTER - request for a header which contains a socket description (IP:port). - This socket info will be stored by registrar instead of the received + Message flag to signal to the registrar module to look into REGISTER + request for a header which contains a socket description (IP:port). + This socket info will be stored by registrar instead of the received socket info. @@ -566,8 +566,8 @@ modparam("registrar", "sock_mode", 1) Tells if the contact filtering based on supported methods should be performed during lookup on initial requests without to-tag. - It's enabled only if it has a non zero - value. Supported methods are listed in the Allow: + It's enabled only if it has a non zero + value. Supported methods are listed in the Allow: header in the REGISTER message and stored in the location database. @@ -610,33 +610,33 @@ modparam("registrar", "use_path", 1)
<varname>path_mode</varname> (integer) - The registrar module implements three different modes regarding the + The registrar module implements three different modes regarding the response to a registration which includes one or more Path headers: - 0 - The Path header is saved into usrloc, but is not included in + 0 - The Path header is saved into usrloc, but is not included in 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 in the + 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 in 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 header. This mode is the + 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 header. This mode is the one recommended by RFC-3327. @@ -659,10 +659,10 @@ modparam("registrar", "path_mode", 0)
<varname>path_use_received</varname> (integer) - If set to 1, the received parameter of the first Path + 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 + behind a SIP loadbalancer, which passes the nat'ed UAC address as received parameter in its Path uri. @@ -715,7 +715,7 @@ modparam("registrar", "path_check_local", 1) If reg_callid_avp is defined and populated when the - registered() is invoked, the result is + registered() is invoked, the result is TRUE only if an active registration with the specified callID is found. @@ -962,7 +962,7 @@ modparam("registrar", "gruu_enabled", 0) If set to 0 this module will accept REGISTER requests that do not contain a Supported: header with the outbound options-tag. The 200 OK response to REGISTER requests that this module - generates will not contain Require: or + generates will not contain Require: or Supported: headers with the outbound options-tag. If the client has a Require: header with the outbound options tag the REGISTER will be rejected @@ -1006,7 +1006,7 @@ modparam("registrar", "outbound_mode", 2) If set to 1 this module will use regid contact param - (if present) when saving REGISTER request even if + (if present) when saving REGISTER request even if REGISTER request does not indicate support for outbound. @@ -1216,7 +1216,7 @@ kamcmd cfg.set_now_int registrar use_expired_contacts 0
- +
Functions
@@ -1224,10 +1224,10 @@ kamcmd cfg.set_now_int registrar use_expired_contacts 0 save(domain, [, flags [, uri]]) - The function processes a REGISTER message. It can add, remove or - modify location records (in usrloc) depending on Contact and Expires header fields in the - REGISTER message. On success and when called from the REQUEST_ROUTE, - 200 OK will be returned listing all contacts that are currently in + The function processes a REGISTER message. It can add, remove or + modify location records (in usrloc) depending on Contact and Expires header fields in the + REGISTER message. On success and when called from the REQUEST_ROUTE, + 200 OK will be returned listing all contacts that are currently in the location database. As a side effect, also branch flags are stored in usrloc. On an error, an error message will be sent with a short description in reason phrase. @@ -1236,8 +1236,8 @@ kamcmd cfg.set_now_int registrar use_expired_contacts 0 - domain - Logical domain within the registrar. - If a database is used then this must be name of the table which + domain - Logical domain within the registrar. + If a database is used then this must be name of the table which stores the contacts. @@ -1253,7 +1253,7 @@ kamcmd cfg.set_now_int registrar use_expired_contacts 0 - 0x02 - do not generate a SIP + 0x02 - do not generate a SIP reply to the current REGISTER request. When used in ONREPLY_ROUTE, this parameter is obsolete. @@ -1265,7 +1265,7 @@ kamcmd cfg.set_now_int registrar use_expired_contacts 0 0x08 - Do not apply - expires_range or + expires_range or default_expires_range to this registration. @@ -1334,18 +1334,18 @@ save("location", "0x00", "sip:test@kamailio.org"); lookup(domain [, uri]) - The lookup function extracts username and/or domain from Request-URI and tries to find - all contacts for the username in usrloc. If there are no such - contacts, -1 will be returned. If there are such contacts, + The lookup function extracts username and/or domain from Request-URI and tries to find + all contacts for the username in usrloc. If there are no such + contacts, -1 will be returned. If there are such contacts, Request-URI will be overwritten with the contact that has - the highest q value and optionally the rest will be appended to + the highest q value and optionally the rest will be appended to the message (depending on append_branches parameter value). As a side effect, also branch flags are restored from usrloc. If the method_filtering option is enabled and request is initial request without to-tag, the - lookup function + lookup function will return only the contacts that support the method of the processed request. @@ -1353,7 +1353,7 @@ save("location", "0x00", "sip:test@kamailio.org"); - domain - Name of table that should be used + domain - Name of table that should be used for the lookup. @@ -1443,7 +1443,7 @@ lookup_to_dset("location"); - domain - Name of table that should be used + domain - Name of table that should be used for the lookup. @@ -1546,9 +1546,9 @@ xinfo("first contact record - socket: $xavp(cul>socket)\n"); registered(domain [, uri [, match_option [, match_action]]]) - The function returns true if the AOR in the URI is - registered, false otherwise. The function does not modify the - message being processed, it neither rewrites the Request-URI if a + The function returns true if the AOR in the URI is + registered, false otherwise. The function does not modify the + message being processed, it neither rewrites the Request-URI if a contact is found nor append branches. If uri parameter is not provided, then it considered to be the Request-URI for SIP requests and To-URI for SIP replies. @@ -1557,7 +1557,7 @@ xinfo("first contact record - socket: $xavp(cul>socket)\n"); - domain - Name of table that should be + domain - Name of table that should be used for the lookup. @@ -1629,7 +1629,7 @@ if (registered("location","$rz:$Au", 2)) { add_sock_hdr(hdr_name) - Adds a new header to the current REGISTER request with + Adds a new header to the current REGISTER request with hdr_name which contains the description of the received socket (proto:ip:port) @@ -1664,7 +1664,7 @@ add_sock_hdr("Sock-Info"); The function removes contacts associated with 'uri' from the location database. If 'ruid' is provided a specific contact is removed, - if 'ruid' is not provided all the current contacts are removed. + if 'ruid' is not provided all the current contacts are removed. If 'ruid' is provided and the usrloc module is using db_mode=3, 'uri' does not need to be given and can be empty string. @@ -1673,7 +1673,7 @@ add_sock_hdr("Sock-Info"); - domain - Name of table that should be + domain - Name of table that should be used for the lookup or contact addresses. @@ -1744,7 +1744,7 @@ unregister("location", "", "$ruid"); - domain - Name of table that should be + domain - Name of table that should be used for the lookup of contact addresses. @@ -1938,7 +1938,7 @@ event_route[usrloc:contact-expired] {
Pseudo Variables - +
<varname>$ulc(profile=>attr)</varname> @@ -1957,11 +1957,11 @@ event_route[usrloc:contact-expired] { aor - address of record - + domain - used location domain/table name - + aorhash - hash id for the record @@ -1969,71 +1969,71 @@ event_route[usrloc:contact-expired] { 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 - + regid - reg-id value - + instance - instance value - + conid - TCP socket internal connection ID ($null if UDP) diff --git a/src/modules/registrar/doc/registrar_faq.xml b/src/modules/registrar/doc/registrar_faq.xml index 325700966eb..3c74919cfd7 100644 --- a/src/modules/registrar/doc/registrar_faq.xml +++ b/src/modules/registrar/doc/registrar_faq.xml @@ -10,7 +10,7 @@ - + &faqguide; @@ -46,7 +46,7 @@ - There functions were merged into the new + 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. @@ -71,7 +71,7 @@ First at all check if your question was already answered on one of - our mailing lists: + our mailing lists: @@ -82,7 +82,7 @@ - E-mails regarding any stable &kamailio; release should be sent to + E-mails regarding any stable &kamailio; release should be sent to &kamailiousersmail; and e-mails regarding development versions should be sent to &kamailiodevmail;.