Browse code

registrar: docs for xavp_cfg

* fix docs for expires/q attributes
* add all available attributes and note in which function they are used

Bastian Triller authored on 21/09/2021 17:39:50 • Daniel-Constantin Mierla committed on 21/09/2021 18:55:40
Showing 1 changed files
... ...
@@ -745,15 +745,41 @@ modparam("registrar", "reg_callid_avp", "$avp(s:avp)")
745 745
 		<itemizedlist>
746 746
 		<listitem>
747 747
 			<para>
748
-				<emphasis>expires</emphasis> - the number of maximum
749
-				contacts to be stored for the current registration AoR. It
750
-				overwrites the 'max_contacts' module parameter value.
748
+				<emphasis>match_callid</emphasis> - filter contacts by callid.
749
+				Used in registered().
750
+			</para>
751
+		</listitem>
752
+		<listitem>
753
+			<para>
754
+				<emphasis>match_contact</emphasis> - filter contacts by contact.
755
+				Used in registered().
756
+			</para>
757
+		</listitem>
758
+		<listitem>
759
+			<para>
760
+				<emphasis>match_received</emphasis> - filter contacts by received.
761
+				Used in registered().
751 762
 			</para>
752 763
 		</listitem>
753 764
 		<listitem>
754 765
 			<para>
755
-				<emphasis>q</emphasis> - the expires value, to overwrite the
766
+				<emphasis>rlf_bflags</emphasis> - filter contacts by branch flags.
767
+				Used in lookup().
768
+			</para>
769
+		</listitem>
770
+		<listitem>
771
+			<para>
772
+				<emphasis>q</emphasis> - q value of contact
773
+				(integer 0-1000). It overrides q value given in
774
+				contact header and default_q parameter.
775
+				Used in save().
776
+			</para>
777
+		</listitem>
778
+		<listitem>
779
+			<para>
780
+				<emphasis>expires</emphasis> - the expires value, to overwrite the
756 781
 				value from SIP headers.
782
+				Used in save().
757 783
 			</para>
758 784
 		</listitem>
759 785
 		<listitem>
... ...
@@ -761,6 +787,7 @@ modparam("registrar", "reg_callid_avp", "$avp(s:avp)")
761 787
 				<emphasis>max_contacts</emphasis> - the number of maximum
762 788
 				contacts to be stored for the current registration AoR. It
763 789
 				overwrites the 'max_contacts' module parameter value.
790
+				Used in save().
764 791
 			</para>
765 792
 		</listitem>
766 793
 		<listitem>
... ...
@@ -768,6 +795,7 @@ modparam("registrar", "reg_callid_avp", "$avp(s:avp)")
768 795
 				<emphasis>socket</emphasis> - the string representing the
769 796
 				socket on which the register request was received, as alternative
770 797
 				to using the sock_hdr.
798
+				Used in save().
771 799
 			</para>
772 800
 		</listitem>
773 801
 		</itemizedlist>
... ...
@@ -1117,7 +1145,7 @@ end
1117 1145
 				are returned.
1118 1146
 			</para>
1119 1147
 		</listitem>
1120
-	</itemizedlist>
1148
+		</itemizedlist>
1121 1149
 		<para>
1122 1150
 		<emphasis>
1123 1151
 			Default value is NULL (disabled).
... ...
@@ -1451,7 +1479,7 @@ lookup_branches("location");
1451 1479
 		<listitem>
1452 1480
 			<para>
1453 1481
 			<emphasis>match_option</emphasis> (optional) - flag parameter to restrict
1454
-			contact search. use reg_xavp_cfg to set the values to compare to.
1482
+			contact search. use xavp_cfg to set the values to compare to.
1455 1483
 			</para>
1456 1484
             <para>flag values is as follows:</para>
1457 1485
 			<itemizedlist>