sl: docs - set section ids in expected format
[sip-router] / src / modules / sl / doc / sl_params.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3    "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
4
5 <section id="sl.parameters" xmlns:xi="http://www.w3.org/2001/XInclude">
6
7     <title>Parameters</title>
8
9         <section id="sl.p.default_code">
10                 <title><varname>default_code</varname> (int)</title>
11                 <para>
12                 Default reply status code.
13                 </para>
14                 <para>
15                 Default value is 500.
16                 </para>
17                 <example>
18                 <title>default_code example</title>
19                 <programlisting format="linespecific">
20 ...
21 modparam("sl", "default_code", 505)
22 ...
23 </programlisting>
24                 </example>
25         </section>
26
27         <section id="sl.p.default_reason">
28                 <title><varname>default_reason</varname> (str)</title>
29                 <para>
30                 Default reply reason phrase.
31                 </para>
32                 <para>
33                 Default value is 'Internal Server Error'.
34                 </para>
35                 <example>
36                 <title>default_reason example</title>
37                 <programlisting format="linespecific">
38 ...
39 modparam("sl", "default_reason", "Server Error")
40 ...
41 </programlisting>
42                 </example>
43         </section>
44
45         <section id="sl.p.bind_tm">
46                 <title><varname>bind_tm</varname> (int)</title>
47                 <para>
48                 Controls if SL module should attempt to bind to TM module in order
49                 to send stateful reply when the transaction is created.
50                 </para>
51                 <para>
52                 Default value is 1 (enabled).
53                 </para>
54                 <example>
55                 <title>bind_tm example</title>
56                 <programlisting format="linespecific">
57 ...
58 modparam("sl", "bind_tm", 0)  # feature disabled
59 ...
60 </programlisting>
61                 </example>
62         </section>
63
64         <section id="sl.p.rich_redirect">
65                 <title><varname>rich_redirect</varname> (int)</title>
66                 <para>
67                 When sending a 3xx class reply, include additional branch info
68                 to the contacts such as path vector and branch flags.
69                 </para>
70                 <itemizedlist>
71                         <listitem><para>
72                         <emphasis>0</emphasis> - no extra info is added (default)
73                         </para></listitem>
74                         <listitem><para>
75                         <emphasis>1</emphasis> - include branch flags as contact header parameter
76                         </para></listitem>
77                         <listitem><para>
78                         <emphasis>2</emphasis> - include path as contact uri Route header
79                         </para></listitem>
80                 </itemizedlist>
81                 <para>
82                 Values may be combined (added).
83                 </para>
84                 <example>
85                         <title>rich_redirect example</title>
86                         <programlisting format="linespecific">
87 ...
88 modparam("sl", "rich_redirect", 3)
89 ...
90                         </programlisting>
91                 </example>
92         </section>
93
94         <section id="sl.p.event_callback_fl_ack">
95                 <title><varname>event_callback_fl_ack</varname> (str)</title>
96                 <para>
97                 The name of the KEMI callback function to be executed instead of
98                 event_route[sl:filtered-ack]. This function receives a string parameter.
99                 </para>
100                 <para>
101                 Default value: not set.
102                 </para>
103                 <example>
104                 <title>event_callback_fl_ack example</title>
105                 <programlisting format="linespecific">
106 ...
107 modparam("sl", "event_callback_fl_ack", "ksr_event_sl_filtered_ack")
108 ...
109 </programlisting>
110                 </example>
111         </section>
112
113         <section id="sl.p.event_callback_lres_sent">
114                 <title><varname>event_callback_lres_sent</varname> (str)</title>
115                 <para>
116                 The name of the KEMI callback function to be executed instead of
117                 event_route[sl:local-response]. This function receives a string parameter.
118                 </para>
119                 <para>
120                 Default value: not set.
121                 </para>
122                 <example>
123                 <title>event_callback_lres_sent example</title>
124                 <programlisting format="linespecific">
125 ...
126 modparam("sl", "event_callback_lres_sent", "ksr_event_sl_local_response")
127 ...
128 </programlisting>
129                 </example>
130         </section>
131
132 </section>