Răsfoiți Sursa

registrar Update documentation for max_contacts

Olle E. Johansson 10 ani în urmă
părinte
comite
7b883f58e4
2 a modificat fișierele cu 52 adăugiri și 45 ștergeri
  1. 45 42
      modules/registrar/README
  2. 7 3
      modules/registrar/doc/registrar_admin.xml

+ 45 - 42
modules/registrar/README

@@ -20,7 +20,7 @@ Edited by
 
 Bogdan-Andre Iancu
 
-   Copyright (c) 2003 FhG FOKUS
+   Copyright © 2003 FhG FOKUS
      __________________________________________________________________
 
    Table of Contents
@@ -481,9 +481,12 @@ modparam("registrar", "received_param", "rcv")
 3.13. max_contacts (integer)
 
    The parameter can be used to limit the number of contacts per AOR
-   (Address of Record) in the user location database. Value 0 disables the
-   check. This parameter can be modified via the Kamailio config
-   framework.
+   (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 the Kamailio config framework.
+   (Please also check the flag for save() if you only want only one active
+   registration).
 
    Default value is 0.
 
@@ -760,7 +763,7 @@ modparam("registrar", "flow_timer", 25)
    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
    location records (in usrloc) depending on Contact and Expires HFs in
@@ -805,7 +808,7 @@ save("location", "0x01");
 save("location", "0x00", "sip:[email protected]");
 ...
 
-4.2.  lookup(domain [, uri])
+4.2. 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
@@ -845,7 +848,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).
@@ -862,7 +865,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
@@ -884,7 +887,7 @@ if (registered("location")) {
 };
 ...
 
-4.5.  add_sock_hdr(hdr_name)
+4.5. add_sock_hdr(hdr_name)
 
    Adds a new header to the current REGISTER request with "hdr_name" which
    contains the description of the received socket (proto:ip:port)
@@ -901,7 +904,7 @@ if (registered("location")) {
 add_sock_hdr("Sock-Info");
 ...
 
-4.6.  unregister(domain, uri[, ruid])
+4.6. unregister(domain, uri[, ruid])
 
    The function removes contacts associated with 'uri' from the location
    database. If 'ruid' is provided a specific contact is removed, if
@@ -928,7 +931,7 @@ unregister("location", "$ru", "$ulc(caller=>ruid)");
 unregister("location", "", "$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).
@@ -950,7 +953,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
@@ -1093,60 +1096,60 @@ 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).
+   In was removed, as the module internally loads this value from the
+   "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.
+   In was removed, as the module internally loads this option from the
+   "USRLOC" module. This was done in order to simplify the configuration.
 
    2.3.
 
-       What happened with the old "save_noreply" and "save_memory" functions?
+   What happened with the old "save_noreply" and "save_memory" functions?
 
-       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.
+   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.
 
    2.4.
 
-       Where can I find more about Kamailio?
+   Where can I find more about Kamailio?
 
-       Take a look at http://www.kamailio.org/.
+   Take a look at http://www.kamailio.org/.
 
    2.5.
 
-       Where can I post a question about this module?
+   Where can I post a question about this module?
 
-       First at all check if your question was already answered on one of our
-       mailing lists:
-         * User Mailing List -
-           http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users
-         * Developer Mailing List -
-           http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
+   First at all check if your question was already answered on one of our
+   mailing lists:
+     * User Mailing List -
+       http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users
+     * Developer Mailing List -
+       http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
 
-       E-mails regarding any stable Kamailio release should be sent to
-       <[email protected]> and e-mails regarding development
-       versions should be sent to <[email protected]>.
+   E-mails regarding any stable Kamailio release should be sent to
+   <[email protected]> and e-mails regarding development
+   versions should be sent to <[email protected]>.
 
-       If you want to keep the mail private, send it to
-       <[email protected]>.
+   If you want to keep the mail private, send it to
+   <[email protected]>.
 
    2.6.
 
-       How can I report a bug?
+   How can I report a bug?
 
-       Please follow the guidelines provided at:
-       http://sip-router.org/tracker.
+   Please follow the guidelines provided at:
+   http://sip-router.org/tracker.
 
    2.7.
 
-       What happened to the desc_time_order parameter?
+   What happened to the desc_time_order parameter?
 
-       It was removed, as its functionality was migrated into usrloc module,
-       were there is a parameter with the same name.
+   It was removed, as its functionality was migrated into usrloc module,
+   were there is a parameter with the same name.

+ 7 - 3
modules/registrar/doc/registrar_admin.xml

@@ -406,9 +406,13 @@ modparam("registrar", "received_param", "rcv")
 		<title><varname>max_contacts</varname> (integer)</title>
 		<para>
 		The parameter can be used to limit the number of contacts per 
-		AOR (Address of Record) in the user location database. Value 0 
-		disables the check. This parameter can be modified via the &kamailio;
-		config framework.
+		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 
+		the &kamailio; config framework.
+		(Please also check the flag for <function>save()</function> if you only want
+		only one active registration).
 		</para>
 		<para>
 		<emphasis>