Browse code

docs updated

git-svn-id: https://openser.svn.sourceforge.net/svnroot/openser/trunk@60 689a6050-402a-0410-94f2-e92a70836424

Bogdan-Andrei Iancu authored on 24/06/2005 09:34:59
Showing 6 changed files
... ...
@@ -318,7 +318,7 @@ avp_db_delete("$uuid","s:404fwd/fwd_table");
318 318
      * value - the value to be written into the AVP. Parameter
319 319
        syntax:
320 320
           + value = (variable) | (fix_value) 
321
-          + variable = '$src_ip' | '$hdr[name]' |
321
+          + variable = '$src_ip' | '$dst_ip' | '$hdr[name]' |
322 322
             (sip_uri)['/'('username'|'domain')]) 
323 323
           + sip_uri = '$from' | '$to' | '$ruri' 
324 324
           + fix_value = 'i:'integer | 's:'string | string 
... ...
@@ -396,7 +396,7 @@ avp_pushto("Foo","$bar/g");
396 396
           + operator = 'eq' | 'lt' | 'gt' | 're' | 'fm' 
397 397
           + value = variable | fix_value 
398 398
           + variable =
399
-            '$from'|'$ruri'|'$from'|'$src_ip'|avp_alias 
399
+            '$from'|'$ruri'|'$from'|'$src_ip'|'$dst_ip'|avp_alias
400 400
           + fix_value = 'i:'integer | 's:'string | string 
401 401
           + flags = 'g' | 'G' | 'i' | 'I' 
402 402
 
... ...
@@ -389,7 +389,7 @@ avp_db_delete("$uuid","s:404fwd/fwd_table");
389 389
 					value = (variable) | (fix_value)
390 390
 					</emphasis></para></listitem>
391 391
 					<listitem><para><emphasis>
392
-					variable = '$src_ip' | '$hdr[name]' | (sip_uri)['/'('username'|'domain')])
392
+					variable = '$src_ip' | '$dst_ip' | '$hdr[name]' | (sip_uri)['/'('username'|'domain')])
393 393
 					</emphasis></para></listitem>
394 394
 					<listitem><para><emphasis>
395 395
 					sip_uri = '$from' | '$to' | '$ruri'
... ...
@@ -553,7 +553,7 @@ avp_pushto("Foo","$bar/g");
553 553
 					value = variable | fix_value
554 554
 					</emphasis></para></listitem>
555 555
 					<listitem><para><emphasis>
556
-					variable = '$from'|'$ruri'|'$from'|'$src_ip'|avp_alias
556
+					variable = '$from'|'$ruri'|'$from'|'$src_ip'|'$dst_ip'|avp_alias
557 557
 					<listitem><para><emphasis>
558 558
 					fix_value = 'i:'integer | 's:'string | string
559 559
 					</emphasis></para></listitem>
... ...
@@ -57,7 +57,9 @@ Chapter 1. User's Guide
57 57
 
58 58
    Known limitations in this version:
59 59
 
60
-     * authentication does not support qop
60
+     * authentication does not support qop;
61
+     * CSeq not increased during authentication - the response
62
+       may be rejected.
61 63
      _________________________________________________________
62 64
 
63 65
 1.2. Dependencies
... ...
@@ -25,7 +25,13 @@
25 25
 		<itemizedlist>
26 26
 			<listitem>
27 27
 			<para>
28
-				authentication does not support qop
28
+				authentication does not support qop;
29
+			</para>
30
+			</listitem>
31
+			<listitem>
32
+			<para>
33
+				CSeq not increased during authentication - the response 
34
+				may be rejected.
29 35
 			</para>
30 36
 			</listitem>
31 37
 		</itemizedlist>
... ...
@@ -90,8 +90,8 @@ Chapter 1. User's Guide
90 90
 
91 91
    The logging will be done via the accounting module functions
92 92
    (all are supported). The information to be logged will be the
93
-   same as the normal logged information direcly via ACC module,
94
-   but with differencies:
93
+   same as the normal logged information directly via ACC module,
94
+   but with following differences:
95 95
 
96 96
      * reason phrase - which will be dynamically set by the
97 97
        redirection function;
... ...
@@ -131,8 +131,8 @@ Chapter 1. User's Guide
131 131
 
132 132
 1.4.1. default_filter (string)
133 133
 
134
-   The default behaviour in filtering contacts. It may be
135
-   "accept" or "deny".
134
+   The default behavior in filtering contacts. It may be "accept"
135
+   or "deny".
136 136
 
137 137
    The default value is "accept". 
138 138
 
... ...
@@ -151,7 +151,7 @@ modparam("uac_redirect","default_filter","deny")
151 151
 
152 152
    The parameter may be defined only one - multiple definition
153 153
    will overwrite the previous definitions. If more regular
154
-   expresion need to be defined, use the set_deny_filter()
154
+   expression need to be defined, use the set_deny_filter()
155 155
    scripting function.
