Skip to content

Commit

Permalink
sl: extended docs for sl_send_reply()
Browse files Browse the repository at this point in the history
(cherry picked from commit 29aa683)
  • Loading branch information
miconda committed Jun 9, 2015
1 parent 1eb9aac commit 1a08fa0
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 0 deletions.
11 changes: 11 additions & 0 deletions modules/sl/README
Expand Up @@ -191,6 +191,17 @@ modparam("sl", "bind_tm", 0) # feature disabled
text reason. The reply is sent stateless, totally independent of the
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:
* code - Return code.
* reason - Reason phrase.
Expand Down
13 changes: 13 additions & 0 deletions modules/sl/doc/sl_functions.xml
Expand Up @@ -16,6 +16,19 @@
of the Transaction module and with no retransmission for the
INVITE's replies.
</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>
<itemizedlist>
<listitem>
Expand Down

0 comments on commit 1a08fa0

Please sign in to comment.