Browse code

registrar: docs for reg_send_reply()

Daniel-Constantin Mierla authored on 10/07/2019 07:05:17
Showing 1 changed files
... ...
@@ -10,9 +10,9 @@
10 10
 <!-- Module User's Guide -->
11 11
 
12 12
 <chapter>
13
-	
13
+
14 14
 	<title>&adminguide;</title>
15
-	
15
+
16 16
 	<section id="rergistrar.overview">
17 17
 	<title>Overview</title>
18 18
 	<para>The module contains REGISTER processing logic. The actual location
... ...
@@ -1513,6 +1513,30 @@ reg_free_contacts("callee");
1513 1513
 </programlisting>
1514 1514
 		</example>
1515 1515
 	</section>
1516
+	<section id="registrar.f.reg_send_reply">
1517
+		<title>
1518
+		<function moreinfo="none">reg_send_reply()</function>
1519
+		</title>
1520
+		<para>
1521
+			The function sends the SIP reply that is normally sent by
1522
+			save(...), but that was skipped due to flag 0x2. It must be used
1523
+			after save(..., "0x2"). Practically it allows saving registration
1524
+			to location table, do other operations and then send the reply.
1525
+		</para>
1526
+		<para>
1527
+		This function can be used from REQUEST_ROUTE, FAILURE_ROUTE.
1528
+		</para>
1529
+		<example>
1530
+		<title><function>reg_send_reply</function> usage</title>
1531
+		<programlisting format="linespecific">
1532
+...
1533
+save("location", "0x2");
1534
+...
1535
+reg_send_reply();
1536
+...
1537
+</programlisting>
1538
+		</example>
1539
+	</section>
1516 1540
 
1517 1541
 	</section>
1518 1542