Module: kamailio
Branch: master
Commit: fe4b180d3d2c42beec8299938f7935b0c67ef4d2
URL:
https://github.com/kamailio/kamailio/commit/fe4b180d3d2c42beec8299938f7935b…
Author: Bastian Triller <bastian.triller(a)gmail.com>
Committer: Daniel-Constantin Mierla <miconda(a)gmail.com>
Date: 2021-09-21T20:55:40+02:00
registrar: docs for xavp_cfg
* fix docs for expires/q attributes
* add all available attributes and note in which function they are used
---
Modified: src/modules/registrar/doc/registrar_admin.xml
---
Diff:
https://github.com/kamailio/kamailio/commit/fe4b180d3d2c42beec8299938f7935b…
Patch:
https://github.com/kamailio/kamailio/commit/fe4b180d3d2c42beec8299938f7935b…
---
diff --git a/src/modules/registrar/doc/registrar_admin.xml
b/src/modules/registrar/doc/registrar_admin.xml
index 09d41843dd..50ba66f38f 100644
--- a/src/modules/registrar/doc/registrar_admin.xml
+++ b/src/modules/registrar/doc/registrar_admin.xml
@@ -745,15 +745,41 @@ modparam("registrar", "reg_callid_avp",
"$avp(s:avp)")
<itemizedlist>
<listitem>
<para>
- <emphasis>expires</emphasis> - the number of maximum
- contacts to be stored for the current registration AoR. It
- overwrites the 'max_contacts' module parameter value.
+ <emphasis>match_callid</emphasis> - filter contacts by callid.
+ Used in registered().
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>match_contact</emphasis> - filter contacts by contact.
+ Used in registered().
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>match_received</emphasis> - filter contacts by received.
+ Used in registered().
</para>
</listitem>
<listitem>
<para>
- <emphasis>q</emphasis> - the expires value, to overwrite the
+ <emphasis>rlf_bflags</emphasis> - filter contacts by branch flags.
+ Used in lookup().
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>q</emphasis> - q value of contact
+ (integer 0-1000). It overrides q value given in
+ contact header and default_q parameter.
+ Used in save().
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+ <emphasis>expires</emphasis> - the expires value, to overwrite the
value from SIP headers.
+ Used in save().
</para>
</listitem>
<listitem>
@@ -761,6 +787,7 @@ modparam("registrar", "reg_callid_avp",
"$avp(s:avp)")
<emphasis>max_contacts</emphasis> - the number of maximum
contacts to be stored for the current registration AoR. It
overwrites the 'max_contacts' module parameter value.
+ Used in save().
</para>
</listitem>
<listitem>
@@ -768,6 +795,7 @@ modparam("registrar", "reg_callid_avp",
"$avp(s:avp)")
<emphasis>socket</emphasis> - the string representing the
socket on which the register request was received, as alternative
to using the sock_hdr.
+ Used in save().
</para>
</listitem>
</itemizedlist>
@@ -1117,7 +1145,7 @@ end
are returned.
</para>
</listitem>
- </itemizedlist>
+ </itemizedlist>
<para>
<emphasis>
Default value is NULL (disabled).
@@ -1451,7 +1479,7 @@ lookup_branches("location");
<listitem>
<para>
<emphasis>match_option</emphasis> (optional) - flag parameter to restrict
- contact search. use reg_xavp_cfg to set the values to compare to.
+ contact search. use xavp_cfg to set the values to compare to.
</para>
<para>flag values is as follows:</para>
<itemizedlist>