156 156
 
157 157
    This parameter is optional, it's default value being NULL. 
... ...
@@ -171,7 +171,7 @@ modparam("uac_redirect","deny_filter",".*@siphub\.net")
171 171
 
172 172
    The parameter may be defined only one - multiple definition
173 173
    will overwrite the previous definitions. If more regular
174
-   expresion need to be defined, use the set_accept_filter()
174
+   expression need to be defined, use the set_accept_filter()
175 175
    scripting function.
176 176
 
177 177
    This parameter is optional, it's default value being NULL. 
... ...
@@ -185,8 +185,8 @@ modparam("uac_redirect","accept_filter",".*@siphub\.net")
185 185
 1.4.4. acc_function (string)
186 186
 
187 187
    Specifies the accounting function to be used. Just be defining
188
-   this parameter, the accountign support will not be enabled.
189
-   Accountinf may only be enabled via two parameters
188
+   this parameter, the accounting support will not be enabled.
189
+   Accounting may only be enabled via two parameters
190 190
    set_accept_filter() scripting function.
191 191
 
192 192
    Its values my be:
... ...
@@ -207,9 +207,9 @@ modparam("uac_redirect","acc_function","acc_db_request")
207 207
 1.4.5. acc_db_table (string)
208 208
 
209 209
    Specifies the accounting table to be used if DB accounting was
210
-   choosen (acc_function was set to "acc_db_request"). Just be
211
-   defining this parameter, the accountign support will not be
212
-   enabled. Accountinf may only be enabled via two parameters
210
+   chosen (acc_function was set to "acc_db_request"). Just be
211
+   defining this parameter, the accounting support will not be
212
+   enabled. Accounting may only be enabled via two parameters
213 213
    set_accept_filter() scripting function.
214 214
 
215 215
    The default value is "acc". 
... ...
@@ -224,11 +224,11 @@ modparam("uac_redirect","acc_db_table","acc_redirect")
224 224
 
225 225
 1.5.1. set_deny_filter(filter,flags)
226 226
 
227
-   Sets additionals deny filters. Maximum 6 may be combined. This
227
+   Sets additional deny filters. Maximum 6 may be combined. This
228 228
    additional filter will apply only to the current message - it
229 229
    will not have a global effect.
230 230
 
231
-   Default or prevoius added deny filter may be reset depending
231
+   Default or previous added deny filter may be reset depending
232 232
    of the flag parameter value:
233 233
 
234 234
      * reset_all - reset both default and previous added deny
... ...
@@ -246,11 +246,11 @@ set_deny_filter(".*@domain1.net","");
246 246
 
247 247
 1.5.2. set_accept_filter(filter,flags)
248 248
 
249
-   Sets additionals accept filters. Maximum 6 may be combined.
249
+   Sets additional accept filters. Maximum 6 may be combined.
250 250
    This additional filter will apply only to the current message
251 251
    - it will not have a global effect.
252 252
 
253
-   Default or prevoius added deny filter may be reset depending
253
+   Default or previous added deny filter may be reset depending
254 254
    of the flag parameter value:
255 255
 
256 256
      * reset_all - reset both default and previous added accept
... ...
@@ -271,8 +271,8 @@ set_accept_filter(".*@domain1.net","");
271 271
 
272 272
    The function may be called only from failure routes. It will
273 273
    extract the contacts from all 3xx branches and append them as
274
-   new branches. Note that the function will not forward the nw
275
-   brnaches, this must be done explicitly from script.
274
+   new branches. Note that the function will not forward the new
275
+   branches, this must be done explicitly from script.
276 276
 
277 277
    How many contacts (in total and per branch) are selected
278 278
    depends of the max parameter values. Its syntax is:
... ...
@@ -309,7 +309,7 @@ get_redirects("*");
309 309
 
310 310
    The accounting records will be mark by the reason phrase.
311 311
 
312
-   If this funtion appers in the script, at startup, the module
312
+   If this function appears in the script, at startup, the module
313 313
    will import the accounting function. Otherwise not.
314 314
 
315 315
    Example 1-9. get_redirects usage
... ...
@@ -57,8 +57,8 @@
57 57
 		<para>
58 58
 		The logging will be done via the accounting module functions (all are
59 59
 		supported). The information to be logged will be the same as the 
60
-		normal logged information direcly via ACC module, but with 
61
-		differencies:
60
+		normal logged information directly via ACC module, but with 
61
+		following differences:
62 62
 		</para>
63 63
 		<itemizedlist>
64 64
 			<listitem>
... ...
@@ -130,7 +130,7 @@
130 130
 		<section>
131 131
 			<title><varname>default_filter</varname> (string)</title>
132 132
 			<para>
133
-			The default behaviour in filtering contacts. It may be 
133
+			The default behavior in filtering contacts. It may be 
134 134
 			<quote>accept</quote> or <quote>deny</quote>.
