[sr-dev] git:master:f0bf4ceb: registrar: docs for reg_from_user() function

[Daniel-Constantin Mierla]

Module: kamailio
Branch: master
Commit: f0bf4cebef916887cd5196dce0521d4784904ab8
URL: https://github.com/kamailio/kamailio/commit/f0bf4cebef916887cd5196dce0521d4784904ab8

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2022-05-20T13:26:00+02:00

registrar: docs for reg_from_user() function

---

Modified: src/modules/registrar/doc/registrar_admin.xml

---

Diff:  https://github.com/kamailio/kamailio/commit/f0bf4cebef916887cd5196dce0521d4784904ab8.diff
Patch: https://github.com/kamailio/kamailio/commit/f0bf4cebef916887cd5196dce0521d4784904ab8.patch

---

diff --git a/src/modules/registrar/doc/registrar_admin.xml b/src/modules/registrar/doc/registrar_admin.xml
index d8a3c88b57..c402ab4b20 100644
--- a/src/modules/registrar/doc/registrar_admin.xml
+++ b/src/modules/registrar/doc/registrar_admin.xml
@@ -1813,6 +1813,52 @@ save("location", "0x2");
 ...
 reg_send_reply();
 ...
+</programlisting>
+		</example>
+	</section>
+	<section id="registrar.f.reg_from_user">
+		<title>
+		<function moreinfo="none">reg_from_user(ultable, uri, mode)</function>
+		</title>
+		<para>
+			The function returns true if the SIP message comes from the user
+			identified by 'uri' parameter by matching the associated location
+			records. The matching is done with the field 'received' if it is set,
+			otherwise with the contact address.
+		</para>
+		<para>Meaning of the parameters is as follows:</para>
+		<itemizedlist>
+		<listitem>
+			<para>
+			<emphasis>ultable</emphasis> - user location table (e.g., 'location')
+			</para>
+		</listitem>
+		<listitem>
+			<para>
+			<emphasis>uri</emphasis> - SIP URI to identify the location records
+			to match against.
+			</para>
+		</listitem>
+		<listitem>
+			<para>
+			<emphasis>mode</emphasis> - matching mode (int) - host part (IP address)
+			is matched always. If mode has bit 1 set (value 1), then the port is
+			matched as well. If mode has bit 2 set (value 2), then the protocol
+			is matched as well.
+			</para>
+		</listitem>
+		</itemizedlist>
+		<para>
+		This function can be used from ANY_ROUTE.
+		</para>
+		<example>
+		<title><function>reg_from_user</function> usage</title>
+		<programlisting format="linespecific">
+...
+if(reg_from_user("location", "sip:alice at server.com", "0")) {
+    # message coming from where 'alice' sent before a REGISTER request
+}
+...
 </programlisting>
 		</example>
 	</section>