[sr-dev] git:master:5b8311cd: registrar: docs for reg_send_reply()

[Daniel-Constantin Mierla]

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

Author: Daniel-Constantin Mierla <miconda at gmail.com>
Committer: Daniel-Constantin Mierla <miconda at gmail.com>
Date: 2019-07-10T09:05:17+02:00

registrar: docs for reg_send_reply()

---

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

---

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

---

diff --git a/src/modules/registrar/doc/registrar_admin.xml b/src/modules/registrar/doc/registrar_admin.xml
index 4ce4a6b995..32752eac89 100644
--- a/src/modules/registrar/doc/registrar_admin.xml
+++ b/src/modules/registrar/doc/registrar_admin.xml
@@ -10,9 +10,9 @@
 <!-- Module User's Guide -->
 
 <chapter>
-	
+
 	<title>&adminguide;</title>
-	
+
 	<section id="rergistrar.overview">
 	<title>Overview</title>
 	<para>The module contains REGISTER processing logic. The actual location
@@ -1510,6 +1510,30 @@ reg_fetch_contacts("location", "sip:user at kamailio.org", "caller");
 ...
 reg_free_contacts("callee");
 ...
+</programlisting>
+		</example>
+	</section>
+	<section id="registrar.f.reg_send_reply">
+		<title>
+		<function moreinfo="none">reg_send_reply()</function>
+		</title>
+		<para>
+			The function sends the SIP reply that is normally sent by
+			save(...), but that was skipped due to flag 0x2. It must be used
+			after save(..., "0x2"). Practically it allows saving registration
+			to location table, do other operations and then send the reply.
+		</para>
+		<para>
+		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
+		</para>
+		<example>
+		<title><function>reg_send_reply</function> usage</title>
+		<programlisting format="linespecific">
+...
+save("location", "0x2");
+...
+reg_send_reply();
+...
 </programlisting>
 		</example>
 	</section>