Browse code

sl: extended docs for sl_send_reply()

(cherry picked from commit 29aa683f7c3d507a88b83ecd84d9023c5e162ab1)

Daniel-Constantin Mierla authored on 08/06/2015 05:34:22
Showing 2 changed files
... ...
@@ -191,6 +191,17 @@ modparam("sl", "bind_tm", 0)  # feature disabled
191 191
    text reason. The reply is sent stateless, totally independent of the
192 192
    Transaction module and with no retransmission for the INVITE's replies.
193 193
 
194
+   If the code is in the range 300-399 (redirect reply), the current
195
+   destination set is appended to the reply as Contact headers. The
196
+   destination set contains the request URI (R-URI), if it is modified
197
+   compared to the received one, plus the branches added to the request
198
+   (e.g., after an append_branch() or lookup("location")). If the R-URI
199
+   was changed but it is not desired to be part of the destination set, it
200
+   can be reverted using the function revert_uri().
201
+
202
+   Custom headers to the reply can be added using append_to_reply()
203
+   function from textops module.
204
+
194 205
    Meaning of the parameters is as follows:
195 206
      * code - Return code.
196 207
      * reason - Reason phrase.
... ...
@@ -16,6 +16,19 @@
16 16
 	    of the Transaction module and with no retransmission for the
17 17
 	    INVITE's replies.
18 18
 	</para>
19
+	<para>
20
+		If the code is in the range 300-399 (redirect reply), the current
21
+		destination set is appended to the reply as Contact headers.
22
+		The destination set contains the request URI (R-URI), if it is
23
+		modified compared to the received one, plus the branches added to the
24
+		request (e.g., after an append_branch() or lookup("location")).
25
+		If the R-URI was changed but it is not desired to be part of the
26
+		destination set, it can be reverted using the function revert_uri().
27
+	</para>
28
+	<para>
29
+		Custom headers to the reply can be added using append_to_reply()
30
+		function from textops module.
31
+	</para>
19 32
 	<para>Meaning of the parameters is as follows:</para>
20 33
 	<itemizedlist>
21 34
 	    <listitem>