135 135
 			</para>
136 136
 			<para>
... ...
@@ -159,7 +159,7 @@ modparam("uac_redirect","default_filter","deny")
159 159
 			</para>
160 160
 			<para>
161 161
 			The parameter may be defined only one - multiple definition will
162
-			overwrite the previous definitions. If more regular expresion 
162
+			overwrite the previous definitions. If more regular expression 
163 163
 			need to be defined, use the 
164 164
 			<function moreinfo="none">set_deny_filter()</function> scripting
165 165
 			function.
... ...
@@ -191,7 +191,7 @@ modparam("uac_redirect","deny_filter",".*@siphub\.net")
191 191
 			</para>
192 192
 			<para>
193 193
 			The parameter may be defined only one - multiple definition will
194
-			overwrite the previous definitions. If more regular expresion 
194
+			overwrite the previous definitions. If more regular expression 
195 195
 			need to be defined, use the 
196 196
 			<function moreinfo="none">set_accept_filter()</function> scripting
197 197
 			function.
... ...
@@ -216,8 +216,8 @@ modparam("uac_redirect","accept_filter",".*@siphub\.net")
216 216
 			<title><varname>acc_function</varname> (string)</title>
217 217
 			<para>
218 218
 			Specifies the accounting function to be used. Just be defining 
219
-			this parameter, the accountign support will not be enabled. 
220
-			Accountinf may only be enabled via two parameters 
219
+			this parameter, the accounting support will not be enabled. 
220
+			Accounting may only be enabled via two parameters 
221 221
 			<function moreinfo="none">set_accept_filter()</function> 
222 222
 			scripting function.
223 223
 			</para>
... ...
@@ -256,10 +256,10 @@ modparam("uac_redirect","acc_function","acc_db_request")
256 256
 			<title><varname>acc_db_table</varname> (string)</title>
257 257
 			<para>
258 258
 			Specifies the accounting table to be used if DB accounting was 
259
-			choosen (<varname>acc_function</varname> was set to 
259
+			chosen (<varname>acc_function</varname> was set to 
260 260
 			<quote>acc_db_request</quote>). Just be defining 
261
-			this parameter, the accountign support will not be enabled. 
262
-			Accountinf may only be enabled via two parameters 
261
+			this parameter, the accounting support will not be enabled. 
262
+			Accounting may only be enabled via two parameters 
263 263
 			<function moreinfo="none">set_accept_filter()</function> 
264 264
 			scripting function.
265 265
 			</para>
... ...
@@ -288,12 +288,12 @@ modparam("uac_redirect","acc_db_table","acc_redirect")
288 288
 					</function>
289 289
 			</title>
290 290
 			<para>
291
-			Sets additionals deny filters. Maximum 6 may be combined. This
291
+			Sets additional deny filters. Maximum 6 may be combined. This
292 292
 			additional filter will apply only to the current message - it
293 293
 			will not have a global effect.
294 294
 			</para>
295 295
 			<para>
296
-			Default or prevoius added deny filter may be reset depending of
296
+			Default or previous added deny filter may be reset depending of
297 297
 			the <emphasis>flag</emphasis> parameter value:
298 298
 			</para>
299 299
 			<itemizedlist>
... ...
@@ -335,12 +335,12 @@ set_deny_filter(".*@domain1.net","");
335 335
 					</function>
336 336
 			</title>
337 337
 			<para>
338
-			Sets additionals accept filters. Maximum 6 may be combined. This
338
+			Sets additional accept filters. Maximum 6 may be combined. This
339 339
 			additional filter will apply only to the current message - it
340 340
 			will not have a global effect.
341 341
 			</para>
342 342
 			<para>
343
-			Default or prevoius added deny filter may be reset depending of
343
+			Default or previous added deny filter may be reset depending of
344 344
 			the <emphasis>flag</emphasis> parameter value:
345 345
 			</para>
346 346
 			<itemizedlist>
... ...
@@ -384,7 +384,7 @@ set_accept_filter(".*@domain1.net","");
384 384
 				The function may be called only from failure routes. It will
385 385
 				extract the contacts from all 3xx branches and append them
386 386
 				as new branches. Note that the function will not forward the
387
-				nw brnaches, this must be done explicitly from script.
387
+				new branches, this must be done explicitly from script.
388 388
 			</para>
389 389
 			<para>
390 390
 				How many contacts (in total and per branch) are selected 
... ...
@@ -446,7 +446,7 @@ get_redirects("*");
446 446
 				<emphasis>reason</emphasis> phrase.
447 447
 			</para>
448 448
 			<para>
449
-				If this funtion appers in the script, at startup, the module
449
+				If this function appears in the script, at startup, the module
450 450
 				will import the accounting function. Otherwise not.
451 451
 			</para>
452 452
 			<example>