Browse code

registrar Update documentation for max_contacts

Olle E. Johansson authored on 16/12/2014 10:31:16
Showing 2 changed files
... ...
@@ -20,7 +20,7 @@ Edited by
20 20
 
21 21
 Bogdan-Andre Iancu
22 22
 
23
-   Copyright (c) 2003 FhG FOKUS
23
+   Copyright � 2003 FhG FOKUS
24 24
      __________________________________________________________________
25 25
 
26 26
    Table of Contents
... ...
@@ -481,9 +481,12 @@ modparam("registrar", "received_param", "rcv")
481 481
 3.13. max_contacts (integer)
482 482
 
483 483
    The parameter can be used to limit the number of contacts per AOR
484
-   (Address of Record) in the user location database. Value 0 disables the
485
-   check. This parameter can be modified via the Kamailio config
486
-   framework.
484
+   (Address of Record) in the user location database. If the maximum
485
+   number of contacts is exceeded, Kamailio will not accept the
486
+   registration and send an error response. Value 0 disables the check.
487
+   This parameter can be modified via the Kamailio config framework.
488
+   (Please also check the flag for save() if you only want only one active
489
+   registration).
487 490
 
488 491
    Default value is 0.
489 492
 
... ...
@@ -760,7 +763,7 @@ modparam("registrar", "flow_timer", 25)
760 760
    4.7. reg_fetch_contacts(domain, uri, profile)
761 761
    4.8. reg_free_contacts(profile)
762 762
 
763
-4.1.  save(domain, [, flags [, uri]])
763
+4.1. save(domain, [, flags [, uri]])
764 764
 
765 765
    The function processes a REGISTER message. It can add, remove or modify
766 766
    location records (in usrloc) depending on Contact and Expires HFs in
... ...
@@ -805,7 +808,7 @@ save("location", "0x01");
805 805
 save("location", "0x00", "sip:test@kamailio.org");
806 806
 ...
807 807
 
808
-4.2.  lookup(domain [, uri])
808
+4.2. lookup(domain [, uri])
809 809
 
810 810
    The lookup function extracts username and/or domain from Request-URI
811 811
    and tries to find all contacts for the username in usrloc. If there are
... ...
@@ -845,7 +848,7 @@ switch ($retcode) {
845 845
 };
846 846
 ...
847 847
 
848
-4.3.  lookup_branches(domain)
848
+4.3. lookup_branches(domain)
849 849
 
850 850
    The function performs lookup(domain) on r-uri and additional branches
851 851
    (only branches that have no other attributes set than uri).
