Просмотр исходного кода

sl: extended docs for sl_send_reply()

(cherry picked from commit 29aa683f7c3d507a88b83ecd84d9023c5e162ab1)
Daniel-Constantin Mierla 10 лет назад
Родитель
Сommit
1a08fa07b6
2 измененных файлов с 24 добавлено и 0 удалено
  1. 11 0
      modules/sl/README
  2. 13 0
      modules/sl/doc/sl_functions.xml

+ 11 - 0
modules/sl/README

@@ -191,6 +191,17 @@ modparam("sl", "bind_tm", 0)  # feature disabled
    text reason. The reply is sent stateless, totally independent of the
    text reason. The reply is sent stateless, totally independent of the
    Transaction module and with no retransmission for the INVITE's replies.
    Transaction module and with no retransmission for the INVITE's replies.
 
 
+   If the code is in the range 300-399 (redirect reply), the current
+   destination set is appended to the reply as Contact headers. The
+   destination set contains the request URI (R-URI), if it is modified
+   compared to the received one, plus the branches added to the request
+   (e.g., after an append_branch() or lookup("location")). If the R-URI
+   was changed but it is not desired to be part of the destination set, it
+   can be reverted using the function revert_uri().
+
+   Custom headers to the reply can be added using append_to_reply()
+   function from textops module.
+
    Meaning of the parameters is as follows:
    Meaning of the parameters is as follows:
      * code - Return code.
      * code - Return code.
      * reason - Reason phrase.
      * reason - Reason phrase.

+ 13 - 0
modules/sl/doc/sl_functions.xml

@@ -16,6 +16,19 @@
 	    of the Transaction module and with no retransmission for the
 	    of the Transaction module and with no retransmission for the
 	    INVITE's replies.
 	    INVITE's replies.
 	</para>
 	</para>
+	<para>
+		If the code is in the range 300-399 (redirect reply), the current
+		destination set is appended to the reply as Contact headers.
+		The destination set contains the request URI (R-URI), if it is
+		modified compared to the received one, plus the branches added to the
+		request (e.g., after an append_branch() or lookup("location")).
+		If the R-URI was changed but it is not desired to be part of the
+		destination set, it can be reverted using the function revert_uri().
+	</para>
+	<para>
+		Custom headers to the reply can be added using append_to_reply()
+		function from textops module.
+	</para>
 	<para>Meaning of the parameters is as follows:</para>
 	<para>Meaning of the parameters is as follows:</para>
 	<itemizedlist>
 	<itemizedlist>
 	    <listitem>
 	    <listitem>