Browse code

topos: added missing params to docs

Daniel-Constantin Mierla authored on 18/03/2016 17:05:02
Showing 2 changed files
... ...
@@ -28,12 +28,18 @@ Daniel-Constantin Mierla
28 28
               3.1. db_url (str)
29 29
               3.2. mask_callid (int)
30 30
               3.3. sanity_checks (int)
31
+              3.4. branch_expires (int)
32
+              3.5. branch_dialog (int)
33
+              3.6. clean_inteval (int)
31 34
 
32 35
    List of Examples
33 36
 
34 37
    1.1. Set db_url parameter
35 38
    1.2. Set mask_callid parameter
36 39
    1.3. Set sanity_checks parameter
40
+   1.4. Set branch_expires parameter
41
+   1.5. Set branch_dialog parameter
42
+   1.6. Set clean_interval parameter
37 43
 
38 44
 Chapter 1. Admin Guide
39 45
 
... ...
@@ -50,6 +56,9 @@ Chapter 1. Admin Guide
50 56
         3.1. db_url (str)
51 57
         3.2. mask_callid (int)
52 58
         3.3. sanity_checks (int)
59
+        3.4. branch_expires (int)
60
+        3.5. branch_dialog (int)
61
+        3.6. clean_inteval (int)
53 62
 
54 63
 1. Overview
55 64
 
... ...
@@ -60,6 +69,8 @@ Chapter 1. Admin Guide
60 69
    The module is transparent for the configuration writer. It only needs
61 70
    to be loaded (tune the parameters if needed).
62 71
 
72
+   It works for SIP MESSAGE requests.
73
+
63 74
 2. Dependencies
64 75
 
65 76
    2.1. Kamailio Modules
... ...
@@ -84,6 +95,9 @@ Chapter 1. Admin Guide
84 95
    3.1. db_url (str)
85 96
    3.2. mask_callid (int)
86 97
    3.3. sanity_checks (int)
98
+   3.4. branch_expires (int)
99
+   3.5. branch_dialog (int)
100
+   3.6. clean_inteval (int)
87 101
 
88 102
 3.1. db_url (str)
89 103
 
... ...
@@ -121,3 +135,36 @@ modparam("topos", "mask_callid", 1)
121 135
 ...
122 136
 modparam("topoh", "sanity_checks", 1)
123 137
 ...
138
+
139
+3.4. branch_expires (int)
140
+
141
+   Interval in seconds after which the branch records are deleted.
142
+
143
+   Default value is 180 (3 min).
144
+
145
+   Example 1.4. Set branch_expires parameter
146
+...
147
+modparam("topos", "branch_expires", 300)
148
+...
149
+
150
+3.5. branch_dialog (int)
151
+
152
+   Interval in seconds after which the dialog records are deleted.
153
+
154
+   Default value is 10800 (3 hours).
155
+
156
+   Example 1.5. Set branch_dialog parameter
157
+...
158
+modparam("topos", "branch_dialog", 3600)
159
+...
160
+
161
+3.6. clean_inteval (int)
162
+
163
+   Interval in seconds to run the clean up of stored records.
164
+
165
+   Default value is 60 (1 min).
166
+
167
+   Example 1.6. Set clean_interval parameter
168
+...
169
+modparam("topos", "clean_interval", 30)
170
+...
... ...
@@ -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>
17 17
 	<title>Overview</title>
18 18
 	<para>
... ...
@@ -25,6 +25,9 @@
25 25
 		The module is transparent for the configuration writer. It only needs to be
26 26
 		loaded (tune the parameters if needed).
27 27
 	</para>
28
+	<para>
29
+		It works for SIP MESSAGE requests.
30
+	</para>
28 31
 	</section>
29 32
 	<section>
30 33
 	<title>Dependencies</title>
... ...
@@ -123,6 +126,64 @@ modparam("topos", "mask_callid", 1)
123 126
 ...
124 127
 modparam("topoh", "sanity_checks", 1)
125 128
 ...
129
+</programlisting>
130
+		</example>
131
+	</section>
132
+	<section id="topos.p.branch_expires">
133
+		<title><varname>branch_expires</varname> (int)</title>
134
+		<para>
135
+			Interval in seconds after which the branch records are deleted.
136
+		</para>
137
+		<para>
138
+		<emphasis>
139
+			Default value is 180 (3 min).
140
+		</emphasis>
141
+		</para>
142
+		<example>
143
+		<title>Set <varname>branch_expires</varname> parameter</title>
144
+		<programlisting format="linespecific">
145
+...
146
+modparam("topos", "branch_expires", 300)
147
+...
148
+</programlisting>
149
+		</example>
150
+	</section>
151
+	<section id="topos.p.branch_dialog">
152
+		<title><varname>branch_dialog</varname> (int)</title>
153
+		<para>
154
+			Interval in seconds after which the dialog records are deleted.
155
+		</para>
156
+		<para>
157
+		<emphasis>
158
+			Default value is 10800 (3 hours).
159
+		</emphasis>
160
+		</para>
161
+		<example>
162
+		<title>Set <varname>branch_dialog</varname> parameter</title>
163
+		<programlisting format="linespecific">
164
+...
165
+modparam("topos", "branch_dialog", 3600)
166
+...
167
+</programlisting>
168
+		</example>
169
+	</section>
170
+	<section id="topos.p.clean_interval">
171
+		<title><varname>clean_inteval</varname> (int)</title>
172
+		<para>
173
+			Interval in seconds to run the clean up of stored
174
+			records.
175
+		</para>
176
+		<para>
177
+		<emphasis>
178
+			Default value is 60 (1 min).
179
+		</emphasis>
180
+		</para>
181
+		<example>
182
+		<title>Set <varname>clean_interval</varname> parameter</title>
183
+		<programlisting format="linespecific">
184
+...
185
+modparam("topos", "clean_interval", 30)
186
+...
126 187
 </programlisting>
127 188
 		</example>
128 189
 	</section>