... ...
@@ -862,7 +865,7 @@ switch ($retcode) {
862 862
 lookup_branches("location");
863 863
 ...
864 864
 
865
-4.4.  registered(domain [, uri])
865
+4.4. registered(domain [, uri])
866 866
 
867 867
    The function returns true if the AOR in the Request-URI is registered,
868 868
    false otherwise. The function does not modify the message being
... ...
@@ -884,7 +887,7 @@ if (registered("location")) {
884 884
 };
885 885
 ...
886 886
 
887
-4.5.  add_sock_hdr(hdr_name)
887
+4.5. add_sock_hdr(hdr_name)
888 888
 
889 889
    Adds a new header to the current REGISTER request with "hdr_name" which
890 890
    contains the description of the received socket (proto:ip:port)
... ...
@@ -901,7 +904,7 @@ if (registered("location")) {
901 901
 add_sock_hdr("Sock-Info");
902 902
 ...
903 903
 
904
-4.6.  unregister(domain, uri[, ruid])
904
+4.6. unregister(domain, uri[, ruid])
905 905
 
906 906
    The function removes contacts associated with 'uri' from the location
907 907
    database. If 'ruid' is provided a specific contact is removed, if
... ...
@@ -928,7 +931,7 @@ unregister("location", "$ru", "$ulc(caller=>ruid)");
928 928
 unregister("location", "", "$ruid");
929 929
 ...
930 930
 
931
-4.7.  reg_fetch_contacts(domain, uri, profile)
931
+4.7. reg_fetch_contacts(domain, uri, profile)
932 932
 
933 933
    The function fetches the contacts for 'uri' from table 'domain' to
934 934
    pseudo-variable $ulc(profile).
... ...
@@ -950,7 +953,7 @@ reg_fetch_contacts("location", "$ru", "callee");
950 950
 reg_fetch_contacts("location", "sip:user@kamailio.org", "caller");
951 951
 ...
952 952
 
953
-4.8.  reg_free_contacts(profile)
953
+4.8. reg_free_contacts(profile)
954 954
 
955 955
    The function frees the contacts from pseudo-variable $ulc(profile).
956 956
    Should be called to release the content of a profile. Anyhow, fetching
... ...
@@ -1093,60 +1096,60 @@ Chapter 2. Frequently Asked Questions
1093 1093
 
1094 1094
    2.1.
1095 1095
 
1096
-       What happend with the old "nat_flag" module parameter?
1096
+   What happend with the old "nat_flag" module parameter?
1097 1097
 
1098
-       In was removed, as the module internally loads this value from the
1099
-       "USRLOC" module (see the "nat_bflag" USRLOC parameter).
1098
+   In was removed, as the module internally loads this value from the
1099
+   "USRLOC" module (see the "nat_bflag" USRLOC parameter).
1100 1100
 
1101 1101
    2.2.
1102 1102
 
1103
-       What happend with the old "use_domain" module parameter?
1103
+   What happend with the old "use_domain" module parameter?
1104 1104
 
1105
-       In was removed, as the module internally loads this option from the
1106
-       "USRLOC" module. This was done in order to simplify the configuration.
1105
+   In was removed, as the module internally loads this option from the
1106
+   "USRLOC" module. This was done in order to simplify the configuration.
1107 1107
 
1108 1108
    2.3.
1109 1109
 
1110
-       What happened with the old "save_noreply" and "save_memory" functions?
1110
+   What happened with the old "save_noreply" and "save_memory" functions?
1111 1111
 
1112
-       There functions were merged into the new "save(domain,flags)"
1113
-       functions. If a reply should be sent or if the DB should be updated
1114
-       also is controlled via the flags.
1112
+   There functions were merged into the new "save(domain,flags)"
1113
+   functions. If a reply should be sent or if the DB should be updated
1114
+   also is controlled via the flags.
1115 1115
 
1116 1116
    2.4.
1117 1117
 
1118
-       Where can I find more about Kamailio?
1118
+   Where can I find more about Kamailio?
1119 1119
 
1120
-       Take a look at http://www.kamailio.org/.
1120
+   Take a look at http://www.kamailio.org/.
1121 1121
 
1122 1122
    2.5.
1123 1123
 
1124
-       Where can I post a question about this module?
1124
+   Where can I post a question about this module?
1125 1125
 
1126
-       First at all check if your question was already answered on one of our
1127
-       mailing lists:
1128
-         * User Mailing List -
1129
-           http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users
1130
-         * Developer Mailing List -
1131
-           http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
1126
+   First at all check if your question was already answered on one of our
1127
+   mailing lists:
1128
+     * User Mailing List -
1129
+       http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-users
1130
+     * Developer Mailing List -
1131
+       http://lists.sip-router.org/cgi-bin/mailman/listinfo/sr-dev
1132 1132
 
1133
-       E-mails regarding any stable Kamailio release should be sent to
1134
-       <sr-users@lists.sip-router.org> and e-mails regarding development
1135
-       versions should be sent to <sr-dev@lists.sip-router.org>.
1133
+   E-mails regarding any stable Kamailio release should be sent to
1134
+   <sr-users@lists.sip-router.org> and e-mails regarding development
1135
+   versions should be sent to <sr-dev@lists.sip-router.org>.
1136 1136
 
1137
-       If you want to keep the mail private, send it to
1138
-       <sr-users@lists.sip-router.org>.
1137
+   If you want to keep the mail private, send it to
1138
+   <sr-users@lists.sip-router.org>.
1139 1139
 
1140 1140
    2.6.
1141 1141
 
1142
-       How can I report a bug?
1142
+   How can I report a bug?
1143 1143
 
1144
-       Please follow the guidelines provided at:
1145
-       http://sip-router.org/tracker.
1144
+   Please follow the guidelines provided at:
1145
+   http://sip-router.org/tracker.
1146 1146
 
1147 1147
    2.7.
1148 1148
 
1149
-       What happened to the desc_time_order parameter?
1149
+   What happened to the desc_time_order parameter?
1150 1150
 
1151
-       It was removed, as its functionality was migrated into usrloc module,
1152
-       were there is a parameter with the same name.
1151
+   It was removed, as its functionality was migrated into usrloc module,
1152
+   were there is a parameter with the same name.
... ...
@@ -406,9 +406,13 @@ modparam("registrar", "received_param", "rcv")
406 406
 		<title><varname>max_contacts</varname> (integer)</title>
407 407
 		<para>
408 408
 		The parameter can be used to limit the number of contacts per 
409
-		AOR (Address of Record) in the user location database. Value 0 
410
-		disables the check. This parameter can be modified via the &kamailio;
411
-		config framework.
409
+		AOR (Address of Record) in the user location database.
410
+		If the maximum number of contacts is exceeded, &kamailio; will not
411
+		accept the registration and send an error response. 
412
+		Value 0 disables the check. This parameter can be modified via 
413
+		the &kamailio; config framework.
414
+		(Please also check the flag for <function>save()</function> if you only want
415
+		only one active registration).
412 416
 		</para>
413 417
 		<para>
414 418
 		<emphasis>